The InfigoBatchRun type exposes the following members.
Constructors
Name | Description | |
---|---|---|
InfigoBatchRun |
Constructs a new batch process object. Each object can only be used once.
|
Methods
Name | Description | |
---|---|---|
Close |
Call this method as the very last after either IsRunning()()() or HasFinished()()()
returns true (no matter if the job stopped automatically or after calling Stop()()()).
This will clean up the resources and output data properly.
| |
Equals | (Inherited from Object.) | |
Finalize |
Try clearing all temporary created directories.
(Overrides Object..::.Finalize()()().) | |
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
GetLastError |
Query for errors.
| |
GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
HasFinished |
Returns true if the batch job has finished successfully (no errors or
interrupted occured during the run and the data has been created successfully).
| |
IsRunning |
Returns true if the batch job is still running. This is useful to determine the
current status of the batch job. Please note that if a job gets interrupted
manually, it might still run for a while, so using this method after stopping
manually is important.
| |
MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
Start |
Call this method to start the batch run. The batch will run
in its separate thread and therefore the method returns
immediately.
| |
Stop |
Manually interrupt a batch job. This will stop the processing and not generate any
output files. Please note that, although this method returns immediately, the batch
job will in fact run a bit longer until it has finished cleaning up. Therefore,
the method IsRunning()()() should be used to identify the exact time
of execution end.
| |
ToString | (Inherited from Object.) |
Properties
Name | Description | |
---|---|---|
CurrentRecord |
This function returns the current record number in process. Please note
that this will only return correct results after the job has started via
Start()()() | |
NumberOfRecords |
This function returns the total number of records to process. Please note
that this will only return correct results after the job has started via
Start()()().
| |
WorkingDirectory |
Returns the temporary working directory where preview batch runs
are stored if no parameters are given.
|