ICredentialProviderUserArray

ログオン UI または資格情報 UI に表示されるユーザーの集合を表します。この情報により、資格情報プロバイダーはこの集合を列挙して各ユーザーのプロパティ情報を取得し、フィールドを設定したり集合をフィルターしたりできます。

このオブジェクトは、Windows 資格情報プロバイダー フレームワークから ICredentialProviderSetUserArray::SetUserArray メソッドを通じて資格情報プロバイダーに提供されます。このオブジェクトの所有権は資格情報プロバイダー フレームワークが保持します。

実装するタイミング

使用例

次の例は、このインターフェイスのいくつかのメソッドを使用するシナリオを示しています。pcpua 変数は、あらかじめ宣言された ICredentialProviderUserArray オブジェクトを表します。

DWORD dwCount = 0;

HRESULT hr = pcpua->GetCount(&dwCount);

if (SUCCEEDED(hr))
{
    for (DWORD i = 0; i < dwCount; i++)
    {
        ICredentialProviderUser *pcpu = NULL;
        hr = pcpua->GetAt(i, &pcpu);

        if (SUCCEEDED(hr))
        {
            PWSTR pszName = NULL;
            hr = pcpu->GetStringValue(PKEY_Identity_UserName, &pszName);

            if (SUCCEEDED(hr))
            {
                // 文字列を使って何らかの処理を行う
                CoTaskMemFree(pszName);
            }
            pcpu->Release();
        }
    }
}

配列内のユーザーの集合を、ローカル アカウントまたは Microsoft アカウントのいずれかに限定します。

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

ICredentialProviderUserArray オブジェクトには、現在のシナリオで利用可能なすべてのユーザーが含まれます。このメソッドを使用すると、資格情報プロバイダーはそれらのユーザーの特定の一部を指定できます。たとえば、資格情報プロバイダーが特定の接続済みプロバイダーの Microsoft アカウント ユーザーのみを扱う場合、Microsoft アカウント プロバイダーの ID を指定してこのメソッドを呼び出し、他のプロバイダーに属するユーザーを除外できます。

このメソッドは、単一のアカウント プロバイダーでフィルターするために一度だけ呼び出せます。メソッドが再度呼び出された場合、呼び出しは E_UNEXPECTED の戻り値で失敗します。

ローカル アカウントまたは Microsoft アカウント用の「その他のユーザー」タイルがログオン UI または資格情報 UI に表示されるかどうかを示す値を取得します。

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

ユーザー配列内の ICredentialProviderUser オブジェクトの数を取得します。

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

配列から指定されたユーザーを取得します。

このメソッドが成功した場合は S_OK を返します。それ以外の場合は、次のものを含む HRESULT エラー コードを返します。