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

WSAProviderCompleteAsyncCall

関数
プロバイダーの非同期呼び出しの完了を通知する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT WSAProviderCompleteAsyncCall(
    HANDLE hAsyncCall,
    INT iRetCode
);

パラメーター

名前方向説明
hAsyncCallHANDLEin完了する非同期呼び出しに渡されたハンドル。このハンドルは、非同期関数呼び出しの中で、クライアントからネームスペースのバージョン2プロバイダーに渡されます。
iRetCodeINTinネームスペースのバージョン2プロバイダーへの非同期呼び出しの戻りコード。

戻り値の型: INT

公式ドキュメント

ネームスペースのバージョン2プロバイダーへの非同期呼び出しが完了したことをクライアントに通知します。

戻り値

エラーが発生しなかった場合、 WSAProviderCompleteAsyncCall は 0 を返します。

関数が失敗した場合、戻り値は SOCKET_ERROR になります。拡張エラー情報を取得するには、 WSAGetLastError を呼び出します。この関数は、次の拡張エラー値のいずれかを返します。

エラーコード 意味
WSA_NOT_ENOUGH_MEMORY
操作を実行するのに十分なメモリがありませんでした。
WSAEFAULT
内部エラーが発生しました。
WSAEINVAL
パラメーターが無効でした。このエラーは、hAsyncCall パラメーターが **NULL** であった場合に返されます。
WSANOTINITIALISED
Ws2_32.dll が初期化されていません。アプリケーションは、いずれかの Windows Sockets 関数を呼び出す前に、まず WSAStartup を呼び出す必要があります。

解説(Remarks)

WSAProviderCompleteAsyncCall 関数は、Windows Vista 以降で利用可能なネームスペースサービスプロバイダーのバージョン2 (NSPv2) アーキテクチャの一部として使用されます。

Windows Vista および Windows Server 2008 では、WSAUnadvertiseProvider 関数は NS_EMAIL ネームスペースプロバイダーに対する操作にのみ使用できます。NSPv2 プロバイダーへの非同期呼び出しは、Windows Vista および Windows Server 2008 ではサポートされていません。したがって、WSAProviderCompleteAsyncCall は現時点では該当しません。この関数は、ネームスペースプロバイダーへの非同期呼び出しがサポートされる以降のバージョンの Windows での使用が予定されています。

一般に、NSPv2 プロバイダーは呼び出し元アプリケーション以外のプロセスで実装されます。NSPv2 プロバイダーは、クライアントのアクティビティの結果として有効化されるわけではありません。各プロバイダーホスティングアプリケーションは、WSAAdvertiseProvider および WSAUnadvertiseProvider 関数を呼び出すことで、特定のプロバイダーを利用可能または利用不可にするタイミングを決定します。クライアントのアクティビティは、プロバイダーが利用可能な場合 (ネームスペースプロバイダーがアドバタイズされている場合) にのみ、プロバイダーへの接続試行をもたらします。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 WSAProviderCompleteAsyncCall(
    HANDLE hAsyncCall,
    INT iRetCode
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSAProviderCompleteAsyncCall(
    IntPtr hAsyncCall,   // HANDLE
    int iRetCode   // INT
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAProviderCompleteAsyncCall(
    hAsyncCall As IntPtr,   ' HANDLE
    iRetCode As Integer   ' INT
) As Integer
End Function
' hAsyncCall : HANDLE
' iRetCode : INT
Declare PtrSafe Function WSAProviderCompleteAsyncCall Lib "ws2_32" ( _
    ByVal hAsyncCall As LongPtr, _
    ByVal iRetCode As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSAProviderCompleteAsyncCall = ctypes.windll.ws2_32.WSAProviderCompleteAsyncCall
WSAProviderCompleteAsyncCall.restype = ctypes.c_int
WSAProviderCompleteAsyncCall.argtypes = [
    wintypes.HANDLE,  # hAsyncCall : HANDLE
    ctypes.c_int,  # iRetCode : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSAProviderCompleteAsyncCall = ws2_32.NewProc("WSAProviderCompleteAsyncCall")
)

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

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

typedef WSAProviderCompleteAsyncCallNative = Int32 Function(Pointer<Void>, Int32);
typedef WSAProviderCompleteAsyncCallDart = int Function(Pointer<Void>, int);
final WSAProviderCompleteAsyncCall = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSAProviderCompleteAsyncCallNative, WSAProviderCompleteAsyncCallDart>('WSAProviderCompleteAsyncCall');
// hAsyncCall : HANDLE -> Pointer<Void>
// iRetCode : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSAProviderCompleteAsyncCall(
  hAsyncCall: THandle;   // HANDLE
  iRetCode: Integer   // INT
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSAProviderCompleteAsyncCall';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSAProviderCompleteAsyncCall"
  c_WSAProviderCompleteAsyncCall :: Ptr () -> Int32 -> IO Int32
-- hAsyncCall : HANDLE -> Ptr ()
-- iRetCode : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsaprovidercompleteasynccall =
  foreign "WSAProviderCompleteAsyncCall"
    ((ptr void) @-> int32_t @-> returning int32_t)
(* hAsyncCall : HANDLE -> (ptr void) *)
(* iRetCode : INT -> int32_t *)
(* 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 ("WSAProviderCompleteAsyncCall" wsaprovider-complete-async-call :convention :stdcall) :int32
  (h-async-call :pointer)   ; HANDLE
  (i-ret-code :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSAProviderCompleteAsyncCall = Win32::API::More->new('WS2_32',
    'int WSAProviderCompleteAsyncCall(HANDLE hAsyncCall, int iRetCode)');
# my $ret = $WSAProviderCompleteAsyncCall->Call($hAsyncCall, $iRetCode);
# hAsyncCall : HANDLE -> HANDLE
# iRetCode : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目