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

WlanGetAvailableNetworkList

関数
接続可能な無線LANネットワークの一覧を取得する。
DLLwlanapi.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

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

パラメーター

名前型方向説明
hClientHandleHANDLEinクライアントのセッションハンドル。以前に WlanOpenHandle 関数を呼び出して取得します。
pInterfaceGuidGUID*in

照会するワイヤレス LAN インターフェイスの GUID へのポインター。

ローカルコンピューターで有効になっている各ワイヤレス LAN インターフェイスの GUID は、WlanEnumInterfaces 関数を使用して確認できます。

dwFlagsDWORDin

一覧に返されるネットワークの種類を制御するフラグのセット。このパラメーターには、次の値の組み合わせを指定できます。

値 意味
WLAN_AVAILABLE_NETWORK_INCLUDE_ALL_ADHOC_PROFILES
0x00000001
表示されないプロファイルも含め、すべてのアドホックネットワークプロファイルを利用可能なネットワークの一覧に含めます。
メモ このフラグを Windows XP with SP3 および Wireless LAN API for Windows XP with SP2 で指定した場合、無効なパラメーターと見なされます。
WLAN_AVAILABLE_NETWORK_INCLUDE_ALL_MANUAL_HIDDEN_PROFILES
0x00000002
表示されないプロファイルも含め、すべての非表示ネットワークプロファイルを利用可能なネットワークの一覧に含めます。
メモ このフラグを Windows XP with SP3 および Wireless LAN API for Windows XP with SP2 で指定した場合、無効なパラメーターと見なされます。
pReservedvoid*optional将来使用するために予約されています。このパラメーターには NULL を設定する必要があります。
ppAvailableNetworkListWLAN_AVAILABLE_NETWORK_LIST**out

返される可視ネットワークの一覧を WLAN_AVAILABLE_NETWORK_LIST 構造体で受け取るためのポインターを格納する領域へのポインター。

返される WLAN_AVAILABLE_NETWORK_LIST 用のバッファーは、呼び出しが成功した場合に WlanGetAvailableNetworkList 関数によって割り当てられます。

戻り値の型: DWORD

公式ドキュメント

ワイヤレス LAN インターフェイスで利用可能なネットワークの一覧を取得します。

戻り値

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

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

リターンコード 説明
ERROR_INVALID_PARAMETER
パラメーターが正しくありません。このエラーは、hClientHandle、pInterfaceGuid、または ppAvailableNetworkList パラメーターが NULL の場合に返されます。また、pReserved が NULL でない場合にも返されます。さらに、dwFlags パラメーターに有効でない値が設定されている場合や、hClientHandle パラメーターが有効でない場合にも返されます。
ERROR_INVALID_HANDLE
ハンドル hClientHandle がハンドルテーブルに見つかりませんでした。
ERROR_NDIS_DOT11_POWER_STATE_INVALID
インターフェイスに関連付けられた無線がオフになっています。無線がオフの場合、利用可能なネットワークはありません。
RPC_STATUS
さまざまなエラーコード。
ERROR_NOT_ENOUGH_MEMORY
この要求を処理し、照会結果用のメモリを割り当てるための十分なメモリがありません。

解説(Remarks)

WlanGetAvailableNetworkList 関数は、関数が成功した場合に、ppAvailableNetworkList パラメーターが指すバッファーで返される利用可能なネットワークの一覧用のメモリを割り当てます。ppAvailableNetworkList パラメーターが指すバッファーに使用されたメモリは、そのバッファーが不要になった後に WlanFreeMemory 関数を呼び出して解放してください。

Wireless LAN API for Windows XP with SP2 には、WlanFreeMemory と WlanGetAvailableNetworkList を何度も呼び出すアプリケーションのパフォーマンスを改善できる修正プログラム (hotfix) が提供されています。

例

次の例では、ローカルコンピューター上のワイヤレス LAN インターフェイスを列挙し、各ワイヤレス LAN インターフェイスで利用可能なネットワークの一覧を取得して、WLAN_AVAILABLE_NETWORK エントリを含む、取得した WLAN_AVAILABLE_NETWORK_LIST の値を出力します。

