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

WlanOpenHandle

関数
WLAN APIへのクライアントハンドルを開いて接続する。
DLLwlanapi.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD WlanOpenHandle(
    DWORD dwClientVersion,
    void* pReserved,   // optional
    DWORD* pdwNegotiatedVersion,
    HANDLE* phClientHandle
);

パラメーター

名前方向説明
dwClientVersionDWORDin要求するWLAN APIクライアントバージョン(1または2)。
pReservedvoid*optional予約済み。NULLを指定する。
pdwNegotiatedVersionDWORD*out実際に折衝されたAPIバージョンを受け取るDWORDポインタ。
phClientHandleHANDLE*out開かれたWLANクライアントハンドルを受け取る出力先。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

WlanOpenHandle = ctypes.windll.wlanapi.WlanOpenHandle
WlanOpenHandle.restype = wintypes.DWORD
WlanOpenHandle.argtypes = [
    wintypes.DWORD,  # dwClientVersion : DWORD
    ctypes.POINTER(None),  # pReserved : void* optional
    ctypes.POINTER(wintypes.DWORD),  # pdwNegotiatedVersion : DWORD* out
    ctypes.c_void_p,  # phClientHandle : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wlanapi = windows.NewLazySystemDLL("wlanapi.dll")
	procWlanOpenHandle = wlanapi.NewProc("WlanOpenHandle")
)

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

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

typedef WlanOpenHandleNative = Uint32 Function(Uint32, Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
typedef WlanOpenHandleDart = int Function(int, Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
final WlanOpenHandle = DynamicLibrary.open('wlanapi.dll')
    .lookupFunction<WlanOpenHandleNative, WlanOpenHandleDart>('WlanOpenHandle');
// dwClientVersion : DWORD -> Uint32
// pReserved : void* optional -> Pointer<Void>
// pdwNegotiatedVersion : DWORD* out -> Pointer<Uint32>
// phClientHandle : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WlanOpenHandle(
  dwClientVersion: DWORD;   // DWORD
  pReserved: Pointer;   // void* optional
  pdwNegotiatedVersion: Pointer;   // DWORD* out
  phClientHandle: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'wlanapi.dll' name 'WlanOpenHandle';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WlanOpenHandle"
  c_WlanOpenHandle :: Word32 -> Ptr () -> Ptr Word32 -> Ptr () -> IO Word32
-- dwClientVersion : DWORD -> Word32
-- pReserved : void* optional -> Ptr ()
-- pdwNegotiatedVersion : DWORD* out -> Ptr Word32
-- phClientHandle : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wlanopenhandle =
  foreign "WlanOpenHandle"
    (uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> returning uint32_t)
(* dwClientVersion : DWORD -> uint32_t *)
(* pReserved : void* optional -> (ptr void) *)
(* pdwNegotiatedVersion : DWORD* out -> (ptr uint32_t) *)
(* phClientHandle : HANDLE* 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 ("WlanOpenHandle" wlan-open-handle :convention :stdcall) :uint32
  (dw-client-version :uint32)   ; DWORD
  (p-reserved :pointer)   ; void* optional
  (pdw-negotiated-version :pointer)   ; DWORD* out
  (ph-client-handle :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WlanOpenHandle = Win32::API::More->new('wlanapi',
    'DWORD WlanOpenHandle(DWORD dwClientVersion, LPVOID pReserved, LPVOID pdwNegotiatedVersion, HANDLE phClientHandle)');
# my $ret = $WlanOpenHandle->Call($dwClientVersion, $pReserved, $pdwNegotiatedVersion, $phClientHandle);
# dwClientVersion : DWORD -> DWORD
# pReserved : void* optional -> LPVOID
# pdwNegotiatedVersion : DWORD* out -> LPVOID
# phClientHandle : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。