ICredentialProvider::SetUsageScenario メソッド (credentialprovider.h)

[アーティクル]
08/22/2023

資格情報プロバイダーが有効なシナリオを定義します。資格情報プロバイダーが初期化されるたびに呼び出されます。

構文

HRESULT SetUsageScenario(
  [in] CREDENTIAL_PROVIDER_USAGE_SCENARIO cpus,
  [in] DWORD                              dwFlags
);

パラメーター

[in] cpus

種類: CREDENTIAL_PROVIDER_USAGE_SCENARIO

資格情報プロバイダーが作成されたシナリオ。これは、サポートする必要がある使用シナリオです。詳細については、「解説」を参照してください。

[in] dwFlags

型: DWORD

資格情報プロバイダーの動作に影響を与える値。この値は、Wincred.h で定義されている次の 1 つ以上の値のビットごとの OR の組み合わせにすることができます。詳細については、「 CredUIPromptForWindowsCredentials 」を参照してください。

CREDUIWIN_GENERIC (0x00000001)

0x00000001。呼び出し元は、資格情報プロバイダーがプレーンテキストでユーザー名とパスワードを返すように要求しています。この値を CREDUIWIN_SECURE_PROMPTと組み合わせることはできません。

CREDUIWIN_CHECKBOX (0x00000002)

0x00000002。 [チェック保存] ボックスがダイアログボックスに表示されます。

CREDUIWIN_AUTHPACKAGE_ONLY (0x00000010)

0x00000010。入力認証パッケージをサポートする資格情報プロバイダーのみを列挙する必要があります。資格情報プロバイダーが入力認証パッケージをサポートしていない場合は、ユーザータイルを 0 個列挙する必要があります。この値を CREDUIWIN_IN_CRED_ONLYと組み合わせることはできません。

CREDUIWIN_IN_CRED_ONLY (0x00000020)

0x00000020。プロバイダーが資格情報をシリアル化できる場合は、その資格情報のタイルを列挙する必要があります。他のタイルを列挙する必要はありません。資格情報プロバイダーは、列挙する資格情報タイルの数を決定するために、ICredentialProvider::SetSerialization および iCredentialProvider::SetUsageScenarioの入力CREDENTIAL_PROVIDER_CREDENTIAL_SERIALIZATIONを使用する必要があります。この値を CREDUIWIN_AUTHPACKAGE_ONLYと組み合わせることはできません。

CREDUIWIN_ENUMERATE_ADMINS (0x00000100)

0x00000100。資格情報プロバイダーは、管理者のみを列挙する必要があります。この値は、UAC のみを目的としています。外部の呼び出し元は、このフラグを設定しないことをお勧めします。

CREDUIWIN_ENUMERATE_CURRENT_USER (0x00000200)

0x00000200。資格情報プロバイダーは、現在ログオンしているユーザーのタイルを列挙する必要があります。

CREDUIWIN_SECURE_PROMPT (0x00001000)

0x00001000。資格情報ダイアログボックスは、セキュリティで保護されたデスクトップに表示されます。この値を CREDUIWIN_GENERICと組み合わせることはできません。資格情報プロバイダーの実装者は、このフラグを無視しても問題ありません。

CREDUIWIN_PACK_32_WOW (0x10000000)

0x10000000。プロバイダーに渡されるバッファーは 32 ビットです。プロバイダーから返されるバッファーも 32 ビットである必要があります。これは WOW64 に必要です。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。そうでない場合は、HRESULT エラーコードを返します。

解説

この方法は必須であり、資格情報プロバイダーが使用方法を示します。

呼び出しが完了したが、要求された使用シナリオがサポートされていない場合、このメソッドは E_NOTIMPL を返す必要があります。メソッドが成功し、使用シナリオがサポートされている場合、このメソッドは S_OK を返す必要があります。

要件


サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	credentialprovider.h