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

WlanGetAvailableNetworkList2

関数
接続可能な無線LANネットワーク一覧をV2形式で取得する。
DLLwlanapi.dll呼出規約winapi

シグネチャ

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

DWORD WlanGetAvailableNetworkList2(
    HANDLE hClientHandle,
    const GUID* pInterfaceGuid,
    DWORD dwFlags,
    void* pReserved,   // optional
    WLAN_AVAILABLE_NETWORK_LIST_V2** ppAvailableNetworkList
);

パラメーター

名前型方向説明
hClientHandleHANDLEinWLANクライアントハンドル。
pInterfaceGuidGUID*in対象の無線インターフェイスのGUIDポインタ。
dwFlagsDWORDin取得内容を制御するフラグ。非表示/未対応ネットワークの包含等を指定する。
pReservedvoid*optional予約済み。NULLを指定する。
ppAvailableNetworkListWLAN_AVAILABLE_NETWORK_LIST_V2**out利用可能ネットワーク一覧(V2構造)を受け取る出力先。WlanFreeMemoryで解放。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD WlanGetAvailableNetworkList2(
    HANDLE hClientHandle,
    const GUID* pInterfaceGuid,
    DWORD dwFlags,
    void* pReserved,   // optional
    WLAN_AVAILABLE_NETWORK_LIST_V2** ppAvailableNetworkList
);
[DllImport("wlanapi.dll", ExactSpelling = true)]
static extern uint WlanGetAvailableNetworkList2(
    IntPtr hClientHandle,   // HANDLE
    ref Guid pInterfaceGuid,   // GUID*
    uint dwFlags,   // DWORD
    IntPtr pReserved,   // void* optional
    IntPtr ppAvailableNetworkList   // WLAN_AVAILABLE_NETWORK_LIST_V2** out
);
<DllImport("wlanapi.dll", ExactSpelling:=True)>
Public Shared Function WlanGetAvailableNetworkList2(
    hClientHandle As IntPtr,   ' HANDLE
    ByRef pInterfaceGuid As Guid,   ' GUID*
    dwFlags As UInteger,   ' DWORD
    pReserved As IntPtr,   ' void* optional
    ppAvailableNetworkList As IntPtr   ' WLAN_AVAILABLE_NETWORK_LIST_V2** out
) As UInteger
End Function
' hClientHandle : HANDLE
' pInterfaceGuid : GUID*
' dwFlags : DWORD
' pReserved : void* optional
' ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST_V2** out
Declare PtrSafe Function WlanGetAvailableNetworkList2 Lib "wlanapi" ( _
    ByVal hClientHandle As LongPtr, _
    ByVal pInterfaceGuid As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pReserved As LongPtr, _
    ByVal ppAvailableNetworkList As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WlanGetAvailableNetworkList2 = ctypes.windll.wlanapi.WlanGetAvailableNetworkList2
WlanGetAvailableNetworkList2.restype = wintypes.DWORD
WlanGetAvailableNetworkList2.argtypes = [
    wintypes.HANDLE,  # hClientHandle : HANDLE
    ctypes.c_void_p,  # pInterfaceGuid : GUID*
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(None),  # pReserved : void* optional
    ctypes.c_void_p,  # ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST_V2** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wlanapi = windows.NewLazySystemDLL("wlanapi.dll")
	procWlanGetAvailableNetworkList2 = wlanapi.NewProc("WlanGetAvailableNetworkList2")
)

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

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

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

foreign import stdcall safe "WlanGetAvailableNetworkList2"
  c_WlanGetAvailableNetworkList2 :: Ptr () -> Ptr () -> Word32 -> Ptr () -> Ptr () -> IO Word32
-- hClientHandle : HANDLE -> Ptr ()
-- pInterfaceGuid : GUID* -> Ptr ()
-- dwFlags : DWORD -> Word32
-- pReserved : void* optional -> Ptr ()
-- ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST_V2** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wlangetavailablenetworklist2 =
  foreign "WlanGetAvailableNetworkList2"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* hClientHandle : HANDLE -> (ptr void) *)
(* pInterfaceGuid : GUID* -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* pReserved : void* optional -> (ptr void) *)
(* ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST_V2** 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 ("WlanGetAvailableNetworkList2" wlan-get-available-network-list2 :convention :stdcall) :uint32
  (h-client-handle :pointer)   ; HANDLE
  (p-interface-guid :pointer)   ; GUID*
  (dw-flags :uint32)   ; DWORD
  (p-reserved :pointer)   ; void* optional
  (pp-available-network-list :pointer))   ; WLAN_AVAILABLE_NETWORK_LIST_V2** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WlanGetAvailableNetworkList2 = Win32::API::More->new('wlanapi',
    'DWORD WlanGetAvailableNetworkList2(HANDLE hClientHandle, LPVOID pInterfaceGuid, DWORD dwFlags, LPVOID pReserved, LPVOID ppAvailableNetworkList)');
# my $ret = $WlanGetAvailableNetworkList2->Call($hClientHandle, $pInterfaceGuid, $dwFlags, $pReserved, $ppAvailableNetworkList);
# hClientHandle : HANDLE -> HANDLE
# pInterfaceGuid : GUID* -> LPVOID
# dwFlags : DWORD -> DWORD
# pReserved : void* optional -> LPVOID
# ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST_V2** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型