ISchedulerTask::IsParametric property
Determines whether the task is a parametric task.
This property is read/write.
Syntax
HRESULT put_IsParametric(
[in] VARIANT_BOOL isParametric
);
HRESULT get_IsParametric(
[out] VARIANT_BOOL *pIsParametric
);
Property value
Set to VARIANT_TRUE if the task is a parametric task; otherwise, VARIANT_FALSE. The default is VARIANT_FALSE.
Error codes
If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code. To get a description of the error, access the ErrorMessage job property.
Remarks
For parametric tasks, the Scheduler replaces all occurrences of an asterisk (*) found in the following task properties, with the instance value:
The total number of instances that a parametric task can generate is 100,000 instances.
When you add or submit the job that contains the parametric task to the Scheduler, the Scheduler adds all the instances of the parametric task to the job. If you change any of the following properties on a parametric task, the Scheduler will rewrite the instances (if you change IsParametric to VARIANT_FALSE, the scheduler will remove the instances):
- IsParametric
- EndValue
- IncrementValue
- StartValue
To get the parametric task from the job, call the IScheduler::CreateTaskId method and specify the parametric task identifier. Then call the ISchedulerJob::OpenTask method to get the task. To get an instance of the parametric task, call the IScheduler::CreateParametricTaskId method and specify the instance identifier and parametric task identifier. Then call the OpenTask method to get the instance.
Examples
For an example, see Creating a Parametric Sweep Task.
Requirements
Product |
HPC Pack 2008 R2 Client Utilities, HPC Pack 2008 Client Utilities |
Type library |
Microsoft.Hpc.Scheduler.tlb |