Update job properties, such as priority and VC allocation, of a queued or running job.
Namespace: VcClientAssembly: VcClient (in VcClient.dll) Version: 1.0.0.0 (1.8.400.4142)
Syntax
C# |
---|
[ObsoleteAttribute("Use UpdateJob(Guid jobId, JobUpdateInfo updateInfo) instead.")]
public static void UpdateJob(
Guid jobId,
Nullable<int> priority,
Nullable<double> vcPercentAllocation
) |
Visual Basic |
---|
<ObsoleteAttribute("Use UpdateJob(Guid jobId, JobUpdateInfo updateInfo) instead.")> _
Public Shared Sub UpdateJob ( _
jobId As Guid, _
priority As Nullable(Of Integer), _
vcPercentAllocation As Nullable(Of Double) _
) |
Visual C++ |
---|
[ObsoleteAttribute(L"Use UpdateJob(Guid jobId, JobUpdateInfo updateInfo) instead.")]
public:
static void UpdateJob(
Guid jobId,
Nullable<int> priority,
Nullable<double> vcPercentAllocation
) |
Parameters
- jobId
- Type: Guid
ID of the job to be updated.
- priority
- Type: Nullable<(Of <(<'Int32>)>)>
New job priority. If null, priority will not be updated.
- vcPercentAllocation
- Type: Nullable<(Of <(<'Double>)>)>
New job VC allocation percentage. If null, VC allocation percentage will not be updated.
Exceptions
Exception | Condition |
---|
ArgumentException | Thrown when all job properties are null or a job property has an invalid value. |
InvalidOperationException |
Thrown when the operation cannot be fulfilled on the specified job, such as when the job is not in the queued or running states.
|
VcClientExceptions..::..VcClientException | Thrown when an unknown error occurred during the operation. |
See Also