IScheduler::GetJobIdList method
Retrieves a list of job identifiers based on the specified filters.
Syntax
HRESULT GetJobIdList(
[in] IFilterCollection *filterProperties,
[in] ISortCollection *sortProperties,
[out] IIntCollection **jobIds
);
Parameters
filterProperties [in]
An IFilterCollection interface that contains one or more filter properties used to filter the list of jobs. If NULL, the method returns all jobs.sortProperties [in]
An ISortCollection interface that contains one or more sort properties used to sort the list of jobs. If NULL, the list is not sorted.jobIds [out]
An IIntCollection interface that contains one or more job identifiers that match the specified filter criteria.
Return value
If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code.
Remarks
If you specify more than one filter, a logical AND is applied to the filters (for example, return jobs that are running and have exclusive access to the nodes).
If you use the enumerator to enumerate each item in the jobIds collection, the item is a VARIANT of type VT_I4. Query the lVal member for the job identifier.
Examples
For an example, see Getting a Getting a List of Jobs.
Requirements
Product |
HPC Pack 2008 R2 Client Utilities, HPC Pack 2008 Client Utilities |
Type library |
Microsoft.Hpc.Scheduler.tlb |