WlanScan

関数

無線LANインターフェイスで利用可能なネットワークを走査する。

DLLwlanapi.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// wlanapi.dll
#include <windows.h>

DWORD WlanScan(
    HANDLE hClientHandle,
    const GUID* pInterfaceGuid,
    const DOT11_SSID* pDot11Ssid,   // optional
    const WLAN_RAW_DATA* pIeData,   // optional
    void* pReserved   // optional
);

パラメーター

名前	型	方向	説明
hClientHandle	HANDLE	in	クライアントのセッションハンドル。以前に WlanOpenHandle 関数を呼び出して取得します。
pInterfaceGuid	GUID*	in	照会するインターフェイスの GUID。ローカルコンピューターで有効になっている各ワイヤレス LAN インターフェイスの GUID は、WlanEnumInterfaces 関数を使用して調べることができます。
pDot11Ssid	DOT11_SSID*	inoptional	スキャン対象のネットワークの SSID を指定する DOT11_SSID 構造体へのポインター。このパラメーターは NULL でもかまいません。 Windows XP with SP3 および Wireless LAN API for Windows XP with SP2: このパラメーターは NULL でなければなりません。
pIeData	WLAN_RAW_DATA*	inoptional	プローブ要求に含める情報要素へのポインター。このパラメーターは、クライアントプロビジョニングの利用可否情報や 802.1X 認証要件を含めることができる WLAN_RAW_DATA 構造体を指します。Windows XP with SP3 および Wireless LAN API for Windows XP with SP2: このパラメーターは NULL でなければなりません。
pReserved	void*	optional	将来の使用のために予約されています。NULL に設定する必要があります。

戻り値の型: DWORD

公式ドキュメント

指定したインターフェイスで利用可能なネットワークのスキャンを要求します。

戻り値

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

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

リターンコード	説明
ERROR_INVALID_PARAMETER	hClientHandle が NULL または無効である、pInterfaceGuid が NULL である、あるいは pReserved が NULL ではありません。
ERROR_INVALID_HANDLE	ハンドル hClientHandle がハンドルテーブル内に見つかりませんでした。
RPC_STATUS	さまざまなエラーコード。
ERROR_NOT_ENOUGH_MEMORY	照会結果用のメモリの割り当てに失敗しました。

解説(Remarks)

WlanScan 関数は、ネイティブ 802.11 ワイヤレス LAN ドライバーに対して、利用可能なワイヤレスネットワークをスキャンするよう要求します。ドライバーがプローブ要求を送信するか (アクティブスキャン) どうかは、その実装と、pDot11Ssid および pIeData パラメーターに渡された値によって異なります。

pIeData パラメーターが NULL でない場合、ドライバーはスキャン中にプローブ要求を送信します。プローブ要求には、pIeData パラメーターが指す情報要素 (IE) が含まれます。たとえば、WPS 対応のアクセスポイントを検出するために、Wi-Fi Protected Setup (WPS) の IE をプローブ要求に含めることができます。pIeData パラメーターが指すバッファーには、Element ID から始まる完全な IE が格納されている必要があります。

WlanScan 関数に渡す pIeData パラメーターには、近接サービス検出 (PSD) IE のデータエントリを含む省略可能な WLAN_RAW_DATA 構造体へのポインターを指定できます。

PSD IE の格納に使用する場合、Wlanapi.h ヘッダーファイルで定義されている DOT11_PSD_IE_MAX_DATA_SIZE 定数が dwDataSize メンバーの最大値になります。

定数	値	説明
DOT11_PSD_IE_MAX_DATA_SIZE	240	PSD IE データエントリの最大データサイズ (バイト単位)。

PSD IE の形式の説明を含む PSD IE の詳細については、WlanSetPsdIEDataList 関数を参照してください。

WlanScan 関数が呼び出されると、ネイティブ 802.11 ワイヤレス LAN ドライバーは、スキャンを開始する前に現在の利用可能なワイヤレスネットワークの一覧を消去することがあります。WlanScan 関数を呼び出すと、以前のスキャンによって WlanGetNetworkBssList 関数や WlanGetAvailableNetworkList 関数が返していた既存の利用可能なワイヤレスネットワークの一覧に追加される、とアプリケーションが想定してはなりません。

WlanScan 関数はすぐに戻ります。ネットワークスキャンの完了時に通知を受け取るには、Windows Vista 以降のクライアントは WlanRegisterNotification を呼び出して通知を登録する必要があります。WlanRegisterNotification 関数に渡す dwNotifSource パラメーターには、自動構成モジュールが生成する通知を登録するために WLAN_NOTIFICATION_SOURCE_ACM ビットを設定する必要があります。Windows ロゴ要件を満たすワイヤレスネットワークドライバーは、WlanScan 関数の要求を 4 秒以内に完了することが求められます。

Wireless LAN Service は、利用可能なワイヤレスネットワークが変化しても通知を送信しません。また、複数回のスキャンにまたがって利用可能なネットワークの一覧の変化を追跡することもありません。現在の既定の動作では、Wireless LAN Service はワイヤレスインターフェイスのドライバーに対して 60 秒ごとにしかワイヤレスネットワークのスキャンを要求せず、場合によっては (既にワイヤレスネットワークに接続しているとき) スキャンをまったく要求しません。 WlanScan 関数は、アプリケーションがワイヤレスネットワークの変化を追跡するために使用できます。アプリケーションはまず WLAN_NOTIFICATION_SOURCE_ACM の通知を登録します。次に WlanScan 関数を呼び出してスキャンを開始します。その後、wlan_notification_acm_scan_complete 通知を受け取るまで待機するか、4 秒後にタイムアウトします。続いて、WlanGetNetworkBssList 関数または WlanGetAvailableNetworkList 関数を呼び出して、利用可能なワイヤレスネットワークの一覧を取得できます。この処理を定期的に繰り返すことで、アプリケーションは利用可能なワイヤレスネットワークの変化を追跡できます。

