ICredentialProviderUser::GetSid method (credentialprovider.h)

Retrieves the user's security identifier (SID).

Syntax

HRESULT GetSid(
  [out] LPWSTR *sid
);

Parameters

[out] sid

The address of a pointer to a buffer that, when this method returns successfully, receives the user's SID. It is the responsibility of the caller to free this resource by calling the CoTaskMemFree function.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This SID applies to both logon and credential UI.

This value can also be retrieved as a PROPVARIANT through ICredentialProviderUser::GetValue.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header credentialprovider.h
Library CredentialProvider.lib
DLL Authui.dll

See also

ICredentialProviderUser

ICredentialProviderUser::GetValue