Description
Sets any Run at Start of Job command options in the IPNSession object.
The Run commands are included for backwards compatibility with previous applications using this method, but new applications should use the IPNSession events to perform custom actions at the appropriate stage. The Start of Job run command is replaced with the OnStartJob event.
To set a single Run at Start of Job command option use the SetProperty call with the appropriate arguments. See the Remarks below for a list of arguments.
Syntax
expression.SetRunAtStartCommand(Enable, PathToEXE, ExeParameters, WorkingDir,
ActivateWnd, WndState, WaitMode, Prompt)
where expression is an IPNSession object.
Parameters
Boolean Enable
Pass True to enable the Run at Start of Job command.
String PathToEXE
The full path to the command you want to launch. A command is limited to 128 characters in length, and can be an executable, a file or a DLL.
String ExeParameters
Any parameters you need to send to your application. A list of parameters is limited to 255 characters.
String WorkingDir
The default working directory for your application.
Boolean ActivateWnd
Pass True to activate the window in which your application runs.
pnRunCommandWindowState WndState
A pnRunCommandWindowState constant for the window state of the application you are running.
pnRunCommandsWaitMode WaitMode
A pnRunCommandsWaitMode constant for the wait mode on the command.
String Prompt
A string to prompt if the WaitMode is pnRunCommandsWaitModePromptToContinue. Pass an empty string for the other wait modes.
Remarks
Use the following to set these options using SetProperty:
Method Parameter |
SetProperty Parameters |
||||||||
|---|---|---|---|---|---|---|---|---|---|
Enable |
|
||||||||
PathToEXE |
|
||||||||
ExeParameters |
|
||||||||
WorkingDir |
|
||||||||
ActivateWnd |
|
||||||||
WndState |
|
||||||||
WaitMode = |
|
||||||||
WaitMode = |
|
||||||||
WaitMode = |
|
||||||||
WaitMode = |
|
||||||||
Prompt |
|
||||||||
Supported Printers: TIFF Image Printer, PDF Image Printer, Raster Image Printer
See Also: OnStartJob SetRunAtEndCommand ClearRunAtStartCommand ClearRunAtEndCommand SetProperty pnRunCommandWindowState pnRunCommandsWaitMode