WlanSetProfileCustomUserData 関数 (wlanapi.h)

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

WlanSetProfileCustomUserData 関数は、プロファイルに関連付けられているカスタムユーザーデータを設定します。

構文

DWORD WlanSetProfileCustomUserData(
  [in] HANDLE      hClientHandle,
  [in] const GUID  *pInterfaceGuid,
  [in] LPCWSTR     strProfileName,
  [in] DWORD       dwDataSize,
  [in] const PBYTE pData,
       PVOID       pReserved
);

パラメーター

[in] hClientHandle

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

[in] pInterfaceGuid

インターフェイスの GUID。

[in] strProfileName

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

[in] dwDataSize

pData のサイズ (バイト単位)。

[in] pData

設定するユーザーデータへのポインター。

pReserved

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

戻り値

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

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

リターンコード	説明
ERROR_INVALID_PARAMETER	次のいずれかの条件が発生しました。 hClientHandle が NULL または無効です。 pInterfaceGuid は NULL です。 strProfileName が NULL です。 pReserved が NULL ではありません。 dwDataSize は 0 ではなく、 pData は NULL です。
ERROR_INVALID_HANDLE	ハンドルテーブルにハンドル hClientHandle が見つかりませんでした。
ERROR_NOT_SUPPORTED	この関数は、サポートされていないプラットフォームから呼び出されました。この値は、SP3 の Windows XP または SP2 クライアントを使用した Windows XP 用ワイヤレス LAN API からこの関数が呼び出された場合に返されます。
RPC_STATUS	さまざまなエラーコード。

注釈

Native Wifi AutoConfig サービスで使用されるすべてのワイヤレス WLAN プロファイルについて、Windows ではカスタムユーザーデータの概念が維持されます。このカスタムユーザーデータは、最初は存在しないが、 WlanSetProfileCustomUserData 関数を呼び出すことによって設定できます。カスタムユーザーデータは、WlanSetProfile 関数を呼び出すことによってプロファイルが変更されるたびに空にリセットされます。

カスタムユーザーデータが設定されたら、 WlanGetProfileCustomUserData 関数を使用してこのデータにアクセスできます。

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

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

要件

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