Windows XP with SP3 または Wireless LAN API for Windows XP with SP2 では、WlanScan 関数はすぐに戻り、スキャンの完了時に通知を行いません。

スキャンの実行中はワイヤレスインターフェイスがデータパケットを送受信しにくくなるため、WlanScan 関数はネットワークスキャンが完了するまで待ち時間を増加させる可能性があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// wlanapi.dll
#include <windows.h>

DWORD WlanScan(
    HANDLE hClientHandle,
    const GUID* pInterfaceGuid,
    const DOT11_SSID* pDot11Ssid,   // optional
    const WLAN_RAW_DATA* pIeData,   // optional
    void* pReserved   // optional
);

[DllImport("wlanapi.dll", ExactSpelling = true)]
static extern uint WlanScan(
    IntPtr hClientHandle,   // HANDLE
    ref Guid pInterfaceGuid,   // GUID*
    IntPtr pDot11Ssid,   // DOT11_SSID* optional
    IntPtr pIeData,   // WLAN_RAW_DATA* optional
    IntPtr pReserved   // void* optional
);

<DllImport("wlanapi.dll", ExactSpelling:=True)>
Public Shared Function WlanScan(
    hClientHandle As IntPtr,   ' HANDLE
    ByRef pInterfaceGuid As Guid,   ' GUID*
    pDot11Ssid As IntPtr,   ' DOT11_SSID* optional
    pIeData As IntPtr,   ' WLAN_RAW_DATA* optional
    pReserved As IntPtr   ' void* optional
) As UInteger
End Function

' hClientHandle : HANDLE
' pInterfaceGuid : GUID*
' pDot11Ssid : DOT11_SSID* optional
' pIeData : WLAN_RAW_DATA* optional
' pReserved : void* optional
Declare PtrSafe Function WlanScan Lib "wlanapi" ( _
    ByVal hClientHandle As LongPtr, _
    ByVal pInterfaceGuid As LongPtr, _
    ByVal pDot11Ssid As LongPtr, _
    ByVal pIeData As LongPtr, _
    ByVal pReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WlanScan = ctypes.windll.wlanapi.WlanScan
WlanScan.restype = wintypes.DWORD
WlanScan.argtypes = [
    wintypes.HANDLE,  # hClientHandle : HANDLE
    ctypes.c_void_p,  # pInterfaceGuid : GUID*
    ctypes.c_void_p,  # pDot11Ssid : DOT11_SSID* optional
    ctypes.c_void_p,  # pIeData : WLAN_RAW_DATA* optional
    ctypes.POINTER(None),  # pReserved : void* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wlanapi.dll')
WlanScan = Fiddle::Function.new(
  lib['WlanScan'],
  [
    Fiddle::TYPE_VOIDP,  # hClientHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # pInterfaceGuid : GUID*
    Fiddle::TYPE_VOIDP,  # pDot11Ssid : DOT11_SSID* optional
    Fiddle::TYPE_VOIDP,  # pIeData : WLAN_RAW_DATA* optional
    Fiddle::TYPE_VOIDP,  # pReserved : void* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "wlanapi")]
extern "system" {
    fn WlanScan(
        hClientHandle: *mut core::ffi::c_void,  // HANDLE
        pInterfaceGuid: *const GUID,  // GUID*
        pDot11Ssid: *const DOT11_SSID,  // DOT11_SSID* optional
        pIeData: *const WLAN_RAW_DATA,  // WLAN_RAW_DATA* optional
        pReserved: *mut ()  // void* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("wlanapi.dll")]
public static extern uint WlanScan(IntPtr hClientHandle, ref Guid pInterfaceGuid, IntPtr pDot11Ssid, IntPtr pIeData, IntPtr pReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wlanapi_WlanScan' -Namespace Win32 -PassThru
# $api::WlanScan(hClientHandle, pInterfaceGuid, pDot11Ssid, pIeData, pReserved)

#uselib "wlanapi.dll"
#func global WlanScan "WlanScan" sptr, sptr, sptr, sptr, sptr
; WlanScan hClientHandle, varptr(pInterfaceGuid), varptr(pDot11Ssid), varptr(pIeData), pReserved   ; 戻り値は stat
; hClientHandle : HANDLE -> "sptr"
; pInterfaceGuid : GUID* -> "sptr"
; pDot11Ssid : DOT11_SSID* optional -> "sptr"
; pIeData : WLAN_RAW_DATA* optional -> "sptr"
; pReserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "wlanapi.dll"
#cfunc global WlanScan "WlanScan" sptr, var, var, var, sptr
; res = WlanScan(hClientHandle, pInterfaceGuid, pDot11Ssid, pIeData, pReserved)
; hClientHandle : HANDLE -> "sptr"
; pInterfaceGuid : GUID* -> "var"
; pDot11Ssid : DOT11_SSID* optional -> "var"
; pIeData : WLAN_RAW_DATA* optional -> "var"
; pReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "wlanapi.dll"
#cfunc global WlanScan "WlanScan" sptr, sptr, sptr, sptr, sptr
; res = WlanScan(hClientHandle, varptr(pInterfaceGuid), varptr(pDot11Ssid), varptr(pIeData), pReserved)
; hClientHandle : HANDLE -> "sptr"
; pInterfaceGuid : GUID* -> "sptr"
; pDot11Ssid : DOT11_SSID* optional -> "sptr"
; pIeData : WLAN_RAW_DATA* optional -> "sptr"
; pReserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。