This function gets the list of jobs and their status etc. for the given VC name.
It also filters the job list based on submittedBy, jobstate and submitDate.
Namespace: VcClient.TestAssembly: VcClient (in VcClient.dll) Version: 1.0.0.0 (1.8.400.4142)
Syntax
| C# |
|---|
public virtual List<JobInfo> GetJobsList(
string vcName,
string submittedBy,
Nullable<JobInfo..::..JobState> jobState,
Nullable<DateTime> submitDate
) |
| Visual Basic |
|---|
Public Overridable Function GetJobsList ( _
vcName As String, _
submittedBy As String, _
jobState As Nullable(Of JobInfo..::..JobState), _
submitDate As Nullable(Of DateTime) _
) As List(Of JobInfo) |
| Visual C++ |
|---|
public:
virtual List<JobInfo^>^ GetJobsList(
String^ vcName,
String^ submittedBy,
Nullable<JobInfo..::..JobState> jobState,
Nullable<DateTime> submitDate
) |
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.
- submitDate
- Type: Nullable<(Of <(<'DateTime>)>)>
Date of submission.
Return Value
List of JobInfo object
Exceptions
| Exception | Condition |
|---|
| ArgumentNullException | vcName is null. |
| ArgumentException | vcName is empty or contains
whitespace only. |
See Also
