ISchedulerTask::IncrementValue property

Retrieves or sets the number by which to increment the instance value for a parametric task.

This property is read/write.

Syntax

HRESULT put_IncrementValue(
  [in]  long value
);

HRESULT get_IncrementValue(
  [out] long *pValue
);

Property value

The increment value used to calculate the next instance value. The default is 1.

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 task property.

Remarks

The parametric instance value is incremented by the increment value until the instance value exceeds the specified ending value.

This property has meaning only if the IsParametric property is VARIANT_TRUE.

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

See also

ISchedulerTask

ISchedulerTask.EndValue

ISchedulerTask.IsParametric

ISchedulerTask.StartValue