ICredentialProviderUser::GetStringValue 方法 (credentialprovider.h)

根据输入值从 ICredentialProviderUser 对象检索字符串属性。

语法

HRESULT GetStringValue(
  [in]  REFPROPERTYKEY key,
  [out] LPWSTR         *stringValue
);

参数

[in] key

以下值之一,用于指定要检索的属性。

REFPROPERTYKEY 说明 适用于...
PKEY_Identity_DisplayName 友好的用户名。 登录 UI 和凭据 UI
PKEY_Identity_LogonStatusString 一个本地化字符串,指示用户的登录状态。 仅限登录 UI
PKEY_Identity_PrimarySid 用户的 SID。 登录 UI 和凭据 UI
PKEY_Identity_ProviderID 用户的提供程序 ID。 登录 UI 和凭据 UI
PKEY_Identity_QualifiedUserName 用于打包身份验证缓冲区的名称。 登录 UI 和凭据 UI
PKEY_Identity_UserName 用户名。 登录 UI 和凭据 UI

[out] stringValue

指向缓冲区的指针的地址,当此方法成功返回时,该缓冲区接收请求的字符串。

返回值

如果该方法成功,则返回 S_OK。 否则,将返回 HRESULT 错误代码。

注解

还可以通过 ICredentialProviderUser::GetValue 作为 PROPVARIANT 检索其中每个值。

请考虑以下用户的场景。

  • 域用户:
    • 域:contoso
    • 用户名:lisa
    • 友好姓名:丽莎·安德鲁斯
  • 本地用户:
    • 电脑名称:lisa-pc
    • 用户名:lisa
    • 友好姓名:丽莎·安德鲁斯
  • Microsoft 帐户:
    • 电子邮件地址:lisa@contoso.com
    • 友好姓名:丽莎·安德鲁斯
在此方案中,下表提供了每个 值的一些示例数据。
REFPROPERTYKEY 域用户 本地用户 Microsoft 帐户
PKEY_Identity_DisplayName “丽莎·安德鲁斯” “丽莎·安德鲁斯” “丽莎·安德鲁斯”
PKEY_Identity_LogonStatusString “已登录” “已锁定” “从 lisa-pc 远程登录”
PKEY_Identity_PrimarySid “{S-1-5-21-2279990834-2601404236-735077814-1001}” “{S-1-5-21-2279990834-2601404236-735077814-1001}” “{S-1-5-21-2279990834-2601404236-735077814-1001}”
PKEY_Identity_ProviderID “{A198529B-730F-4089-B646-A12557F5665E}” “{A198529B-730F-4089-B646-A12557F5665E}” 未预定义
PKEY_Identity_QualifiedUserName “contoso\lisa” “lisa-pc\lisa” “<帐户提供程序名称>\lisa@contoso.com”
PKEY_Identity_UserName “contoso\lisa” “lisa” "lisa@contoso.com"

要求

要求
最低受支持的客户端 Windows 8 [仅限桌面应用]
最低受支持的服务器 Windows Server 2012 [仅限桌面应用]
目标平台 Windows
标头 credentialprovider.h
Library CredentialProvider.lib
DLL Authui.dll

另请参阅

ICredentialProviderUser

ICredentialProviderUser::GetValue