ISchedulerJob::GetCustomProperties method

Retrieves the application-defined properties.

Syntax


HRESULT GetCustomProperties(
  [out] INameValueCollection **ppProperties
);

Parameters

ppProperties [out]

An INameValueCollection interface that contains the collection of properties. Each item in the collection is an INameValue interface that contains the property name and value. To retrieve the list of INameValue interfaces, call the INameValueCollection::GetEnumerator method. The variant type of each item is VT_DISPATCH. Query the pdispVal member of the variant for the INameValue interface. The collection is empty if no properties have been defined.

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 ISchedulerJob::ErrorMessage property.

Remarks

To add application-defined properties to the job, call the ISchedulerJob::SetCustomProperty method.

Requirements

Product

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

Type library

Microsoft.Hpc.Scheduler.tlb

See also

ISchedulerJob
ISchedulerJob::SetCustomProperty

 

 

Show: