JobExecutionInfo structure

This structure defines configuration information for how a Job is executed and returns information about the job execution

Syntax

struct JobExecutionInfo {
  DWORD             Size;
  const Job         *Job;
  DWORD             Flags;
  DWORD             Timeout;
  LPCWSTR           RestartDirectory;
  LPCWSTR           RestartCommand;
  LPCWSTR           RestartMinimumCommand;
  LPCWSTR           WorkloadTempDirectory;
  INT               WorkloadAssessmentIndex;
  JobExecutionError Error;
  BOOL              Restarting;
};

Members

Size

The number of bytes in the structure. Used to detect different versions of structure. This must be set to sizeof(SolutionParameters) before initializing the Solution interface with this structure.

Job

A pointer to the Job object to execute. The Job object is created by CreateJob.

Flags

Specifies flags that control how the job will be executed. This value can be a combination of the flags defined in the JobExecutionFlags enumeration.

Timeout

The amount of time the engine will wait for a job running within another engine to finish. If the Solution API is configured in Workload mode, this value must be 0.

RestartDirectory

The directory where the solution application exists. If an assessment in the job causes the system to reboot, the solution will be relaunched from this directory. If the Solution API is configured in Workload mode, this value must be NULL. Otherwise, this member must not be NULL.

RestartCommand

The command string to execute in the RestartDirectory in order to run the solution if the job causes the system to reboot. If the Solution API is configured in Workload mode, this value must be NULL. Otherwise, this member must not be NULL.

RestartMinimumCommand

The command string to execute to restart the job in console mode. If the Solution API is configured in Workload mode, this value must be NULL.

WorkloadTempDirectory

The path that workloads should use for their temporary and results files. Workloads should not produce any files because workloads are used to exercise the system under test while another assessment measures the system. All of the files written out by workloads are deleted when the workload finishes. If the Solution API is configured in Workload mode, this member must not be NULL. Otherwise, this member must be NULL.

WorkloadAssessmentIndex

The position in the job manifest of the AssessmentRun entry for the assessment that will be running as a solution assessment that executes workloads. This index is used to locate the nested AssessmentRuns collection that describes the workloads to run. The WorkloadAssessmentIndex is zero-based. This field is ignored if the Solution API is not configured in Workload mode.

Error

An out value that contains the value of the last error that occurred in processing the job, i.e. the last error in the job error list, if the job was executed synchronously. If the job was executed asynchronously, this value will be JobExecutionErrorNone.

Restarting

An out parameter that indicates the job has not completed yet because an assessment or workload is rebooting the system.

Requirements