WlanSetProfileEapUserData 関数 (wlanapi.h)

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

WlanSetProfileEapUserData 関数は、未加工の EAP データで指定された拡張認証プロトコル (EAP) ユーザー資格情報を設定します。ユーザー資格情報は、インターフェイス上のプロファイルに適用されます。

構文

DWORD WlanSetProfileEapUserData(
  [in] HANDLE          hClientHandle,
  [in] const GUID      *pInterfaceGuid,
  [in] LPCWSTR         strProfileName,
  [in] EAP_METHOD_TYPE eapType,
  [in] DWORD           dwFlags,
  [in] DWORD           dwEapUserDataSize,
  [in] const LPBYTE    pbEapUserData,
       PVOID           pReserved
);

パラメーター

[in] hClientHandle

WlanOpenHandle 関数の以前の呼び出しによって取得されたクライアントのセッションハンドル。

[in] pInterfaceGuid

インターフェイスの GUID。

[in] strProfileName

EAP ユーザーデータに関連付けられているプロファイルの名前。プロファイル名では大文字と小文字が区別されます。この文字列は NULL で終わる必要があります。

[in] eapType

呼び出し元が EAP ユーザー資格情報を指定するメソッドを含む EAP_METHOD_TYPE 構造体。

[in] dwFlags

関数の動作を変更するフラグのセット。

Windows Vista および Windows Server 2008 では、このパラメーターは予約済みであり、0 に設定する必要があります。

Windows 7、Windows Server 2008 R2 以降では、このパラメーターには次のいずれかの値を指定できます。

値	意味
WLAN_SET_EAPHOST_DATA_ALL_USERS 0x00000001	このプロファイルのすべてのユーザーに対して EAP ホストデータを設定します。

[in] dwEapUserDataSize

pbEapUserData が指すデータのサイズ (バイト単位)。

[in] pbEapUserData

ユーザー資格情報の設定に使用される生 EAP データへのポインター。

Windows Vista および Windows Server 2008 では、このパラメーターを NULL にすることはできません。

Windows 7、Windows Server 2008 R2 以降では、dwFlags パラメーターにWLAN_SET_EAPHOST_DATA_ALL_USERSが含まれており、dwEapUserDataSize パラメーターが 0 の場合、このパラメーターを NULL に設定して、このプロファイルに格納されている資格情報を削除できます。

pReserved

将来利用するために予約されています。 NULL に設定する必要があります。

戻り値

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

関数が失敗した場合、戻り値は次のいずれかのリターンコードになります。

リターンコード	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。呼び出し元がプロファイルへの書き込みアクセス権を持っていない場合、この値が返されます。
ERROR_INVALID_PARAMETER	パラメーターが正しくありません。この値は、次のいずれかの条件が発生した場合に返されます。 hClientHandle が NULL です。 pInterfaceGuid は NULL です。 strProfileName が NULL です pvReserved が NULL ではありません。 Windows Vista および Windows Server 2008 では、 pbEapUserData パラメーターが NULL の場合、この値が返されます。 Windows 7、Windows Server 2008 R2 以降では、 pbEapUserData パラメーターが NULL ですが、 dwEapUserDataSize パラメーターが 0 ではないか、 dwFlags パラメーターに WLAN_SET_EAPHOST_DATA_ALL_USERSが含まれていない場合、このエラーが返されます。
ERROR_INVALID_HANDLE	ハンドルが無効です。ハンドルテーブルでハンドル hClientHandle が見つからなかった場合、このエラーが返されます。
ERROR_NOT_ENOUGH_MEMORY	このコマンドを処理するのに十分なストレージがありません。
ERROR_NOT_SUPPORTED	要求はサポートされていません。この値は、プロファイル設定でユーザーデータの保存が許可されていない場合に返されます。これは、シングルサインオン (SSO) が有効になっている場合、または要求がこのプロファイルの格納されている資格情報を削除した場合 ( pbEapUserData パラメーターが NULL、 dwFlags パラメーターに WLAN_SET_EAPHOST_DATA_ALL_USERSが含まれ、 dwEapUserDataSize パラメーターが 0 である) 場合に発生する可能性があります。 Windows 10、Windows Server 2016 以降では、認証に 802.1X 以外のメソッドを使用するプロファイルで WlanSetProfileEapUserData 関数が呼び出された場合、この値が返されます。この値は、この関数が SP3 の Windows XP または SP2 クライアントを使用した Windows XP 用ワイヤレス LAN API から呼び出された場合にも返されます。
ERROR_SERVICE_NOT_ACTIVE	サービスは開始されていません。この値は、ワイヤレス LAN サービスが実行されていない場合に返されます。
RPC_STATUS	さまざまなエラーコード。

注釈

WlanSetProfileEapUserData 関数は、プロファイルで使用する EAP ユーザー資格情報を設定します。 Windows Vista および Windows Server 2008 では、これらの資格情報は呼び出し元のみが使用できます。

eapType パラメーターは、EAP メソッドに関する型、識別、および作成者情報を含むEAP_METHOD_TYPE構造体です。 EAP_METHOD_TYPE構造体の eapType メンバーは、EAP メソッドの型とベンダー識別情報を含むEAP_TYPE構造体です。

EAP メソッドの種類の割り当ての詳細については、IETF によって公開されている RFC 3748 のセクション 6.2 を参照してください。

Windows 7、Windows Server 2008 R2 以降では、 WlanSetProfileEapUserData 関数が強化されています。 dwFlags パラメーターにWLAN_SET_EAPHOST_DATA_ALL_USERSが含まれている場合、プロファイルのすべてのユーザーに対して EAP ユーザー資格情報を設定できます。プロファイルの EAP ユーザー資格情報も削除できます。プロファイルの EAP ユーザー資格情報を削除するには、 pbEapUserData パラメーターが NULL、 dwFlags パラメーター が WLAN_SET_EAPHOST_DATA_ALL_USERS、 dwEapUserDataSize パラメーターが 0 である必要があります。

すべてのワイヤレス LAN 機能では、プロファイル操作を実行するときに、ワイヤレスインターフェイスのインターフェイス GUID が必要です。ワイヤレスインターフェイスが削除されると、その状態はワイヤレス LAN サービス (WLANSVC) からクリアされ、プロファイル操作は実行できません。

wlanSetProfileEapUserData 関数は、pInterfaceGuid パラメーターで指定されたワイヤレスインターフェイスがシステムから削除された場合 (削除された USB ワイヤレスアダプターなど)、ERROR_INVALID_PARAMETERで失敗する可能性があります。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	wlanapi.h (Wlanapi.h を含む)
Library	Wlanapi.lib
[DLL]	Wlanapi.dll