RasGetCustomAuthDataA 関数 (ras.h)

  • [アーティクル]

RasGetCustomAuthData 関数を使用して、接続固有の認証情報を取得します。 この情報は、特定のユーザーに固有の情報ではありません。

構文

DWORD RasGetCustomAuthDataA(
  [in]      LPCSTR pszPhonebook,
  [in]      LPCSTR pszEntry,
  [out]     BYTE   *pbCustomAuthData,
  [in, out] DWORD  *pdwSizeofCustomAuthData
);

パラメーター

[in] pszPhonebook

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

[in] pszEntry

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

[out] pbCustomAuthData

認証データを受信するバッファーへのポインター。 呼び出し元は、このバッファーのメモリを割り当てる必要があります。 バッファーのサイズが十分でない場合、 RasGetCustomAuthData はERROR_BUFFER_TOO_SMALLを返し、 pdwSizeofEapData パラメーターには必要なサイズが含まれます。

[in, out] pdwSizeofCustomAuthData

入力時に pbCustomAuthData パラメーターが指すバッファーのサイズを指定する DWORD 変数へのポインター。

pbCustomAuthData パラメーターで指定されたバッファーの大きさが十分でない場合、pdwSizeofEapData は出力時に必要なサイズを受け取ります。

戻り値

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

関数が失敗した場合、戻り値は次のいずれかのエラー コードか、 ルーティングおよびリモート アクセス エラー コード または Winerror.h からの値です。

値 意味
E_INVALIDARG
 pdwSizeofCustomAuthData パラメーターは NULL です。
ERROR_BUFFER_TOO_SMALL
 pbCustomAuthData が指すバッファーが小さすぎてデータを受信できません。 pdwSizeofCustomAuthData には、必要なサイズが含まれています。
ERROR_CANNOT_OPEN_PHONEBOOK

RasGetEapUserData は、指定された電話帳ファイルを開くことができませんでした。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY

RasGetEapUserData が電話帳で指定されたエントリを見つけることができませんでした。
その他
 FormatMessage を使用して、返されるエラー コードに対応するシステム エラー メッセージを取得します。

注釈

注意

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

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー ras.h
Library Rasapi32.lib
[DLL] Rasapi32.dll

こちらもご覧ください

RasGetEapUserData

RasSetCustomAuthData