WlanDisconnect 関数 (wlanapi.h)

  • [アーティクル]

WlanDisconnect 関数は、インターフェイスを現在のネットワークから切断します。

構文

DWORD WlanDisconnect(
  [in] HANDLE     hClientHandle,
  [in] const GUID *pInterfaceGuid,
       PVOID      pReserved
);

パラメーター

[in] hClientHandle

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

[in] pInterfaceGuid

切断するインターフェイスの GUID。

pReserved

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

戻り値

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

関数が失敗した場合、戻り値は次のいずれかの戻りコードになる可能性があります。

リターン コード 説明
ERROR_INVALID_PARAMETER
 hClientHandle が NULL または無効、 pInterfaceGuid が NULL、または pReserved が NULL ではありません。
ERROR_INVALID_HANDLE
 ハンドル テーブルにハンドル hClientHandle が見つかりませんでした。
RPC_STATUS
 さまざまなエラー コード。
ERROR_NOT_ENOUGH_MEMORY
 クエリ結果にメモリを割り当てませんでした。
ERROR_ACCESS_DENIED
 呼び出し元に十分なアクセス許可がありません。

解説

WlanConnect を使用して接続が確立されると、pConnectionParameters が指すWLAN_CONNECTION_PARAMETERS構造体の strProfile メンバーによってプロファイルが指定されました。 そのプロファイルがすべてのユーザー プロファイルである場合、 WlanDisconnect 呼び出し元はプロファイルに対する実行アクセス権を持っている必要があります。 それ以外の場合、 WlanDisconnect 呼び出しは戻り値ERROR_ACCESS_DENIEDで失敗します。 すべてのユーザー プロファイルに対するアクセス許可は、 WlanSetProfile または WlanSaveTemporaryProfile を使用してプロファイルが作成または保存されるときに確立されます。

コマンド ラインで切断操作を実行するには、 netsh wlan disconnect コマンドを使用します。 詳細については、「 ワイヤレス ローカル エリア ネットワーク (wlan) の Netsh コマンド」を参照してください。

Windows XP と SP3 とワイヤレス LAN API for Windows XP SP2: WlanDisconnect には、切断されたネットワークに関連付けられているプロファイルを変更する副作用があります。 ネットワーク プロファイルは、 WlanDisconnect 呼び出しの後にオンデマンド プロファイルになります。 ワイヤレス ゼロ構成サービスは、ネットワークが範囲内にある場合、オンデマンド プロファイルを使用してネットワークに自動的に接続しません。 プロファイルをオンデマンド プロファイルに変更する場合を除き、WlanConnect を呼び出す前に WlanDisconnect を呼び出さないでください。 WlanConnect を呼び出してネットワーク接続を確立すると、既存のネットワーク接続はすべて自動的に削除されます。

要件

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

関連項目

WlanConnect