EapPeerGetUIContext 関数 (eapmethodpeerapis.h)
EAP メソッドからユーザー インターフェイス コンテキストを取得します。 この関数の後には常に EapPeerInvokeInteractiveUI 関数が続き、その後に EapPeerSetUIContext 関数が続きます。
構文
DWORD EapPeerGetUIContext(
[in] EAP_SESSION_HANDLE sessionHandle,
[out] DWORD *pdwSizeOfUIContextData,
[out] BYTE **ppUIContextData,
[out] EAP_ERROR **ppEapError
);
パラメーター
[in] sessionHandle
EAPHost サーバー上のこの EAP 認証セッションの一意のハンドルを含む EAP_SESSION_HANDLE 構造体へのポインター。 このハンドルは、EapPeerBeginSession の以前の呼び出しで pSessionHandle パラメーターで返されます。
[out] pdwSizeOfUIContextData
ppUIContextData で返されるユーザー インターフェイス コンテキスト データ バイト バッファーのサイズを指定する値へのポインター。
[out] ppUIContextData
EAPHost からのサプリカント ユーザー インターフェイス コンテキスト データを含むバイト バッファーを含むアドレスへのポインター。
[out] ppEapError
この関数呼び出しの実行中に発生したエラーを含む EAP_ERROR 構造体のアドレスへのポインター。 エラー データを使用した後、エラー データへのポインターを EapPeerFreeErrorMemory に渡すことで、このメモリを解放する必要があります。
戻り値
なし
解説
EapPeerGetUIContext は、前の呼び出しでユーザー インターフェイス コンテキストが使用可能であることを示す場合に、EAPHost によって呼び出されます。
この呼び出しは、この API への関数ポインターを使用して、ピア ベースの EAPHost によって実行されます。 この API は、EAPHost によって読み込まれる EAP メソッドに実装する必要があり、ドキュメントで指定されている構文とパラメーターの型に厳密に準拠している必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | eapmethodpeerapis.h |