Batch methods

You can find more information about batch support here.

Batch methods

You can find more information about batch support here.

static int start()

Start the batch operation if it is not already running.

Name	Type	Default	Description
Return	int		0 or ErrorCode

Since

Version 4.1.6

Available

Illustrator

static int stop()

Stop the batch operation if it is running.

Name	Type	Default	Description
Return	int		0 or ErrorCode

Since

Version 4.1.6

Available

Illustrator

static int get_running()

Returns wether the batch operation is running

Name	Type	Default	Description
Return	int		0: Batch not running 1: Batch running

Since

Version 4.1.6

Available

Illustrator

static int 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)

Since

Version 4.1.6

Available

Illustrator

static int 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.

Since

Version 4.1.6

Available

Illustrator

static int set_interval(int interval)

Set the waiting interval between two batch jobs

Name	Type	Default	Description
Return	int		0 or ErrorCode
interval	int	-	Value Time 0 1 second 1 2 seconds 2 5 seconds 3 10 seconds 4 30 seconds 5 1 minute 6 2 minutes 7 5 minutes 8 15 minutes 9 30 minutes 10 1 hour 11 2 hours 12 4 hours 13 6 hours 14 12 hours 15 24 hours

Since

Version 4.1.6

Available

Illustrator

static int 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

Since

Version 4.1.6

Available

Illustrator

static int 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

Since

Version 4.1.6

Available

Illustrator

static String 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.

Since

Version 4.1.6

Available

Illustrator

static int 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

Since

Version 4.1.6

Available

Illustrator

static String 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.

Since

Version 4.1.6

Available

Illustrator

Author

Leo Quensel

Version

17.12.2024, 12:52 Uhr

Since

Plugin Version 4.1.6

Alphabetic index HTML hierarchy of classes or Java