Win32 API 日本語リファレンス
ホームNetworking.WinSock › WSANSPIoctl

WSANSPIoctl

関数
名前空間プロバイダーに対する制御操作を実行する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

INT WSANSPIoctl(
    HANDLE hLookup,
    DWORD dwControlCode,
    void* lpvInBuffer,   // optional
    DWORD cbInBuffer,
    void* lpvOutBuffer,   // optional
    DWORD cbOutBuffer,
    DWORD* lpcbBytesReturned,
    WSACOMPLETION* lpCompletion   // optional
);

パラメーター

名前方向
hLookupHANDLEin
dwControlCodeDWORDin
lpvInBuffervoid*inoptional
cbInBufferDWORDin
lpvOutBuffervoid*outoptional
cbOutBufferDWORDin
lpcbBytesReturnedDWORD*out
lpCompletionWSACOMPLETION*inoptional

戻り値の型: INT

各言語での呼び出し定義

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

INT WSANSPIoctl(
    HANDLE hLookup,
    DWORD dwControlCode,
    void* lpvInBuffer,   // optional
    DWORD cbInBuffer,
    void* lpvOutBuffer,   // optional
    DWORD cbOutBuffer,
    DWORD* lpcbBytesReturned,
    WSACOMPLETION* lpCompletion   // optional
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSANSPIoctl(
    IntPtr hLookup,   // HANDLE
    uint dwControlCode,   // DWORD
    IntPtr lpvInBuffer,   // void* optional
    uint cbInBuffer,   // DWORD
    IntPtr lpvOutBuffer,   // void* optional, out
    uint cbOutBuffer,   // DWORD
    out uint lpcbBytesReturned,   // DWORD* out
    IntPtr lpCompletion   // WSACOMPLETION* optional
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSANSPIoctl(
    hLookup As IntPtr,   ' HANDLE
    dwControlCode As UInteger,   ' DWORD
    lpvInBuffer As IntPtr,   ' void* optional
    cbInBuffer As UInteger,   ' DWORD
    lpvOutBuffer As IntPtr,   ' void* optional, out
    cbOutBuffer As UInteger,   ' DWORD
    <Out> ByRef lpcbBytesReturned As UInteger,   ' DWORD* out
    lpCompletion As IntPtr   ' WSACOMPLETION* optional
) As Integer
End Function
' hLookup : HANDLE
' dwControlCode : DWORD
' lpvInBuffer : void* optional
' cbInBuffer : DWORD
' lpvOutBuffer : void* optional, out
' cbOutBuffer : DWORD
' lpcbBytesReturned : DWORD* out
' lpCompletion : WSACOMPLETION* optional
Declare PtrSafe Function WSANSPIoctl Lib "ws2_32" ( _
    ByVal hLookup As LongPtr, _
    ByVal dwControlCode As Long, _
    ByVal lpvInBuffer As LongPtr, _
    ByVal cbInBuffer As Long, _
    ByVal lpvOutBuffer As LongPtr, _
    ByVal cbOutBuffer As Long, _
    ByRef lpcbBytesReturned As Long, _
    ByVal lpCompletion As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSANSPIoctl = ctypes.windll.ws2_32.WSANSPIoctl
WSANSPIoctl.restype = ctypes.c_int
WSANSPIoctl.argtypes = [
    wintypes.HANDLE,  # hLookup : HANDLE
    wintypes.DWORD,  # dwControlCode : DWORD
    ctypes.POINTER(None),  # lpvInBuffer : void* optional
    wintypes.DWORD,  # cbInBuffer : DWORD
    ctypes.POINTER(None),  # lpvOutBuffer : void* optional, out
    wintypes.DWORD,  # cbOutBuffer : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpcbBytesReturned : DWORD* out
    ctypes.c_void_p,  # lpCompletion : WSACOMPLETION* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSANSPIoctl = ws2_32.NewProc("WSANSPIoctl")
)

// hLookup (HANDLE), dwControlCode (DWORD), lpvInBuffer (void* optional), cbInBuffer (DWORD), lpvOutBuffer (void* optional, out), cbOutBuffer (DWORD), lpcbBytesReturned (DWORD* out), lpCompletion (WSACOMPLETION* optional)
r1, _, err := procWSANSPIoctl.Call(
	uintptr(hLookup),
	uintptr(dwControlCode),
	uintptr(lpvInBuffer),
	uintptr(cbInBuffer),
	uintptr(lpvOutBuffer),
	uintptr(cbOutBuffer),
	uintptr(lpcbBytesReturned),
	uintptr(lpCompletion),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function WSANSPIoctl(
  hLookup: THandle;   // HANDLE
  dwControlCode: DWORD;   // DWORD
  lpvInBuffer: Pointer;   // void* optional
  cbInBuffer: DWORD;   // DWORD
  lpvOutBuffer: Pointer;   // void* optional, out
  cbOutBuffer: DWORD;   // DWORD
  lpcbBytesReturned: Pointer;   // DWORD* out
  lpCompletion: Pointer   // WSACOMPLETION* optional
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSANSPIoctl';
result := DllCall("WS2_32\WSANSPIoctl"
    , "Ptr", hLookup   ; HANDLE
    , "UInt", dwControlCode   ; DWORD
    , "Ptr", lpvInBuffer   ; void* optional
    , "UInt", cbInBuffer   ; DWORD
    , "Ptr", lpvOutBuffer   ; void* optional, out
    , "UInt", cbOutBuffer   ; DWORD
    , "Ptr", lpcbBytesReturned   ; DWORD* out
    , "Ptr", lpCompletion   ; WSACOMPLETION* optional
    , "Int")   ; return: INT
●WSANSPIoctl(hLookup, dwControlCode, lpvInBuffer, cbInBuffer, lpvOutBuffer, cbOutBuffer, lpcbBytesReturned, lpCompletion) = DLL("WS2_32.dll", "int WSANSPIoctl(void*, dword, void*, dword, void*, dword, void*, void*)")
# 呼び出し: WSANSPIoctl(hLookup, dwControlCode, lpvInBuffer, cbInBuffer, lpvOutBuffer, cbOutBuffer, lpcbBytesReturned, lpCompletion)
# hLookup : HANDLE -> "void*"
# dwControlCode : DWORD -> "dword"
# lpvInBuffer : void* optional -> "void*"
# cbInBuffer : DWORD -> "dword"
# lpvOutBuffer : void* optional, out -> "void*"
# cbOutBuffer : DWORD -> "dword"
# lpcbBytesReturned : DWORD* out -> "void*"
# lpCompletion : WSACOMPLETION* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。