ICredentialProviderUser::GetValue method

Retrieves a specified property value set for the user.

Syntax


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

Parameters

key [in]

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

REFPROPERTYKEYApplies 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

 

value [out]

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

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

CredentialProvider.h

IDL

CredentialProvider.idl

Library

CredentialProvider.lib

DLL

Authui.dll

See also

ICredentialProviderUser
ICredentialProviderUser::GetStringValue

 

 

Community Additions

ADD
Show:
© 2015 Microsoft