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 submissionDate.
Namespace: VcClient.TestAssembly: VcClient (in VcClient.dll) Version: 1.0.0.0 (1.8.400.4142)
Syntax
| C# |
|---|
public virtual void GetJobsListFile(
string vcName,
string submittedBy,
Nullable<JobInfo..::..JobState> jobState,
Nullable<DateTime> submissionDate,
string fileName,
bool overwrite
) |
| Visual Basic |
|---|
Public Overridable Sub GetJobsListFile ( _
vcName As String, _
submittedBy As String, _
jobState As Nullable(Of JobInfo..::..JobState), _
submissionDate As Nullable(Of DateTime), _
fileName As String, _
overwrite As Boolean _
) |
| Visual C++ |
|---|
public:
virtual void GetJobsListFile(
String^ vcName,
String^ submittedBy,
Nullable<JobInfo..::..JobState> jobState,
Nullable<DateTime> submissionDate,
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.
- submissionDate
- Type: Nullable<(Of <(<'DateTime>)>)>
date in MM/DD/YYYY format
- fileName
- Type: String
file to dump the XML to
- overwrite
- Type: Boolean
overwrite the file if it already exists?
Return Value
None
Exceptions
| Exception | Condition |
|---|
| IOException | error writing to file. |
| InvalidOperationException | In a case of inconsistent state of job. |
| VcClientExceptions..::..VcClientException | in a case of any other error. |
| InvalidDataException | Internal error. |
See Also
