Batch methods
You can find more information about batch support here.
Batch methods
You can find more information about batch support here.
static int batch::start()
Start the batch operation if it is not already running.
Name | Type | Default | Description |
Return | int | 0 or ErrorCode |
static int batch::stop()
Stop the batch operation if it is running.
Name | Type | Default | Description |
Return | int | 0 or ErrorCode |
static int batch::get_running()
Returns wether the batch operation is running
Name | Type | Default | Description |
Return | int | 0: Batch not running 1: Batch running |
static int batch::set_start(int hours, int minutes)
Set the starting time for the batch operation
To start the batch operation at the designated time, batch::start has to be called afterwards.
Has no effect when the batch operation is already running.
Name | Type | Default | Description |
Return | int | 0 or ErrorCode | |
hours | int | - | Hour of designated start time (0-23) |
minutes | int | - | Minute of designated start time (0-59) |
static int batch::get_start(int* oHours, int* oMinutes)
Get the designated starting time of the batch operation.
Name | Type | Default | Description |
Return | int | 0 or ErrorCode | |
oHours | int * | - | Contains the hour of the designated starting time after execution (0-23), or -1 when no starting time is set. |
oMinutes | int * | - | Contains the minutes of the designated starting time after execution (0-59), or -1 when no starting time is set. |
static int batch::set_interval(int interval)
Set the waiting interval between two batch jobs
Name | Type | Default | Description | ||||||||||||||||||||||||||||||||||
Return | int | 0 or ErrorCode | |||||||||||||||||||||||||||||||||||
interval | int | - |
|
static int batch::get_interval(int* oInterval)
Get the waiting interval between two batch jobs
Name | Type | Default | Description |
Return | int | 0 or ErrorCode | |
oInterval | int * | - | Contains the interval after successful execution. For values see set_interval |
static int batch::set_hotfolder_in(char* inFolder)
Set the input folder. Only works when the batch operation is not running.
Name | Type | Default | Description |
Return | int | 0 or ErrorCode | |
inFolder | String or char * | - | Input folder |
static String batch::get_hotfolder_in()
Get the input folder.
Name | Type | Default | Description |
Return | String | Input folder The return value is read only, do NOT CHANGE. The result will be overridden on following calls to the function. Learn more about functions returning r/o char* values. |
static int batch::set_hotfolder_out(char* outFolder)
Set the output folder. Only works when the batch operation is not running.
Name | Type | Default | Description |
Return | int | 0 or ErrorCode | |
outFolder | String or char * | - | Output folder |
static String batch::get_hotfolder_out()
Get the output folder.
Name | Type | Default | Description |
Return | String | Output folder The return value is read only, do NOT CHANGE. The result will be overridden on following calls to the function. Learn more about functions returning r/o char* values. |
Alphabetic index HTML hierarchy of classes or Java