メモ この例は、Wireless LAN Service がインストールされて開始されていない場合、Windows Server 2008 および Windows Server 2008 R2 では読み込みに失敗します。
#ifndef UNICODE
#define UNICODE
#endif

#include <windows.h>
#include <wlanapi.h>
#include <objbase.h>
#include <wtypes.h>

#include <stdio.h>
#include <stdlib.h>

// Need to link with Wlanapi.lib and Ole32.lib
#pragma comment(lib, "wlanapi.lib")
#pragma comment(lib, "ole32.lib")


int wmain()
{

    // Declare and initialize variables.

    HANDLE hClient = NULL;
    DWORD dwMaxClient = 2;      //    
    DWORD dwCurVersion = 0;
    DWORD dwResult = 0;
    DWORD dwRetVal = 0;
    int iRet = 0;
    
    WCHAR GuidString[39] = {0};

    unsigned int i, j, k;

    /* variables used for WlanEnumInterfaces  */

    PWLAN_INTERFACE_INFO_LIST pIfList = NULL;
    PWLAN_INTERFACE_INFO pIfInfo = NULL;

    PWLAN_AVAILABLE_NETWORK_LIST pBssList = NULL;
    PWLAN_AVAILABLE_NETWORK pBssEntry = NULL;
    
    int iRSSI = 0;

    dwResult = WlanOpenHandle(dwMaxClient, NULL, &dwCurVersion, &hClient);
    if (dwResult != ERROR_SUCCESS) {
        wprintf(L"WlanOpenHandle failed with error: %u\n", dwResult);
        return 1;
        // You can use FormatMessage here to find out why the function failed
    }

    dwResult = WlanEnumInterfaces(hClient, NULL, &pIfList);
    if (dwResult != ERROR_SUCCESS) {
        wprintf(L"WlanEnumInterfaces failed with error: %u\n", dwResult);
        return 1;
        // You can use FormatMessage here to find out why the function failed
    } else {
        wprintf(L"Num Entries: %lu\n", pIfList->dwNumberOfItems);
        wprintf(L"Current Index: %lu\n", pIfList->dwIndex);
        for (i = 0; i < (int) pIfList->dwNumberOfItems; i++) {
            pIfInfo = (WLAN_INTERFACE_INFO *) &pIfList->InterfaceInfo[i];
            wprintf(L"  Interface Index[%u]:\t %lu\n", i, i);
            iRet = StringFromGUID2(pIfInfo->InterfaceGuid, (LPOLESTR) &GuidString, 
                sizeof(GuidString)/sizeof(*GuidString)); 
            // For c rather than C++ source code, the above line needs to be
            // iRet = StringFromGUID2(&pIfInfo->InterfaceGuid, (LPOLESTR) &GuidString, 
            //     sizeof(GuidString)/sizeof(*GuidString)); 
            if (iRet == 0)
                wprintf(L"StringFromGUID2 failed\n");
            else {
                wprintf(L"  InterfaceGUID[%d]: %ws\n",i, GuidString);
            }    
            wprintf(L"  Interface Description[%d]: %ws", i, 
                pIfInfo->strInterfaceDescription);
            wprintf(L"\n");
            wprintf(L"  Interface State[%d]:\t ", i);
            switch (pIfInfo->isState) {
            case wlan_interface_state_not_ready:
                wprintf(L"Not ready\n");
                break;
            case wlan_interface_state_connected:
                wprintf(L"Connected\n");
                break;
            case wlan_interface_state_ad_hoc_network_formed:
                wprintf(L"First node in a ad hoc network\n");
                break;
            case wlan_interface_state_disconnecting:
                wprintf(L"Disconnecting\n");
                break;
            case wlan_interface_state_disconnected:
                wprintf(L"Not connected\n");
                break;
            case wlan_interface_state_associating:
                wprintf(L"Attempting to associate with a network\n");
                break;
            case wlan_interface_state_discovering:
                wprintf(L"Auto configuration is discovering settings for the network\n");
                break;
            case wlan_interface_state_authenticating:
                wprintf(L"In process of authenticating\n");
                break;
            default:
                wprintf(L"Unknown state %ld\n", pIfInfo->isState);
                break;
            }
            wprintf(L"\n");

            dwResult = WlanGetAvailableNetworkList(hClient,
                                             &pIfInfo->InterfaceGuid,
                                             0, 
                                             NULL, 
                                             &pBssList);

            if (dwResult != ERROR_SUCCESS) {
                wprintf(L"WlanGetAvailableNetworkList failed with error: %u\n",
                        dwResult);
                dwRetVal = 1;
                // You can use FormatMessage to find out why the function failed
            } else {
                wprintf(L"WLAN_AVAILABLE_NETWORK_LIST for this interface\n");

                wprintf(L"  Num Entries: %lu\n\n", pBssList->dwNumberOfItems);

                for (j = 0; j < pBssList->dwNumberOfItems; j++) {
                    pBssEntry =
                        (WLAN_AVAILABLE_NETWORK *) & pBssList->Network[j];

                    wprintf(L"  Profile Name[%u]:  %ws\n", j, pBssEntry->strProfileName);
                    
                    wprintf(L"  SSID[%u]:\t\t ", j);
                    if (pBssEntry->dot11Ssid.uSSIDLength == 0)
                        wprintf(L"\n");
                    else {   
                        for (k = 0; k < pBssEntry->dot11Ssid.uSSIDLength; k++) {
                            wprintf(L"%c", (int) pBssEntry->dot11Ssid.ucSSID[k]);
                        }
                        wprintf(L"\n");
                    }
                        
                    wprintf(L"  BSS Network type[%u]:\t ", j);
                    switch (pBssEntry->dot11BssType) {
                    case dot11_BSS_type_infrastructure   :
                        wprintf(L"Infrastructure (%u)\n", pBssEntry->dot11BssType);
                        break;
                    case dot11_BSS_type_independent:
                        wprintf(L"Infrastructure (%u)\n", pBssEntry->dot11BssType);
                        break;
                    default:
                        wprintf(L"Other (%lu)\n", pBssEntry->dot11BssType);
                        break;
                    }
                                
                    wprintf(L"  Number of BSSIDs[%u]:\t %u\n", j, pBssEntry->uNumberOfBssids);

                    wprintf(L"  Connectable[%u]:\t ", j);
                    if (pBssEntry->bNetworkConnectable)
                        wprintf(L"Yes\n");
                    else {
                        wprintf(L"No\n");
                        wprintf(L"  Not connectable WLAN_REASON_CODE value[%u]:\t %u\n", j, 
                            pBssEntry->wlanNotConnectableReason);
                    }        

                    wprintf(L"  Number of PHY types supported[%u]:\t %u\n", j, pBssEntry->uNumberOfPhyTypes);

                    if (pBssEntry->wlanSignalQuality == 0)
                        iRSSI = -100;
                    else if (pBssEntry->wlanSignalQuality == 100)   
                        iRSSI = -50;
                    else
                        iRSSI = -100 + (pBssEntry->wlanSignalQuality/2);    
                        
                    wprintf(L"  Signal Quality[%u]:\t %u (RSSI: %i dBm)\n", j, 
                        pBssEntry->wlanSignalQuality, iRSSI);

                    wprintf(L"  Security Enabled[%u]:\t ", j);
                    if (pBssEntry->bSecurityEnabled)
                        wprintf(L"Yes\n");
                    else
                        wprintf(L"No\n");
                        
                    wprintf(L"  Default AuthAlgorithm[%u]: ", j);
                    switch (pBssEntry->dot11DefaultAuthAlgorithm) {
                    case DOT11_AUTH_ALGO_80211_OPEN:
                        wprintf(L"802.11 Open (%u)\n", pBssEntry->dot11DefaultAuthAlgorithm);
                        break;
                    case DOT11_AUTH_ALGO_80211_SHARED_KEY:
                        wprintf(L"802.11 Shared (%u)\n", pBssEntry->dot11DefaultAuthAlgorithm);
                        break;
                    case DOT11_AUTH_ALGO_WPA:
                        wprintf(L"WPA (%u)\n", pBssEntry->dot11DefaultAuthAlgorithm);
                        break;
                    case DOT11_AUTH_ALGO_WPA_PSK:
                        wprintf(L"WPA-PSK (%u)\n", pBssEntry->dot11DefaultAuthAlgorithm);
                        break;
                    case DOT11_AUTH_ALGO_WPA_NONE:
                        wprintf(L"WPA-None (%u)\n", pBssEntry->dot11DefaultAuthAlgorithm);
                        break;
                    case DOT11_AUTH_ALGO_RSNA:
                        wprintf(L"RSNA (%u)\n", pBssEntry->dot11DefaultAuthAlgorithm);
                        break;
                    case DOT11_AUTH_ALGO_RSNA_PSK:
                        wprintf(L"RSNA with PSK(%u)\n", pBssEntry->dot11DefaultAuthAlgorithm);
                        break;
                    default:
                        wprintf(L"Other (%lu)\n", pBssEntry->dot11DefaultAuthAlgorithm);
                        break;
                    }
                        
                    wprintf(L"  Default CipherAlgorithm[%u]: ", j);
                    switch (pBssEntry->dot11DefaultCipherAlgorithm) {
                    case DOT11_CIPHER_ALGO_NONE:
                        wprintf(L"None (0x%x)\n", pBssEntry->dot11DefaultCipherAlgorithm);
                        break;
                    case DOT11_CIPHER_ALGO_WEP40:
                        wprintf(L"WEP-40 (0x%x)\n", pBssEntry->dot11DefaultCipherAlgorithm);
                        break;
                    case DOT11_CIPHER_ALGO_TKIP:
                        wprintf(L"TKIP (0x%x)\n", pBssEntry->dot11DefaultCipherAlgorithm);
                        break;
                    case DOT11_CIPHER_ALGO_CCMP:
                        wprintf(L"CCMP (0x%x)\n", pBssEntry->dot11DefaultCipherAlgorithm);
                        break;
                    case DOT11_CIPHER_ALGO_WEP104:
                        wprintf(L"WEP-104 (0x%x)\n", pBssEntry->dot11DefaultCipherAlgorithm);
                        break;
                    case DOT11_CIPHER_ALGO_WEP:
                        wprintf(L"WEP (0x%x)\n", pBssEntry->dot11DefaultCipherAlgorithm);
                        break;
                    default:
                        wprintf(L"Other (0x%x)\n", pBssEntry->dot11DefaultCipherAlgorithm);
                        break;
                    }

                    wprintf(L"  Flags[%u]:\t 0x%x", j, pBssEntry->dwFlags);
                    if (pBssEntry->dwFlags) {
                        if (pBssEntry->dwFlags & WLAN_AVAILABLE_NETWORK_CONNECTED)
                            wprintf(L" - Currently connected");
                        if (pBssEntry->dwFlags & WLAN_AVAILABLE_NETWORK_HAS_PROFILE)
                            wprintf(L" - Has profile");
                    }   
                    wprintf(L"\n");
                    
                    wprintf(L"\n");
                }
            }
        }

    }
    if (pBssList != NULL) {
        WlanFreeMemory(pBssList);
        pBssList = NULL;
    }

    if (pIfList != NULL) {
        WlanFreeMemory(pIfList);
        pIfList = NULL;
    }

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

各言語での呼び出し定義

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

DWORD WlanGetAvailableNetworkList(
    HANDLE hClientHandle,
    const GUID* pInterfaceGuid,
    DWORD dwFlags,
    void* pReserved,   // optional
    WLAN_AVAILABLE_NETWORK_LIST** ppAvailableNetworkList
);
[DllImport("wlanapi.dll", ExactSpelling = true)]
static extern uint WlanGetAvailableNetworkList(
    IntPtr hClientHandle,   // HANDLE
    ref Guid pInterfaceGuid,   // GUID*
    uint dwFlags,   // DWORD
    IntPtr pReserved,   // void* optional
    IntPtr ppAvailableNetworkList   // WLAN_AVAILABLE_NETWORK_LIST** out
);
<DllImport("wlanapi.dll", ExactSpelling:=True)>
Public Shared Function WlanGetAvailableNetworkList(
    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** out
) As UInteger
End Function
' hClientHandle : HANDLE
' pInterfaceGuid : GUID*
' dwFlags : DWORD
' pReserved : void* optional
' ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST** out
Declare PtrSafe Function WlanGetAvailableNetworkList 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

WlanGetAvailableNetworkList = ctypes.windll.wlanapi.WlanGetAvailableNetworkList
WlanGetAvailableNetworkList.restype = wintypes.DWORD
WlanGetAvailableNetworkList.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** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wlanapi = windows.NewLazySystemDLL("wlanapi.dll")
	procWlanGetAvailableNetworkList = wlanapi.NewProc("WlanGetAvailableNetworkList")
)

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

