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

WlanGetFilterList

関数
設定済みの無線LANネットワークのフィルタ一覧を取得する。
DLLwlanapi.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD WlanGetFilterList(
    HANDLE hClientHandle,
    WLAN_FILTER_LIST_TYPE wlanFilterListType,
    void* pReserved,   // optional
    DOT11_NETWORK_LIST** ppNetworkList
);

パラメーター

名前型方向説明
hClientHandleHANDLEinWlanOpenHandleで取得したクライアントセッションのハンドル。
wlanFilterListTypeWLAN_FILTER_LIST_TYPEin取得するフィルターの種別。許可リストかブロックリストかを示す。
pReservedvoid*optional予約領域。NULLを指定する必要がある。
ppNetworkListDOT11_NETWORK_LIST**out取得したネットワーク一覧を受け取るポインター。WlanFreeMemoryで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD WlanGetFilterList(
    HANDLE hClientHandle,
    WLAN_FILTER_LIST_TYPE wlanFilterListType,
    void* pReserved,   // optional
    DOT11_NETWORK_LIST** ppNetworkList
);
[DllImport("wlanapi.dll", ExactSpelling = true)]
static extern uint WlanGetFilterList(
    IntPtr hClientHandle,   // HANDLE
    int wlanFilterListType,   // WLAN_FILTER_LIST_TYPE
    IntPtr pReserved,   // void* optional
    IntPtr ppNetworkList   // DOT11_NETWORK_LIST** out
);
<DllImport("wlanapi.dll", ExactSpelling:=True)>
Public Shared Function WlanGetFilterList(
    hClientHandle As IntPtr,   ' HANDLE
    wlanFilterListType As Integer,   ' WLAN_FILTER_LIST_TYPE
    pReserved As IntPtr,   ' void* optional
    ppNetworkList As IntPtr   ' DOT11_NETWORK_LIST** out
) As UInteger
End Function
' hClientHandle : HANDLE
' wlanFilterListType : WLAN_FILTER_LIST_TYPE
' pReserved : void* optional
' ppNetworkList : DOT11_NETWORK_LIST** out
Declare PtrSafe Function WlanGetFilterList Lib "wlanapi" ( _
    ByVal hClientHandle As LongPtr, _
    ByVal wlanFilterListType As Long, _
    ByVal pReserved As LongPtr, _
    ByVal ppNetworkList As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WlanGetFilterList = ctypes.windll.wlanapi.WlanGetFilterList
WlanGetFilterList.restype = wintypes.DWORD
WlanGetFilterList.argtypes = [
    wintypes.HANDLE,  # hClientHandle : HANDLE
    ctypes.c_int,  # wlanFilterListType : WLAN_FILTER_LIST_TYPE
    ctypes.POINTER(None),  # pReserved : void* optional
    ctypes.c_void_p,  # ppNetworkList : DOT11_NETWORK_LIST** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wlanapi.dll')
WlanGetFilterList = Fiddle::Function.new(
  lib['WlanGetFilterList'],
  [
    Fiddle::TYPE_VOIDP,  # hClientHandle : HANDLE
    Fiddle::TYPE_INT,  # wlanFilterListType : WLAN_FILTER_LIST_TYPE
    Fiddle::TYPE_VOIDP,  # pReserved : void* optional
    Fiddle::TYPE_VOIDP,  # ppNetworkList : DOT11_NETWORK_LIST** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wlanapi")]
extern "system" {
    fn WlanGetFilterList(
        hClientHandle: *mut core::ffi::c_void,  // HANDLE
        wlanFilterListType: i32,  // WLAN_FILTER_LIST_TYPE
        pReserved: *mut (),  // void* optional
        ppNetworkList: *mut *mut DOT11_NETWORK_LIST  // DOT11_NETWORK_LIST** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wlanapi.dll")]
public static extern uint WlanGetFilterList(IntPtr hClientHandle, int wlanFilterListType, IntPtr pReserved, IntPtr ppNetworkList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wlanapi_WlanGetFilterList' -Namespace Win32 -PassThru
# $api::WlanGetFilterList(hClientHandle, wlanFilterListType, pReserved, ppNetworkList)
#uselib "wlanapi.dll"
#func global WlanGetFilterList "WlanGetFilterList" sptr, sptr, sptr, sptr
; WlanGetFilterList hClientHandle, wlanFilterListType, pReserved, varptr(ppNetworkList)   ; 戻り値は stat
; hClientHandle : HANDLE -> "sptr"
; wlanFilterListType : WLAN_FILTER_LIST_TYPE -> "sptr"
; pReserved : void* optional -> "sptr"
; ppNetworkList : DOT11_NETWORK_LIST** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "wlanapi.dll"
#cfunc global WlanGetFilterList "WlanGetFilterList" sptr, int, sptr, var
; res = WlanGetFilterList(hClientHandle, wlanFilterListType, pReserved, ppNetworkList)
; hClientHandle : HANDLE -> "sptr"
; wlanFilterListType : WLAN_FILTER_LIST_TYPE -> "int"
; pReserved : void* optional -> "sptr"
; ppNetworkList : DOT11_NETWORK_LIST** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD WlanGetFilterList(HANDLE hClientHandle, WLAN_FILTER_LIST_TYPE wlanFilterListType, void* pReserved, DOT11_NETWORK_LIST** ppNetworkList)
#uselib "wlanapi.dll"
#cfunc global WlanGetFilterList "WlanGetFilterList" intptr, int, intptr, var
; res = WlanGetFilterList(hClientHandle, wlanFilterListType, pReserved, ppNetworkList)
; hClientHandle : HANDLE -> "intptr"
; wlanFilterListType : WLAN_FILTER_LIST_TYPE -> "int"
; pReserved : void* optional -> "intptr"
; ppNetworkList : DOT11_NETWORK_LIST** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wlanapi = windows.NewLazySystemDLL("wlanapi.dll")
	procWlanGetFilterList = wlanapi.NewProc("WlanGetFilterList")
)

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

extern "wlanapi" fn WlanGetFilterList(
    hClientHandle: ?*anyopaque, // HANDLE
    wlanFilterListType: i32, // WLAN_FILTER_LIST_TYPE
    pReserved: ?*anyopaque, // void* optional
    ppNetworkList: [*c][*c]DOT11_NETWORK_LIST // DOT11_NETWORK_LIST** out
) callconv(std.os.windows.WINAPI) u32;
proc WlanGetFilterList(
    hClientHandle: pointer,  # HANDLE
    wlanFilterListType: int32,  # WLAN_FILTER_LIST_TYPE
    pReserved: pointer,  # void* optional
    ppNetworkList: ptr DOT11_NETWORK_LIST  # DOT11_NETWORK_LIST** out
): uint32 {.importc: "WlanGetFilterList", stdcall, dynlib: "wlanapi.dll".}
pragma(lib, "wlanapi");
extern(Windows)
uint WlanGetFilterList(
    void* hClientHandle,   // HANDLE
    int wlanFilterListType,   // WLAN_FILTER_LIST_TYPE
    void* pReserved,   // void* optional
    DOT11_NETWORK_LIST** ppNetworkList   // DOT11_NETWORK_LIST** out
);
ccall((:WlanGetFilterList, "wlanapi.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Int32, Ptr{Cvoid}, Ptr{DOT11_NETWORK_LIST}),
      hClientHandle, wlanFilterListType, pReserved, ppNetworkList)
# hClientHandle : HANDLE -> Ptr{Cvoid}
# wlanFilterListType : WLAN_FILTER_LIST_TYPE -> Int32
# pReserved : void* optional -> Ptr{Cvoid}
# ppNetworkList : DOT11_NETWORK_LIST** out -> Ptr{DOT11_NETWORK_LIST}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WlanGetFilterList(
    void* hClientHandle,
    int32_t wlanFilterListType,
    void* pReserved,
    void* ppNetworkList);
]]
local wlanapi = ffi.load("wlanapi")
-- wlanapi.WlanGetFilterList(hClientHandle, wlanFilterListType, pReserved, ppNetworkList)
-- hClientHandle : HANDLE
-- wlanFilterListType : WLAN_FILTER_LIST_TYPE
-- pReserved : void* optional
-- ppNetworkList : DOT11_NETWORK_LIST** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wlanapi.dll');
const WlanGetFilterList = lib.func('__stdcall', 'WlanGetFilterList', 'uint32_t', ['void *', 'int32_t', 'void *', 'void *']);
// WlanGetFilterList(hClientHandle, wlanFilterListType, pReserved, ppNetworkList)
// hClientHandle : HANDLE -> 'void *'
// wlanFilterListType : WLAN_FILTER_LIST_TYPE -> 'int32_t'
// pReserved : void* optional -> 'void *'
// ppNetworkList : DOT11_NETWORK_LIST** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wlanapi.dll", {
  WlanGetFilterList: { parameters: ["pointer", "i32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.WlanGetFilterList(hClientHandle, wlanFilterListType, pReserved, ppNetworkList)
// hClientHandle : HANDLE -> "pointer"
// wlanFilterListType : WLAN_FILTER_LIST_TYPE -> "i32"
// pReserved : void* optional -> "pointer"
// ppNetworkList : DOT11_NETWORK_LIST** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WlanGetFilterList(
    void* hClientHandle,
    int32_t wlanFilterListType,
    void* pReserved,
    void* ppNetworkList);
C, "wlanapi.dll");
// $ffi->WlanGetFilterList(hClientHandle, wlanFilterListType, pReserved, ppNetworkList);
// hClientHandle : HANDLE
// wlanFilterListType : WLAN_FILTER_LIST_TYPE
// pReserved : void* optional
// ppNetworkList : DOT11_NETWORK_LIST** out
// 構造体/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 WlanGetFilterList(
        Pointer hClientHandle,   // HANDLE
        int wlanFilterListType,   // WLAN_FILTER_LIST_TYPE
        Pointer pReserved,   // void* optional
        Pointer ppNetworkList   // DOT11_NETWORK_LIST** out
    );
}
@[Link("wlanapi")]
lib Libwlanapi
  fun WlanGetFilterList = WlanGetFilterList(
    hClientHandle : Void*,   # HANDLE
    wlanFilterListType : Int32,   # WLAN_FILTER_LIST_TYPE
    pReserved : Void*,   # void* optional
    ppNetworkList : DOT11_NETWORK_LIST**   # DOT11_NETWORK_LIST** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WlanGetFilterListNative = Uint32 Function(Pointer<Void>, Int32, Pointer<Void>, Pointer<Void>);
typedef WlanGetFilterListDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final WlanGetFilterList = DynamicLibrary.open('wlanapi.dll')
    .lookupFunction<WlanGetFilterListNative, WlanGetFilterListDart>('WlanGetFilterList');
// hClientHandle : HANDLE -> Pointer<Void>
// wlanFilterListType : WLAN_FILTER_LIST_TYPE -> Int32
// pReserved : void* optional -> Pointer<Void>
// ppNetworkList : DOT11_NETWORK_LIST** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WlanGetFilterList(
  hClientHandle: THandle;   // HANDLE
  wlanFilterListType: Integer;   // WLAN_FILTER_LIST_TYPE
  pReserved: Pointer;   // void* optional
  ppNetworkList: Pointer   // DOT11_NETWORK_LIST** out
): DWORD; stdcall;
  external 'wlanapi.dll' name 'WlanGetFilterList';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WlanGetFilterList"
  c_WlanGetFilterList :: Ptr () -> Int32 -> Ptr () -> Ptr () -> IO Word32
-- hClientHandle : HANDLE -> Ptr ()
-- wlanFilterListType : WLAN_FILTER_LIST_TYPE -> Int32
-- pReserved : void* optional -> Ptr ()
-- ppNetworkList : DOT11_NETWORK_LIST** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wlangetfilterlist =
  foreign "WlanGetFilterList"
    ((ptr void) @-> int32_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* hClientHandle : HANDLE -> (ptr void) *)
(* wlanFilterListType : WLAN_FILTER_LIST_TYPE -> int32_t *)
(* pReserved : void* optional -> (ptr void) *)
(* ppNetworkList : DOT11_NETWORK_LIST** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wlanapi (t "wlanapi.dll"))
(cffi:use-foreign-library wlanapi)

(cffi:defcfun ("WlanGetFilterList" wlan-get-filter-list :convention :stdcall) :uint32
  (h-client-handle :pointer)   ; HANDLE
  (wlan-filter-list-type :int32)   ; WLAN_FILTER_LIST_TYPE
  (p-reserved :pointer)   ; void* optional
  (pp-network-list :pointer))   ; DOT11_NETWORK_LIST** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WlanGetFilterList = Win32::API::More->new('wlanapi',
    'DWORD WlanGetFilterList(HANDLE hClientHandle, int wlanFilterListType, LPVOID pReserved, LPVOID ppNetworkList)');
# my $ret = $WlanGetFilterList->Call($hClientHandle, $wlanFilterListType, $pReserved, $ppNetworkList);
# hClientHandle : HANDLE -> HANDLE
# wlanFilterListType : WLAN_FILTER_LIST_TYPE -> int
# pReserved : void* optional -> LPVOID
# ppNetworkList : DOT11_NETWORK_LIST** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型