ISchedulerTask::SetCustomProperty method

Sets an application-defined property on the task.

Syntax

HRESULT SetCustomProperty(
  [in] BSTR name,
  [in] BSTR value
);

Parameters

  • name [in]
    The property name. The name is limited to 80 Unicode characters.

  • value [in]
    The property value as a string. The name is limited to 1,024 Unicode characters.

Return value

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

Use this method to define your own properties that are passed to the submission and activation filters. If the property exists, the value of the property is updated. If value is null, the property is deleted.

To retrieve the application-defined properties, call the GetCustomProperties method.

Requirements

Product

HPC Pack 2008 R2 Client Utilities, HPC Pack 2008 Client Utilities

Type library

Microsoft.Hpc.Scheduler.tlb

See also

ISchedulerTask

ISchedulerTask::GetCustomProperties