IAzTask::SetProperty method (azroles.h)

Article
10/13/2021

The SetProperty method sets the specified value to the IAzTask object property with the specified property ID.

Syntax

HRESULT SetProperty(
  [in]           LONG    lPropId,
  [in]           VARIANT varProp,
  [in, optional] VARIANT varReserved
);

Parameters

[in] lPropId

Property ID of the IAzTask object property to set. The following table shows the possible values.

Value	Meaning
AZ_PROP_APPLICATION_DATA	Also accessed through the ApplicationData property
AZ_PROP_DESCRIPTION	Also accessed through the Description property
AZ_PROP_NAME	Also accessed through the Name property
AZ_PROP_TASK_BIZRULE	Also accessed through the BizRule property
AZ_PROP_TASK_BIZRULE_LANGUAGE	Also accessed through the BizRuleLanguage property
AZ_PROP_TASK_IS_ROLE_DEFINITION	Also accessed through the IsRoleDefinition property

[in] varProp

Value to set to the IAzTask object property specified by the lPropId parameter. The following table shows the type of data that must be used depending on the value of the lPropId parameter.

lPropId value	Data type
AZ_PROP_APPLICATION_DATA	BSTR
AZ_PROP_DESCRIPTION	BSTR
AZ_PROP_NAME	BSTR
AZ_PROP_TASK_BIZRULE	BSTR
AZ_PROP_TASK_BIZRULE_LANGUAGE	BSTR
AZ_PROP_IS_ROLE_DEFINITION	BOOL

[in, optional] varReserved

Reserved for future use.

Return value

The return value is an HRESULT. A value of S_OK indicates success. Any other value indicates that the operation failed.

Remarks

You must call the Submit method to persist any changes made by this method.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	azroles.h
Library	Azroles.lib
DLL	Azroles.dll
Redistributable	Windows Server 2003 Administration Tools Pack on Windows XP

Share via