Edit

IAzClientContext::get_UserCanonical method (azroles.h)

  • Article

The UserCanonical property retrieves the name of the current client in canonical format.

This property is read-only.

Syntax

HRESULT get_UserCanonical(
  BSTR *pbstrProp
);

Parameters

pbstrProp

Return value

None

Remarks

The canonical client name is retrieved by impersonating the client token and calling the GetUserNameEx function with NameCanonical specified for the NameFormat parameter.

An example of a client name in canonical format is "example.fourthcoffee.com/software/Ben Smith".

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