Win32 API 日本語リファレンス
ホーム › NetworkManagement.WiFi › WlanScan

WlanScan

関数
無線LANインターフェイスで利用可能なネットワークを走査する。
DLLwlanapi.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// 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
);

パラメーター

名前型方向説明
hClientHandleHANDLEinWLANクライアントハンドル。
pInterfaceGuidGUID*inスキャンを実行する無線インターフェイスのGUIDポインタ。
pDot11SsidDOT11_SSID*inoptionalスキャン対象を絞るSSID(DOT11_SSID)ポインタ。全ネットワーク対象ならNULL。
pIeDataWLAN_RAW_DATA*inoptionalプローブ要求に付加する情報要素(WLAN_RAW_DATA)ポインタ。不要ならNULL。
pReservedvoid*optional予約済み。NULLを指定する。

戻り値の型: DWORD

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数: 
; DWORD WlanScan(HANDLE hClientHandle, GUID* pInterfaceGuid, DOT11_SSID* pDot11Ssid, WLAN_RAW_DATA* pIeData, void* pReserved)
#uselib "wlanapi.dll"
#cfunc global WlanScan "WlanScan" intptr, var, var, var, intptr
; res = WlanScan(hClientHandle, pInterfaceGuid, pDot11Ssid, pIeData, pReserved)
; hClientHandle : HANDLE -> "intptr"
; pInterfaceGuid : GUID* -> "var"
; pDot11Ssid : DOT11_SSID* optional -> "var"
; pIeData : WLAN_RAW_DATA* optional -> "var"
; pReserved : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wlanapi = windows.NewLazySystemDLL("wlanapi.dll")
	procWlanScan = wlanapi.NewProc("WlanScan")
)

// hClientHandle (HANDLE), pInterfaceGuid (GUID*), pDot11Ssid (DOT11_SSID* optional), pIeData (WLAN_RAW_DATA* optional), pReserved (void* optional)
r1, _, err := procWlanScan.Call(
	uintptr(hClientHandle),
	uintptr(pInterfaceGuid),
	uintptr(pDot11Ssid),
	uintptr(pIeData),
	uintptr(pReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function WlanScan(
  hClientHandle: THandle;   // HANDLE
  pInterfaceGuid: PGUID;   // GUID*
  pDot11Ssid: Pointer;   // DOT11_SSID* optional
  pIeData: Pointer;   // WLAN_RAW_DATA* optional
  pReserved: Pointer   // void* optional
): DWORD; stdcall;
  external 'wlanapi.dll' name 'WlanScan';
result := DllCall("wlanapi\WlanScan"
    , "Ptr", hClientHandle   ; HANDLE
    , "Ptr", pInterfaceGuid   ; GUID*
    , "Ptr", pDot11Ssid   ; DOT11_SSID* optional
    , "Ptr", pIeData   ; WLAN_RAW_DATA* optional
    , "Ptr", pReserved   ; void* optional
    , "UInt")   ; return: DWORD
●WlanScan(hClientHandle, pInterfaceGuid, pDot11Ssid, pIeData, pReserved) = DLL("wlanapi.dll", "dword WlanScan(void*, void*, void*, void*, void*)")
# 呼び出し: WlanScan(hClientHandle, pInterfaceGuid, pDot11Ssid, pIeData, pReserved)
# hClientHandle : HANDLE -> "void*"
# pInterfaceGuid : GUID* -> "void*"
# pDot11Ssid : DOT11_SSID* optional -> "void*"
# pIeData : WLAN_RAW_DATA* optional -> "void*"
# pReserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wlanapi" fn WlanScan(
    hClientHandle: ?*anyopaque, // HANDLE
    pInterfaceGuid: [*c]GUID, // GUID*
    pDot11Ssid: [*c]DOT11_SSID, // DOT11_SSID* optional
    pIeData: [*c]WLAN_RAW_DATA, // WLAN_RAW_DATA* optional
    pReserved: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) u32;
proc WlanScan(
    hClientHandle: pointer,  # HANDLE
    pInterfaceGuid: ptr GUID,  # GUID*
    pDot11Ssid: ptr DOT11_SSID,  # DOT11_SSID* optional
    pIeData: ptr WLAN_RAW_DATA,  # WLAN_RAW_DATA* optional
    pReserved: pointer  # void* optional
): uint32 {.importc: "WlanScan", stdcall, dynlib: "wlanapi.dll".}
pragma(lib, "wlanapi");
extern(Windows)
uint WlanScan(
    void* hClientHandle,   // HANDLE
    GUID* pInterfaceGuid,   // GUID*
    DOT11_SSID* pDot11Ssid,   // DOT11_SSID* optional
    WLAN_RAW_DATA* pIeData,   // WLAN_RAW_DATA* optional
    void* pReserved   // void* optional
);
ccall((:WlanScan, "wlanapi.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{GUID}, Ptr{DOT11_SSID}, Ptr{WLAN_RAW_DATA}, Ptr{Cvoid}),
      hClientHandle, pInterfaceGuid, pDot11Ssid, pIeData, pReserved)
# hClientHandle : HANDLE -> Ptr{Cvoid}
# pInterfaceGuid : GUID* -> Ptr{GUID}
# pDot11Ssid : DOT11_SSID* optional -> Ptr{DOT11_SSID}
# pIeData : WLAN_RAW_DATA* optional -> Ptr{WLAN_RAW_DATA}
# pReserved : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WlanScan(
    void* hClientHandle,
    void* pInterfaceGuid,
    void* pDot11Ssid,
    void* pIeData,
    void* pReserved);
]]
local wlanapi = ffi.load("wlanapi")
-- wlanapi.WlanScan(hClientHandle, pInterfaceGuid, pDot11Ssid, pIeData, pReserved)
-- hClientHandle : HANDLE
-- pInterfaceGuid : GUID*
-- pDot11Ssid : DOT11_SSID* optional
-- pIeData : WLAN_RAW_DATA* optional
-- pReserved : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wlanapi.dll');
const WlanScan = lib.func('__stdcall', 'WlanScan', 'uint32_t', ['void *', 'void *', 'void *', 'void *', 'void *']);
// WlanScan(hClientHandle, pInterfaceGuid, pDot11Ssid, pIeData, pReserved)
// hClientHandle : HANDLE -> 'void *'
// pInterfaceGuid : GUID* -> 'void *'
// pDot11Ssid : DOT11_SSID* optional -> 'void *'
// pIeData : WLAN_RAW_DATA* optional -> 'void *'
// pReserved : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wlanapi.dll", {
  WlanScan: { parameters: ["pointer", "pointer", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.WlanScan(hClientHandle, pInterfaceGuid, pDot11Ssid, pIeData, pReserved)
// hClientHandle : HANDLE -> "pointer"
// pInterfaceGuid : GUID* -> "pointer"
// pDot11Ssid : DOT11_SSID* optional -> "pointer"
// pIeData : WLAN_RAW_DATA* optional -> "pointer"
// pReserved : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WlanScan(
    void* hClientHandle,
    void* pInterfaceGuid,
    void* pDot11Ssid,
    void* pIeData,
    void* pReserved);
C, "wlanapi.dll");
// $ffi->WlanScan(hClientHandle, pInterfaceGuid, pDot11Ssid, pIeData, pReserved);
// hClientHandle : HANDLE
// pInterfaceGuid : GUID*
// pDot11Ssid : DOT11_SSID* optional
// pIeData : WLAN_RAW_DATA* optional
// pReserved : void* optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wlanapi extends StdCallLibrary {
    Wlanapi INSTANCE = Native.load("wlanapi", Wlanapi.class);
    int WlanScan(
        Pointer hClientHandle,   // HANDLE
        Pointer pInterfaceGuid,   // GUID*
        Pointer pDot11Ssid,   // DOT11_SSID* optional
        Pointer pIeData,   // WLAN_RAW_DATA* optional
        Pointer pReserved   // void* optional
    );
}
@[Link("wlanapi")]
lib Libwlanapi
  fun WlanScan = WlanScan(
    hClientHandle : Void*,   # HANDLE
    pInterfaceGuid : GUID*,   # GUID*
    pDot11Ssid : DOT11_SSID*,   # DOT11_SSID* optional
    pIeData : WLAN_RAW_DATA*,   # WLAN_RAW_DATA* optional
    pReserved : Void*   # void* optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WlanScanNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef WlanScanDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final WlanScan = DynamicLibrary.open('wlanapi.dll')
    .lookupFunction<WlanScanNative, WlanScanDart>('WlanScan');
// hClientHandle : HANDLE -> Pointer<Void>
// pInterfaceGuid : GUID* -> Pointer<Void>
// pDot11Ssid : DOT11_SSID* optional -> Pointer<Void>
// pIeData : WLAN_RAW_DATA* optional -> Pointer<Void>
// pReserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WlanScan(
  hClientHandle: THandle;   // HANDLE
  pInterfaceGuid: PGUID;   // GUID*
  pDot11Ssid: Pointer;   // DOT11_SSID* optional
  pIeData: Pointer;   // WLAN_RAW_DATA* optional
  pReserved: Pointer   // void* optional
): DWORD; stdcall;
  external 'wlanapi.dll' name 'WlanScan';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WlanScan"
  c_WlanScan :: Ptr () -> Ptr () -> Ptr () -> Ptr () -> Ptr () -> IO Word32
