IScheduler::GetJobList method
Retrieves a list of job objects based on the specified filters.
Syntax
HRESULT GetJobList(
[in] IFilterCollection *filterProperties,
[in] ISortCollection *sortProperties,
[out] ISchedulerCollection **list
);
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.list [out]
An ISchedulerCollection interface that contains a collection of job objects. Each item in the collection is a variant of type VT_DISPATCH. Query the pdispVal member of the variant for the ISchedulerJob interface.
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).
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 |