ICredentialProviderUser::GetValue method (credentialprovider.h)

Article
10/13/2021

Retrieves a specified property value set for the user.

Syntax

HRESULT GetValue(
  [in]  REFPROPERTYKEY key,
  [out] PROPVARIANT    *value
);

Parameters

[in] key

One of the following values that specify the property to retrieve.

REFPROPERTYKEY	Applies to...
PKEY_Identity_DisplayName	Logon and credential UI
PKEY_Identity_UserName	Logon and credential UI
PKEY_Identity_QualifiedUserName	Logon and credential UI
PKEY_Identity_LogonStatusString	Logon UI only
PKEY_Identity_PrimarySid	Logon and credential UI
PKEY_Identity_ProviderID	Logon and credential UI

[out] value

A pointer to a value that, when this method returns successfully, receives the requested property value.

Return value

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

Remarks

The PKEY_Identity_DisplayName, PKEY_Identity_UserName, PKEY_Identity_QualifiedUserName, and PKEY_Identity_LogonStatusString values can be retrieved directly as strings through the GetStringValue method.

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