IAzScope::AddPropertyItem method (azroles.h)

Article
02/22/2024

The AddPropertyItem method adds the specified principal to the specified list of principals.

Syntax

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

Parameters

[in] lPropId

Property ID of the list of principals to which to add the principal specified by the varProp parameter. The following table shows the possible values.

Value	Meaning
AZ_PROP_POLICY_ADMINS	Can also be added using the AddPolicyAdministrator method
AZ_PROP_POLICY_ADMINS_NAME	Can also be added using the AddPolicyAdministratorName method
AZ_PROP_POLICY_READERS	Can also be added using the AddPolicyReader method
AZ_PROP_POLICY_READERS_NAME	Can also be added using the AddPolicyReaderName method

[in] varProp

Principal to add to the list of principals specified by the lPropId parameter.

The variant must be a BSTR variant.

If AZ_PROP_POLICY_ADMINS or AZ_PROP_POLICY_READERS is specified for the lPropId parameter, the string is the text form of the security identifier (SID) of the Windows account to add to the list. If AZ_PROP_POLICY_ADMINS_NAME or AZ_PROP_POLICY_READERS_NAME is specified for the lPropId parameter, the string is the account name of the account to add to the list. The account name can be in either user principal name (UPN) format (for example, "someone@example.com") or in the "ExampleDomain\UserName" format.

[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