BatchJobProfile class | QSYS API Reference Guide

Estimated reading time: 2 minutes

Provides the facilities to configure and launch a batch job.

Namespace: ASNA.QSys.Runtime.JobSupport Assembly: ASNA.QSys.Runtime.dll

Inheritance: Object

Constructors

Name Description
BatchJobProfile(BatchOptions, String, Object[]) Initializes a new instance of the BatchJobProfile class using the batch options, program and program parameters.
BatchJobProfile(String, Object[]) Initializes a new instance of the BatchJobProfile class using the program and program parameters with batch default options.

BatchJobProfile(BatchOptions, String, Object[])

Initializes a new instance of the BatchJobProfile class using the batch options, program and program parameters.

BatchJobProfile(BatchOptions, String, Object[])

Parameters

Type Parameter name Description
BatchOptions options The configuration options for the new Job.
String programName Program to run in the new Job.
Object[] parmList List of parameters to be passed to the initial program.

BatchJobProfile(String, Object[])

Initializes a new instance of the BatchJobProfile class using the program and program parameters with batch default options.

BatchJobProfile(String, Object[])

Parameters

Type Parameter name Description
String programName Program to run in the new Job.
Object[] parmList List of parameters to be passed to the initial program.

Properties

Type Name Description
BatchOptions BatchOptions Get the options for the new batch job.

Methods

Signature Description
StartInProcess() Starts the new job on a separate thread in the current process.
StartOutOfProcess() Starts the new job on a new process.
Submit(String, String, String, String) Enqueues the batch job.

void StartInProcess()

Starts the new job on a separate thread in the current process.

void StartInProcess()

void StartOutOfProcess()

Starts the new job on a new process.

void StartOutOfProcess()

void Submit(string JobQueueName, string JobQueuePriority, string ScheduleDateString, string ScheduleTimeString)

Enqueues the batch job.

void Submit(string JobQueueName, string JobQueuePriority, string ScheduleDateString, string ScheduleTimeString)

Parameters

Type Parameter name Description
String JobQueueName The name of the queue to receive the job request.
String JobQueuePriority The priority of the batch job in the job queue.
String ScheduleDateString The date when the new job becomes eligible to run. Special values include: CURRENT, *MON->SUN, *MONTHSTR and *MONTHEND.
String ScheduleTimeString The time of day when the new job becomes eligible to run. Special value: *CURRENT.