extern "wlanapi" fn WlanGetAvailableNetworkList(
    hClientHandle: ?*anyopaque, // HANDLE
    pInterfaceGuid: [*c]GUID, // GUID*
    dwFlags: u32, // DWORD
    pReserved: ?*anyopaque, // void* optional
    ppAvailableNetworkList: [*c][*c]WLAN_AVAILABLE_NETWORK_LIST // WLAN_AVAILABLE_NETWORK_LIST** out
) callconv(std.os.windows.WINAPI) u32;
proc WlanGetAvailableNetworkList(
    hClientHandle: pointer,  # HANDLE
    pInterfaceGuid: ptr GUID,  # GUID*
    dwFlags: uint32,  # DWORD
    pReserved: pointer,  # void* optional
    ppAvailableNetworkList: ptr WLAN_AVAILABLE_NETWORK_LIST  # WLAN_AVAILABLE_NETWORK_LIST** out
): uint32 {.importc: "WlanGetAvailableNetworkList", stdcall, dynlib: "wlanapi.dll".}
pragma(lib, "wlanapi");
extern(Windows)
uint WlanGetAvailableNetworkList(
    void* hClientHandle,   // HANDLE
    GUID* pInterfaceGuid,   // GUID*
    uint dwFlags,   // DWORD
    void* pReserved,   // void* optional
    WLAN_AVAILABLE_NETWORK_LIST** ppAvailableNetworkList   // WLAN_AVAILABLE_NETWORK_LIST** out
);
ccall((:WlanGetAvailableNetworkList, "wlanapi.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{GUID}, UInt32, Ptr{Cvoid}, Ptr{WLAN_AVAILABLE_NETWORK_LIST}),
      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** out -> Ptr{WLAN_AVAILABLE_NETWORK_LIST}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WlanGetAvailableNetworkList(
    void* hClientHandle,
    void* pInterfaceGuid,
    uint32_t dwFlags,
    void* pReserved,
    void* ppAvailableNetworkList);
]]
local wlanapi = ffi.load("wlanapi")
-- wlanapi.WlanGetAvailableNetworkList(hClientHandle, pInterfaceGuid, dwFlags, pReserved, ppAvailableNetworkList)
-- hClientHandle : HANDLE
-- pInterfaceGuid : GUID*
-- dwFlags : DWORD
-- pReserved : void* optional
-- ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wlanapi.dll');
const WlanGetAvailableNetworkList = lib.func('__stdcall', 'WlanGetAvailableNetworkList', 'uint32_t', ['void *', 'void *', 'uint32_t', 'void *', 'void *']);
// WlanGetAvailableNetworkList(hClientHandle, pInterfaceGuid, dwFlags, pReserved, ppAvailableNetworkList)
// hClientHandle : HANDLE -> 'void *'
// pInterfaceGuid : GUID* -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// pReserved : void* optional -> 'void *'
// ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wlanapi.dll", {
  WlanGetAvailableNetworkList: { parameters: ["pointer", "pointer", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.WlanGetAvailableNetworkList(hClientHandle, pInterfaceGuid, dwFlags, pReserved, ppAvailableNetworkList)
// hClientHandle : HANDLE -> "pointer"
// pInterfaceGuid : GUID* -> "pointer"
// dwFlags : DWORD -> "u32"
// pReserved : void* optional -> "pointer"
// ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WlanGetAvailableNetworkList(
    void* hClientHandle,
    void* pInterfaceGuid,
    uint32_t dwFlags,
    void* pReserved,
    void* ppAvailableNetworkList);
C, "wlanapi.dll");
// $ffi->WlanGetAvailableNetworkList(hClientHandle, pInterfaceGuid, dwFlags, pReserved, ppAvailableNetworkList);
// hClientHandle : HANDLE
// pInterfaceGuid : GUID*
// dwFlags : DWORD
// pReserved : void* optional
// ppAvailableNetworkList : WLAN_AVAILABLE_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 WlanGetAvailableNetworkList(
        Pointer hClientHandle,   // HANDLE
        Pointer pInterfaceGuid,   // GUID*
        int dwFlags,   // DWORD
        Pointer pReserved,   // void* optional
        Pointer ppAvailableNetworkList   // WLAN_AVAILABLE_NETWORK_LIST** out
    );
}
@[Link("wlanapi")]
lib Libwlanapi
  fun WlanGetAvailableNetworkList = WlanGetAvailableNetworkList(
    hClientHandle : Void*,   # HANDLE
    pInterfaceGuid : GUID*,   # GUID*
    dwFlags : UInt32,   # DWORD
    pReserved : Void*,   # void* optional
    ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST**   # WLAN_AVAILABLE_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 WlanGetAvailableNetworkListNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>);
typedef WlanGetAvailableNetworkListDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final WlanGetAvailableNetworkList = DynamicLibrary.open('wlanapi.dll')
    .lookupFunction<WlanGetAvailableNetworkListNative, WlanGetAvailableNetworkListDart>('WlanGetAvailableNetworkList');
// hClientHandle : HANDLE -> Pointer<Void>
// pInterfaceGuid : GUID* -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// pReserved : void* optional -> Pointer<Void>
// ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WlanGetAvailableNetworkList(
  hClientHandle: THandle;   // HANDLE
  pInterfaceGuid: PGUID;   // GUID*
  dwFlags: DWORD;   // DWORD
  pReserved: Pointer;   // void* optional
  ppAvailableNetworkList: Pointer   // WLAN_AVAILABLE_NETWORK_LIST** out
): DWORD; stdcall;
  external 'wlanapi.dll' name 'WlanGetAvailableNetworkList';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WlanGetAvailableNetworkList"
  c_WlanGetAvailableNetworkList :: 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** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wlangetavailablenetworklist =
  foreign "WlanGetAvailableNetworkList"
    ((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** 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 ("WlanGetAvailableNetworkList" wlan-get-available-network-list :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** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WlanGetAvailableNetworkList = Win32::API::More->new('wlanapi',
    'DWORD WlanGetAvailableNetworkList(HANDLE hClientHandle, LPVOID pInterfaceGuid, DWORD dwFlags, LPVOID pReserved, LPVOID ppAvailableNetworkList)');
# my $ret = $WlanGetAvailableNetworkList->Call($hClientHandle, $pInterfaceGuid, $dwFlags, $pReserved, $ppAvailableNetworkList);
# hClientHandle : HANDLE -> HANDLE
# pInterfaceGuid : GUID* -> LPVOID
# dwFlags : DWORD -> DWORD
# pReserved : void* optional -> LPVOID
# ppAvailableNetworkList : WLAN_AVAILABLE_NETWORK_LIST** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型