WlanSetProfileList 関数 (wlanapi.h)

  • [アーティクル]

WlanSetProfileList 関数は、特定のインターフェイスのプロファイルの優先順位を設定します。

構文

DWORD WlanSetProfileList(
  [in] HANDLE     hClientHandle,
  [in] const GUID *pInterfaceGuid,
  [in] DWORD      dwItems,
  [in] LPCWSTR    *strProfileNames,
       PVOID      pReserved
);

パラメーター

[in] hClientHandle

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

[in] pInterfaceGuid

インターフェイスの GUID。

[in] dwItems

strProfileNames パラメーター内のプロファイルの数。

[in] strProfileNames

プロファイルの名前を目的の順序で指定します。 プロファイル名では大文字と小文字が区別されます。 この文字列は NULL で終わる必要があります。

SP3 を使用した Windows XP と、SP2 を使用した Windows XP 用のワイヤレス LAN API: 指定された名前は、ネットワークの SSID から自動的に派生したプロファイル名と一致する必要があります。 インフラストラクチャ ネットワーク プロファイルの場合は、プロファイル名に SSID を指定する必要があります。 アドホック ネットワーク プロファイルの場合、指定された名前はアドホック ネットワークの SSID の後に が -adhoc続く必要があります。

pReserved

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

戻り値

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

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

リターン コード 説明
ERROR_ACCESS_DENIED
 呼び出し元には、プロファイル リストを変更するための十分なアクセス許可がありません。

WlanSetProfileList は、プロファイル リスト内の全ユーザー プロファイルの相対順序を変更する操作を実行するか、プロファイル リスト内の下位の位置にすべてのユーザー プロファイルを移動する操作を実行する前に、WlanSetProfileList は、wlan_secure_all_user_profiles_order オブジェクトと共に格納されている随意アクセス制御リスト (DACL) を取得します。 DACL に、呼び出し元スレッドのアクセス トークンWLAN_WRITE_ACCESSアクセス許可を付与するアクセス制御エントリ (ACE) が含まれていない場合、 WlanSetProfileList は ERROR_ACCESS_DENIEDを返します。
ERROR_INVALID_HANDLE
 ハンドル テーブルにハンドル hClientHandle が見つかりませんでした。
ERROR_INVALID_PARAMETER
 次のいずれかの条件が発生しました。
  • hClientHandle が NULL または無効です。
  • pInterfaceGuid は NULL です。
  • dwItems は 0 です。
  • strProfileNames は NULL です。
  • strProfileNames に同じプロファイル名が複数回表示されます。
  • pReserved が NULL ではありません。
ERROR_NOT_FOUND
 strProfileNames には、 プロファイル ストアに存在しないプロファイルの名前が含まれています。
RPC_STATUS
 さまざまなエラー コード。

注釈

WlanSetProfileList 関数は、特定のワイヤレス インターフェイスのワイヤレス LAN プロファイルの優先順位を設定します。

リスト内のプロファイルは、 WlanGetProfileList 関数によって返される現在のプロファイルと一致する必要があります。 グループ ポリシー プロファイルの位置を変更することはできません。

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

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

要件

要件 値
サポートされている最小のクライアント Windows Vista、WINDOWS XP と SP3 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー wlanapi.h (Wlanapi.h を含む)
Library Wlanapi.lib
[DLL] Wlanapi.dll
再頒布可能パッケージ Sp2 を使用した Windows XP 用ワイヤレス LAN API

こちらもご覧ください

WlanGetProfile

WlanGetProfileList

WlanSetProfile