-- hClientHandle : HANDLE -> Ptr ()
-- pInterfaceGuid : GUID* -> Ptr ()
-- pDot11Ssid : DOT11_SSID* optional -> Ptr ()
-- pIeData : WLAN_RAW_DATA* optional -> Ptr ()
-- pReserved : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wlanscan =
  foreign "WlanScan"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* hClientHandle : HANDLE -> (ptr void) *)
(* pInterfaceGuid : GUID* -> (ptr void) *)
(* pDot11Ssid : DOT11_SSID* optional -> (ptr void) *)
(* pIeData : WLAN_RAW_DATA* optional -> (ptr void) *)
(* pReserved : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wlanapi (t "wlanapi.dll"))
(cffi:use-foreign-library wlanapi)

(cffi:defcfun ("WlanScan" wlan-scan :convention :stdcall) :uint32
  (h-client-handle :pointer)   ; HANDLE
  (p-interface-guid :pointer)   ; GUID*
  (p-dot11-ssid :pointer)   ; DOT11_SSID* optional
  (p-ie-data :pointer)   ; WLAN_RAW_DATA* optional
  (p-reserved :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WlanScan = Win32::API::More->new('wlanapi',
    'DWORD WlanScan(HANDLE hClientHandle, LPVOID pInterfaceGuid, LPVOID pDot11Ssid, LPVOID pIeData, LPVOID pReserved)');
# my $ret = $WlanScan->Call($hClientHandle, $pInterfaceGuid, $pDot11Ssid, $pIeData, $pReserved);
# hClientHandle : HANDLE -> HANDLE
# pInterfaceGuid : GUID* -> LPVOID
# pDot11Ssid : DOT11_SSID* optional -> LPVOID
# pIeData : WLAN_RAW_DATA* optional -> LPVOID
# pReserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型