RasGetEapUserIdentityA 関数 (ras.h)

[アーティクル]
11/20/2024

RasGetEapUserIdentity 関数は、現在のユーザーの ID 情報を取得します。この情報を使用して、拡張認証プロトコル (EAP) を必要とする電話帳エントリ RasDial を呼び出します。

構文

DWORD RasGetEapUserIdentityA(
  [in]  LPCSTR                pszPhonebook,
  [in]  LPCSTR                pszEntry,
  [in]  DWORD                 dwFlags,
  [in]  HWND                  hwnd,
  [out] LPRASEAPUSERIDENTITYA *ppRasEapUserIdentity
);

パラメーター

[in] pszPhonebook

電話帳 (PBK) ファイルの完全なパスを指定する null終了文字列へのポインター。このパラメーターが NULL場合、関数はシステム電話帳を使用します。

[in] pszEntry

既存のエントリ名を指定する -terminated 文字列null へのポインター。

[in] dwFlags

認証プロセスを修飾する次のフラグを 0 個以上指定します。

旗	意味
RASEAPF_NonInteractive	認証プロトコルがグラフィカルユーザーインターフェイスを起動しないように指定します。このフラグが存在しない場合は、プロトコルでユーザーインターフェイスを表示しても問題ありません。
RASEAPF_Logon	ユーザーデータが WinLogon から取得されることを指定します。
RASEAPF_Preview	ダイヤルする前にユーザーに ID 情報の入力を求めるメッセージを表示するように指定します。

[in] hwnd

UI ダイアログの親ウィンドウへのハンドル。 fInvokeUI パラメーターが FALSE場合、hwnd NULLする必要があります。

[out] ppRasEapUserIdentity

正常に戻った場合に、EAP ユーザー ID 情報を含む RASEAPUSERIDENTITY 構造体のアドレスを受け取るポインターへのポインター。 RasGetEapUserIdentity 、RASEAPUSERIDENTITY 構造体のメモリバッファーを割り当てます。 RasFreeEapUserIdentity呼び出して、このメモリを解放します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS。

関数が失敗した場合、戻り値は次のいずれかのエラーコード、または Routing と Remote Access Error Codes または Winerror.h からの値です。

価値	意味
E_INVALID_ARG	pcbEapUserIdentity パラメーターは NULLです。
ERROR_INTERACTIVE_MODE	RASEAPF_NonInteractive フラグを使用して関数が呼び出されました。ただし、ユーザーから必要な ID 情報を取得するには、認証プロトコルで UI を表示する必要があります。
ERROR_INVALID_FUNCTION_FOR_ENTRY	この電話帳エントリの認証方法が EAP ではないか、認証方法が EAP ですが、プロトコルは標準の Windows NT/Windows 2000 資格情報ダイアログを使用してユーザー ID 情報を取得します。いずれの場合も、呼び出し元は EAP ID 情報を RasDial渡す必要はありません。
ERROR_RASMAN_CANNOT_INITIALIZE	リモートアクセスサービスが正しく初期化できませんでした。
その他の	FormatMessage を使用して、返されたエラーコードに対応するシステムエラーメッセージを取得します。

備考

RasGetEapUserIdentity 、RasGetEapUserData RAS 関数と、RasEapGetIdentityEAP 関数を呼び出します。 RasEapGetIdentity は認証プロトコルによって実装されます。

関数が成功した場合(戻り値がNO_ERROR)、呼び出し元は、ppRasEapUserIdentity パラメーターが指す RASEAPUSERIDENTITY 構造体から RASDIALPARAMS に EAP ID 情報をコピーし、呼び出しで使用される RASDIALEXTENSIONS 構造体 rasDIALをする必要があります。

開発中のリモートアクセスアプリケーションにグラフィカルユーザーインターフェイスがある場合、rasGetEapUserIdentity の呼び出し元 RASEAPF_NonInteractive フラグを指定しないでください。アプリケーションにコマンドラインユーザーインターフェイスがある場合、呼び出し元は、認証プロトコルでグラフィカルユーザーインターフェイスが表示されないように、RASEAPF_NonInteractive フラグを指定できます。

手記

ras.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RasGetEapUserIdentity を定義します。エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	ras.h
ライブラリ	Rasapi32.lib
DLL	Rasapi32.dll

次の方法で共有

RasGetEapUserIdentityA 関数 (ras.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース