WlanSetProfileCustomUserData 関数 (wlanapi.h)

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
次のいずれかの条件が発生しました。
  • hClientHandleNULL または無効です。
  • pInterfaceGuidNULL です
  • strProfileNameNULL です
  • pReservedNULL ではありません。
  • dwDataSize は 0 ではなく、 pDataNULL です
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

こちらもご覧ください

WLAN_profile スキーマ

WlanGetProfile

WlanGetProfileCustomUserData

WlanGetProfileList

WlanSetProfile

WlanSetProfileEapUserData

WlanSetProfileEapXmlUserData