TPL Output Format Parameters

The TPL output format supports the following parameters:

tpl
  Values: file path
  Default: not specified
  Description: Template file.
  Details: When using raw format template files, this parameter specifies the template file containing the body section.
When using structured format template files, this parameter specifies the single template file that contains the header, body, and footer sections.
For more information on template files, see Template Files.
  Example: -tpl:MyTemplate.tpl
 
tplHeader
  Values: file path
  Default: not specified
  Description: Template header file.
  Details: When using raw format template files, this parameter specifies the template file containing the header section.
When using structured format template files, this parameter specifies a raw format template file that overrides the <LPHEADER> section of the structured format template file specified with the "tpl" parameter.
For more information on template files, see Template Files.
  Example: -tplHeader:MyTemplateHeader.tpl
 
tplFooter
  Values: file path
  Default: not specified
  Description: Template footer file.
  Details: When using raw format template files, this parameter specifies the template file containing the footer section.
When using structured format template files, this parameter specifies a raw format template file that overrides the <LPFOOTER> section of the structured format template file specified with the "tpl" parameter.
For more information on template files, see Template Files.
  Example: -tplFooter:MyTemplateFooter.tpl
 
noEmptyFile
  Values: ON | OFF
  Default: ON
  Description: Do not generate empty files.
  Details: When a query does not produce output records, the TPL output format does not write a body section, and the resulting output file could be empty.
Setting this parameter to "ON" causes the TPL output format to avoid generating an empty file in these situations.
  Example: -noEmptyFile:OFF
 
oCodepage
  Values: codepage ID (number)
  Default: 0
  Description: Codepage of the output text.
  Details: 0 is the system codepage, -1 is UNICODE.
  Example: -oCodepage:1245
 
fileMode
  Values: 0 | 1 | 2
  Default: 1
  Description: Action to perform when an output file already exists.
  Details: This parameter controls the behavior of the TPL output format when the into-entity specifies directly or indirectly through the "multiplex" feature the name of a file that already exists.
The possible values for this parameter are:
  • 0: existing files are appended with the output;
  • 1: existing files are overwritten with the output;
  • 2: existing files are left intact, discarding the output.
  Example: -fileMode:0
 

© 2004 Microsoft Corporation. All rights reserved.