Please enable JavaScript to view this site.

TIFF Image Printer

 

warning

You must have SetV11CompatibilityModeEnabled set to true to use this method with PNSrv12Lib.

Beginning with version 9.0 of the printer drivers, this method has been superseded bySetSaveOptions (SetV11SaveOptions when in version 11 compatibility mode). This method will still work when called using TIFF Image Printer and PDF Image Printer but an error is thrown when used with Raster Image Printer.

Description

Sets file naming options on the IPNSession object.

To set a single file naming option use the SetProperty call with the appropriate arguments. See the Remarks below for a list of arguments.

For a more detailed explanation of the file naming options, see the User Guide for the PEERNET Inc. printer being used.

Syntax

expression.SetFileNamingOptions(Directory, BaseFilename, Multipage, Append,

                         UseJobID, PromptForFileName, OverwriteAlways,

                         RemoveExt, RemoveProdName,DeleteAtEnd)

where expression is an IPNSession object.

Parameters

String Directory

Pass the fully qualified path to the directory for storing the output your files. If this string is empty, the Documents folder of the currently logged in user is used to store the files.

String BaseFilename

This is the base filename for your output file. The base filename excludes any directory path and file extension. If you want your output files to always be saved under the same filename, enter that name here.If this field is empty the print job name the printing application uses when submitting the file to the printer is used instead.

Boolean Multipage

Set this to True to create multi-paged output files, or False to create serialized output files. Not all output formats in all printers support multi-paged output.

Boolean Append

Set this to True to append, or concatenate, the pages to an existing output file or, if you are creating serialized files, an existing sequence of files.

Boolean UseJobID

A JobID is associated with every printer and is initially set to zero. It is automatically incremented by the printer at the start of every print job.The JobID is often used to ensure that all files created have unique names. It is also used to determine which naming profile to use.

Boolean PromptForFileName

Set to True to show the printer's Save Image dialog prompt, or False to hide the prompt and use the Directroy and BaseFilename settings to create the filename.

Boolean OverwriteAlways

Set to True to overwrite existing files without prompting, or False to be prompted to confirm the overwrite action or to provide a new filename.

Boolean bRemoveExt

Set to True to automatically remove any file extension passed to the printer as part of the filename.

Boolean RemoveProdName

Set to True to automatically remove any product names that are added to the printed filename by the printing application. Product names are any text that precedes the following characters:  a space, a dash and a space (" - ").

Boolean DeleteAtEnd

Set to True to automatically delete all output files at the end of the print job, after any final Run command.This option is useful if you are want to send the output by email without leaving any local copies.

Remarks

Use the following to set these options using SetProperty:

Method Parameter

SetProperty Parameters

Enable

SectionName:

Image Options

PropertyName:

Fax

varValue:

VT_BOOL

BaseFilename

SectionName:

Save

PropertyName:

Output filename

varValue:

VT_BSTR, as above

Multipage

SectionName:

Save

PropertyName:

Output format

varValue:

VT_BSTR, one of the following:

Multipage, Serialized

Append

SectionName:

Save

PropertyName:

Append

varValue:

VT_BOOL

UseJobID

SectionName:

Save

PropertyName:

Use JobID

varValue:

VT_BOOL

PromptForFileName

SectionName:

Save

PropertyName:

Prompt

varValue:

VT_BOOL

OverwriteAlways

SectionName:

Save

PropertyName:

Overwrite

varValue:

VT_BOOL

RemoveExt

SectionName:

Save

PropertyName:

Remove filename extension

varValue:

VT_BOOL

RemoveProdName

SectionName:

Save

PropertyName:

Remove product name

varValue:

VT_BOOL

DeleteAtEnd

SectionName:

Save

PropertyName:

Delete files

varValue:

VT_BOOL

Supported Printers: <%SUPDRV_TIFF_PDF%>

See Also: SetSaveOptions SetNamingProfileFormat ClearFileNamingOptions ClearNamingProfileFormat SetProperty