PDFImprint Command Line

The windows command line invocation of PDFImprint includes the following elements.   See the Sample Projects for examples.

Syntax

To start in User Interface mode

PDFImprint  
PDFImprint  /ui

To display command line help

PDFImprint  /h

To start execution

PDFImprint  /s"ScriptFileName" [/d"DataSource"] [/v"VarName=VarValue"]  [/p] [/q] [/e"ErrorFileName"]

Parameters

/ui

Start PDFImprint in User Interface mode.  The same as invoking PDFImprint without any parameters.

/h

Print command line help.

/s"ScriptFileName"

Specifies the location and name of script file.  This parameter can include a drive letter and colon, a directory name, a file name, or a combination of these.  See Script File Reference.
 

/d"DataSource"

Data source specification. See Data source variables.
 

Data Source Parameters:
FileName

Specifies the location and name of data source file. Extension of the file should correspond to format.   

VarName

Name of the variable identifying data source table column.

TableName

Name of the database table to use.  
If missing for MDB format, the first database table is used.

ServerName

SQL Database server name   

DataBaseName

SQL Database name    

Start

The first number of an incremental numeric sequence

Count

Number of incremental numeric sequence rows 

Increment

Increment value of incremental numeric sequence. Default is 1   

/v"VarName=VarValue"

Zero or more  variable definitions. See User defined variables.

/p

Prompts to Press any key after execution is completed.

/q

Suppresses the display of PDFImprint messages

/e"ErrorFileName"

Specifies the location and name of file to append error information to.  

Remarks

• A command line parameter can be preceded by the "/" or the "-" character

• If the ScriptFileName, DataSource, VarName=VarValue, or ErrorFileName parameters contain a space, they should be enclosed with by quotes.

• CSV and Tab-separated files must have a header row.  The values of each column in first row are used as the data source variable name.  

• For Access and SQL database table column names are used as data source variable name.

• In XML, file is converted to a table with the first element below Document Element identify rows. The second element identifies columns and is used as the data source variable name.  In the following example, Value identifies table rows, where ID, LastName, FirstName identity table columns:

<Export>

  <Values>

    <ID>987611</ID>

    <LastName>Fuller</LastName>

    <FirstName>Andrew</FirstName>

  </Values>

  <Values>

    <ID>987612</ID>

    <LastName>Leverling</LastName>

    <FirstName>Janet</FirstName>

  </Values>

</Export>

Exit codes

If no errors detected during execution exit code is set to 0.   
Otherwise exit code is set to 1.

Examples

PDFImprint /s"C:\test1.txt" /p /e"C:\PDFImprint.err"

PDFImprint /s"C:\test2.txt" /d"inc:seq:1000:2:10" /v"CustomerID=123456"/v"FormID= 3494"