This function generates an XML file containing the list of jobs and their status etc. for the given VC name. It also filters the job list based on submittedBy, jobState and jobEndDate. The XML file will have some job fields populated. To populate all fields for a particular job, use GetJobInfo(String, Boolean, String, Boolean).

Namespace: VcClient
Assembly: VcClient (in VcClient.dll) Version: 1.0.0.0 (1.8.400.4142)

Syntax

C#
public static void GetJobsList(
	string vcName,
	string submittedBy,
	Nullable<JobInfo..::..JobState> jobState,
	Nullable<DateTime> jobEndDate,
	string fileName,
	bool overwrite
)
Visual Basic
Public Shared Sub GetJobsList ( _
	vcName As String, _
	submittedBy As String, _
	jobState As Nullable(Of JobInfo..::..JobState), _
	jobEndDate As Nullable(Of DateTime), _
	fileName As String, _
	overwrite As Boolean _
)
Visual C++
public:
static void GetJobsList(
	String^ vcName, 
	String^ submittedBy, 
	Nullable<JobInfo..::..JobState> jobState, 
	Nullable<DateTime> jobEndDate, 
	String^ fileName, 
	bool overwrite
)

Parameters

vcName
Type: String
Name of the VC for which the job list is requested
submittedBy
Type: String
The user who submitted the job
jobState
Type: Nullable<(Of <(<'JobInfo..::..JobState>)>)>
The state of the job. Supported values are queued, running, completed, succeeded, and failed.
jobEndDate
Type: Nullable<(Of <(<'DateTime>)>)>
Include only jobs completed on the date specified. Time part of DateTime structure is ignored. Date should be specified in PST zone. Note, that no active jobs (like queued or running) will be returned if this parameter is specified, just completed jobs.
fileName
Type: String
file to dump the XML to
overwrite
Type: Boolean
overwrite the file if it already exists?

Return Value

None

See Also