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

WSASetBlockingHook

関数
ブロッキング呼び出し用のフック関数を登録する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

FARPROC WSASetBlockingHook(
    FARPROC lpBlockFunc
);

パラメーター

名前方向説明
lpBlockFuncFARPROCinブロッキング操作中に呼ばれる新しいフックプロシージャへのポインタ。旧バージョン互換用で非推奨。

戻り値の型: FARPROC

公式ドキュメント

この関数は、Windows Sockets 2 仕様リビジョン 2.2.0 への準拠のため削除されました。(WSASetBlockingHook)

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

各言語での呼び出し定義

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

FARPROC WSASetBlockingHook(
    FARPROC lpBlockFunc
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr WSASetBlockingHook(
    IntPtr lpBlockFunc   // FARPROC
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSASetBlockingHook(
    lpBlockFunc As IntPtr   ' FARPROC
) As IntPtr
End Function
' lpBlockFunc : FARPROC
Declare PtrSafe Function WSASetBlockingHook Lib "ws2_32" ( _
    ByVal lpBlockFunc As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSASetBlockingHook = ctypes.windll.ws2_32.WSASetBlockingHook
WSASetBlockingHook.restype = ctypes.c_void_p
WSASetBlockingHook.argtypes = [
    ctypes.c_void_p,  # lpBlockFunc : FARPROC
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSASetBlockingHook = Fiddle::Function.new(
  lib['WSASetBlockingHook'],
  [
    Fiddle::TYPE_VOIDP,  # lpBlockFunc : FARPROC
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "ws2_32")]
extern "system" {
    fn WSASetBlockingHook(
        lpBlockFunc: *const core::ffi::c_void  // FARPROC
    ) -> *const core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern IntPtr WSASetBlockingHook(IntPtr lpBlockFunc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSASetBlockingHook' -Namespace Win32 -PassThru
# $api::WSASetBlockingHook(lpBlockFunc)
#uselib "WS2_32.dll"
#func global WSASetBlockingHook "WSASetBlockingHook" sptr
; WSASetBlockingHook lpBlockFunc   ; 戻り値は stat
; lpBlockFunc : FARPROC -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WS2_32.dll"
#cfunc global WSASetBlockingHook "WSASetBlockingHook" sptr
; res = WSASetBlockingHook(lpBlockFunc)
; lpBlockFunc : FARPROC -> "sptr"
; FARPROC WSASetBlockingHook(FARPROC lpBlockFunc)
#uselib "WS2_32.dll"
#cfunc global WSASetBlockingHook "WSASetBlockingHook" intptr
; res = WSASetBlockingHook(lpBlockFunc)
; lpBlockFunc : FARPROC -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSASetBlockingHook = ws2_32.NewProc("WSASetBlockingHook")
)

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

extern "ws2_32" fn WSASetBlockingHook(
    lpBlockFunc: ?*anyopaque // FARPROC
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc WSASetBlockingHook(
    lpBlockFunc: pointer  # FARPROC
): pointer {.importc: "WSASetBlockingHook", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
void* WSASetBlockingHook(
    void* lpBlockFunc   // FARPROC
);
ccall((:WSASetBlockingHook, "WS2_32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid},),
      lpBlockFunc)
# lpBlockFunc : FARPROC -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* WSASetBlockingHook(
    void* lpBlockFunc);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSASetBlockingHook(lpBlockFunc)
-- lpBlockFunc : FARPROC
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSASetBlockingHook = lib.func('__stdcall', 'WSASetBlockingHook', 'void *', ['void *']);
// WSASetBlockingHook(lpBlockFunc)
// lpBlockFunc : FARPROC -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("WS2_32.dll", {
  WSASetBlockingHook: { parameters: ["pointer"], result: "pointer" },
});
// lib.symbols.WSASetBlockingHook(lpBlockFunc)
// lpBlockFunc : FARPROC -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* WSASetBlockingHook(
    void* lpBlockFunc);
C, "WS2_32.dll");
// $ffi->WSASetBlockingHook(lpBlockFunc);
// lpBlockFunc : FARPROC
// 構造体/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 Ws2_32 extends StdCallLibrary {
    Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class);
    Pointer WSASetBlockingHook(
        Callback lpBlockFunc   // FARPROC
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun WSASetBlockingHook = WSASetBlockingHook(
    lpBlockFunc : Void*   # FARPROC
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSASetBlockingHookNative = Pointer<Void> Function(Pointer<Void>);
typedef WSASetBlockingHookDart = Pointer<Void> Function(Pointer<Void>);
final WSASetBlockingHook = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSASetBlockingHookNative, WSASetBlockingHookDart>('WSASetBlockingHook');
// lpBlockFunc : FARPROC -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSASetBlockingHook(
  lpBlockFunc: Pointer   // FARPROC
): Pointer; stdcall;
  external 'WS2_32.dll' name 'WSASetBlockingHook';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSASetBlockingHook"
  c_WSASetBlockingHook :: Ptr () -> IO (Ptr ())
-- lpBlockFunc : FARPROC -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsasetblockinghook =
  foreign "WSASetBlockingHook"
    ((ptr void) @-> returning (ptr void))
(* lpBlockFunc : FARPROC -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ws2_32 (t "WS2_32.dll"))
(cffi:use-foreign-library ws2_32)

(cffi:defcfun ("WSASetBlockingHook" wsaset-blocking-hook :convention :stdcall) :pointer
  (lp-block-func :pointer))   ; FARPROC
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSASetBlockingHook = Win32::API::More->new('WS2_32',
    'LPVOID WSASetBlockingHook(LPVOID lpBlockFunc)');
# my $ret = $WSASetBlockingHook->Call($lpBlockFunc);
# lpBlockFunc : FARPROC -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型