IAzApplication::AddPolicyReaderName method (azroles.h)

Article
02/22/2024

The AddPolicyReaderName method adds the specified account name to the list of principals that act as policy readers.

Syntax

HRESULT AddPolicyReaderName(
  [in]           BSTR    bstrReader,
  [in, optional] VARIANT varReserved
);

Parameters

[in] bstrReader

Account name to add to the list of policy readers. The account name must be in user principal name (UPN) format (for example, "someone@example.com"). The LookupAccountName function is called to retrieve the domain.

[in, optional] varReserved

Reserved for future use.

Return value

If the method succeeds, the method returns S_OK.

Any other HRESULT value indicates that the operation failed.

Remarks

Policy readers for an object can read attributes for the object and for child objects of the object. Readers can also use the policy; for example, readers can call the AccessCheck method. Readers cannot modify the object or its child objects.

To view the list of policy readers in account name format, use the PolicyReadersName property.

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