ISchedulerJob::HoldUntil property
Gets the date and time (in Coordinated Universal Time) until which the HPC Job Scheduler Service should wait before trying to start the job.
This property is read-only.
Syntax
HRESULT get_HoldUntil(
[out, retval] DATE *pRetVal
);
Property value
A DATE that indicates the date and time until which the HPC Job Scheduler Service should wait before trying to start the job.
Error codes
If the method succeeds, the return value is S_OK. Otherwise, the return value is an error value.
Remarks
The HPC Job Scheduler Service only runs the job at the date and time that this property specifies if the resources needed for the job are available. If the resources needed for the job are not available at that date and time, the job remains queued until the necessary resources become available.
If the job is not on hold, the DATE returned has a value of 0.0, which represents midnight of December 30, 1899.
You cannot set the value of this property by using the COM API that the Microsoft HPC Pack 2008 R2 SDK provides. You can set this property by using one of the following items:
- The ISchedulerJob.SetHoldUntil method of the .NET API.
- The job modify command.
- The SetHoldUntil property of the HpcJob object that the Get-HpcJob cmdlet returns.
Requirements
Product |
HPC Pack 2008 R2 Client Utilities |
Type library |
Microsoft.Hpc.Scheduler.tlb |