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

WSAProviderConfigChange

関数
プロバイダー構成の変更を通知で受け取る。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

INT WSAProviderConfigChange(
    HANDLE* lpNotificationHandle,
    OVERLAPPED* lpOverlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine   // optional
);

パラメーター

名前型方向説明
lpNotificationHandleHANDLE*inout通知ハンドルへのポインター。通知ハンドルが NULL(ポインター自体ではなくハンドルの値)に設定されている場合、この関数は lpNotificationHandle が指す場所に通知ハンドルを返します。
lpOverlappedOVERLAPPED*inoutoptionalWSAOVERLAPPED 構造体へのポインター。
lpCompletionRoutineLPWSAOVERLAPPED_COMPLETION_ROUTINEinoptionalプロバイダー変更通知を受信したときに呼び出される完了ルーチンへのポインター。

戻り値の型: INT

公式ドキュメント

WSAProviderConfigChange 関数は、プロバイダーの構成が変更されたときにアプリケーションへ通知します。

戻り値

エラーが発生しなかった場合、 WSAProviderConfigChange は 0 を返します。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで固有のエラーコードを取得できます。エラーコード WSA_IO_PENDING は、オーバーラップ操作が正常に開始され、完了(つまり変更イベント)が後で通知されることを示します。

エラーコード 意味
WSANOTINITIALISED
 この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN
 ネットワークサブシステムが失敗しました。
WSA_NOT_ENOUGH_MEMORY
 操作を完了するための空きメモリが不足しています。
WSA_INVALID_HANDLE
 lpNotificationHandle パラメーターが指す値が、有効な通知ハンドルではありません。
WSAEOPNOTSUPP
 現在のオペレーティングシステム環境では、再起動なしでのプロバイダーのインストールまたは削除がサポートされていません。

解説(Remarks)

WSAProviderConfigChange 関数は、再起動を必要とせずにこのような構成変更をサポートする Windows オペレーティング環境において、プロバイダー(トランスポートと名前空間の両方)のインストールまたは削除をアプリケーションへ通知します。初回の呼び出し時(lpNotificationHandle パラメーターが NULL ハンドルを指している場合)、この関数は直ちに完了し、lpNotificationHandle が指す場所に通知ハンドルを返します。このハンドルは、プロバイダーのインストールおよび削除の通知を受け取るために後続の呼び出しで使用できます。2 回目以降の呼び出しは、呼び出しが行われた時点以降にプロバイダー情報が変更されたときにのみ完了します。2 回目以降の WSAProviderConfigChange の呼び出しでは、アプリケーションがオーバーラップ I/O を使用することが想定されています(必須ではありません)。その場合、呼び出しは直ちに戻り、指定されたオーバーラップ完了パラメーターによって選択された完了メカニズムを通じて、プロバイダー構成の変更がアプリケーションに通知されます。

WSAProviderConfigChange が返す通知ハンドルは、通常のオペレーティングシステムのハンドルと同様であり、不要になったときに Windows の CloseHandle 呼び出しを使用してクローズする必要があります。

アプリケーションが常に最新のプロトコル構成情報を持つことを保証するために、次の一連の操作を使用できます。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

INT WSAProviderConfigChange(
    HANDLE* lpNotificationHandle,
    OVERLAPPED* lpOverlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine   // optional
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSAProviderConfigChange(
    IntPtr lpNotificationHandle,   // HANDLE* in/out
    IntPtr lpOverlapped,   // OVERLAPPED* optional, in/out
    IntPtr lpCompletionRoutine   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAProviderConfigChange(
    lpNotificationHandle As IntPtr,   ' HANDLE* in/out
    lpOverlapped As IntPtr,   ' OVERLAPPED* optional, in/out
    lpCompletionRoutine As IntPtr   ' LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
) As Integer
End Function
' lpNotificationHandle : HANDLE* in/out
' lpOverlapped : OVERLAPPED* optional, in/out
' lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
Declare PtrSafe Function WSAProviderConfigChange Lib "ws2_32" ( _
    ByVal lpNotificationHandle As LongPtr, _
    ByVal lpOverlapped As LongPtr, _
    ByVal lpCompletionRoutine As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSAProviderConfigChange = ctypes.windll.ws2_32.WSAProviderConfigChange
WSAProviderConfigChange.restype = ctypes.c_int
WSAProviderConfigChange.argtypes = [
    ctypes.c_void_p,  # lpNotificationHandle : HANDLE* in/out
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* optional, in/out
    ctypes.c_void_p,  # lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSAProviderConfigChange = ws2_32.NewProc("WSAProviderConfigChange")
)

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

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

typedef WSAProviderConfigChangeNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef WSAProviderConfigChangeDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final WSAProviderConfigChange = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSAProviderConfigChangeNative, WSAProviderConfigChangeDart>('WSAProviderConfigChange');
// lpNotificationHandle : HANDLE* in/out -> Pointer<Void>
// lpOverlapped : OVERLAPPED* optional, in/out -> Pointer<Void>
// lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSAProviderConfigChange(
  lpNotificationHandle: Pointer;   // HANDLE* in/out
  lpOverlapped: Pointer;   // OVERLAPPED* optional, in/out
  lpCompletionRoutine: Pointer   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSAProviderConfigChange';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSAProviderConfigChange"
  c_WSAProviderConfigChange :: Ptr () -> Ptr () -> Ptr () -> IO Int32
-- lpNotificationHandle : HANDLE* in/out -> Ptr ()
-- lpOverlapped : OVERLAPPED* optional, in/out -> Ptr ()
-- lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsaproviderconfigchange =
  foreign "WSAProviderConfigChange"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* lpNotificationHandle : HANDLE* in/out -> (ptr void) *)
(* lpOverlapped : OVERLAPPED* optional, in/out -> (ptr void) *)
(* lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> (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 ("WSAProviderConfigChange" wsaprovider-config-change :convention :stdcall) :int32
  (lp-notification-handle :pointer)   ; HANDLE* in/out
  (lp-overlapped :pointer)   ; OVERLAPPED* optional, in/out
  (lp-completion-routine :pointer))   ; LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSAProviderConfigChange = Win32::API::More->new('WS2_32',
    'int WSAProviderConfigChange(HANDLE lpNotificationHandle, LPVOID lpOverlapped, LPVOID lpCompletionRoutine)');
# my $ret = $WSAProviderConfigChange->Call($lpNotificationHandle, $lpOverlapped, $lpCompletionRoutine);
# lpNotificationHandle : HANDLE* in/out -> HANDLE
# lpOverlapped : OVERLAPPED* optional, in/out -> LPVOID
# lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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