WlanSetProfileEapXmlUserData 関数 (wlanapi.h)
WlanSetProfileEapXmlUserData 関数は、XML 文字列で指定された拡張認証プロトコル (EAP) ユーザー資格情報を設定します。 ユーザー資格情報は、アダプターのプロファイルに適用されます。 これらの資格情報は、呼び出し元のみが使用できます。
構文
DWORD WlanSetProfileEapXmlUserData(
[in] HANDLE hClientHandle,
[in] const GUID *pInterfaceGuid,
[in] LPCWSTR strProfileName,
[in] DWORD dwFlags,
[in] LPCWSTR strEapXmlUserData,
PVOID pReserved
);
パラメーター
[in] hClientHandle
WlanOpenHandle 関数の以前の呼び出しによって取得されたクライアントのセッション ハンドル。
[in] pInterfaceGuid
インターフェイスの GUID。
[in] strProfileName
EAP ユーザー データに関連付けられているプロファイルの名前。 プロファイル名では大文字と小文字が区別されます。 この文字列は NULL で終わる必要があります。
SP3 を使用した Windows XP と、SP2 を使用した Windows XP 用のワイヤレス LAN API: 指定された名前は、ネットワークの SSID から自動的に派生したプロファイル名と一致している必要があります。 インフラストラクチャ ネットワーク プロファイルの場合は、プロファイル名に SSID を指定する必要があります。 アドホック ネットワーク プロファイルの場合、指定された名前はアドホック ネットワークの SSID の後に が -adhoc続く必要があります。
[in] dwFlags
関数の動作を変更するフラグのセット。
Windows XP 用ワイヤレス LAN API SP2、Windows XP SP3、Windows Vista、Windows Server 2008 では、このパラメーターは予約済みであり、ゼロに設定する必要があります。
Windows 7、Windows Server 2008 R2 以降では、このパラメーターには次のいずれかの値を指定できます。
| 値 | 意味 |
|---|---|
|
このプロファイルのすべてのユーザーに対して EAP ホスト データを設定します。 |
[in] strEapXmlUserData
ユーザー資格情報の設定に使用される XML データへのポインター。
XML データは、 EAPHost ユーザー資格情報スキーマに基づいている必要があります。 サンプルのユーザー資格情報 XML データを表示するには、「EAPHost ユーザー プロパティ」を参照してください。
pReserved
将来利用するために予約されています。 NULL に設定する必要があります。
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS です。
関数が失敗した場合、戻り値は次のいずれかのリターン コードになります。
| リターン コード | 説明 |
|---|---|
|
アクセスが拒否されました。 呼び出し元がプロファイルへの書き込みアクセス権を持っていない場合、この値が返されます。 |
|
ネットワーク接続プロファイルが破損しています。 このエラーは、 strProfileName パラメーターで指定されたプロファイルを解析できなかった場合に返されます。 |
|
パラメーターが正しくありません。 この値は、次のいずれかの条件が発生した場合に返されます。
|
|
ハンドルが無効です。 ハンドル テーブルでハンドル hClientHandle が見つからなかった場合、このエラーが返されます。 |
|
このコマンドを処理するのに十分なストレージがありません。 |
|
要求はサポートされていません。
この値は、プロファイル設定でユーザー データの保存が許可されていない場合に返されます。 これは、シングル サインオン (SSO) が有効になっている場合に発生する可能性があります。 Windows 7、Windows Server 2008 R2 以降では、認証に 802.1X 以外のメソッドを使用するプロファイルで WlanSetProfileEapXmlUserData 関数が呼び出された場合、この値が返されます。 |
|
サービスは開始されていません。 この値は、ワイヤレス LAN サービスが実行されていない場合に返されます。 |
|
さまざまなエラー コード。 |
注釈
WlanSetProfileEapXmlUserData 関数は、プロファイルで使用する EAP ユーザー資格情報を設定します。 この関数は、認証に 802.1X を使用するプロファイルでのみ呼び出すことができます。 Windows Vista および Windows Server 2008 では、これらの資格情報は呼び出し元のみが使用できます。
eapType パラメーターは、EAP メソッドに関する型、識別、および作成者情報を含むEAP_METHOD_TYPE構造体です。 EAP_METHOD_TYPE構造体の eapType メンバーは、EAP メソッドの型とベンダー識別情報を含むEAP_TYPE構造体です。
EAP メソッドの種類の割り当ての詳細については、IETF によって公開されている RFC 3748 のセクション 6.2 を参照してください。
Windows 10、Windows Server 2016以降では、WlanSetProfileEapXmlUserData 関数が拡張されています。 dwFlags パラメーターにWLAN_SET_EAPHOST_DATA_ALL_USERSが含まれている場合、プロファイルのすべてのユーザーに対して EAP ユーザー資格情報を設定できます。
すべてのワイヤレス LAN 機能では、プロファイル操作を実行するときに、ワイヤレス インターフェイスのインターフェイス GUID が必要です。 ワイヤレス インターフェイスが削除されると、その状態はワイヤレス LAN サービス (WLANSVC) からクリアされ、プロファイル操作は実行できません。
wlanSetProfileEapXmlUserData 関数は、pInterfaceGuid パラメーターで指定されたワイヤレス インターフェイス (削除された USB ワイヤレス アダプターなど) がシステムから削除された場合、ERROR_INVALID_PARAMETERで失敗する可能性があります。
EAP-TTLS を使用し、64 ビット オペレーティング システム (OS) で実行されている 32 ビット アプリケーションから API が呼び出されると、WlanSetProfileEapXmlUserData によってワイヤレス接続エラーが発生する可能性があります。 アプリケーションは、ターゲット OS と同じ CPU アーキテクチャ用に構築する必要があります。
SP3 を使用した Windows XP と、SP2 を使用した Windows XP 用のワイヤレス LAN API: この関数は、保護された EAP (PEAP) 資格情報にのみ使用できます。 他の EAP の種類には使用できません。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista、WINDOWS XP と SP3 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | wlanapi.h (Wlanapi.h を含む) |
| Library | Wlanapi.lib |
| [DLL] | Wlanapi.dll |
| 再頒布可能パッケージ | Sp2 を使用した Windows XP 用ワイヤレス LAN API |