Win32 API 日本語リファレンス
ホーム › System.Rpc › RpcAsyncCompleteCall

RpcAsyncCompleteCall

関数
非同期RPC呼び出しを完了し応答を受け取る。
DLLRPCRT4.dll呼出規約winapi対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

RPC_STATUS RpcAsyncCompleteCall(
    RPC_ASYNC_STATE* pAsync,
    void* Reply   // optional
);

パラメーター

名前型方向説明
pAsyncRPC_ASYNC_STATE*inout非同期呼び出しの情報を格納する RPC_ASYNC_STATE 構造体へのポインターです。
Replyvoid*outoptionalリモート プロシージャ コールの戻り値を格納するバッファーへのポインターです。

戻り値の型: RPC_STATUS

公式ドキュメント

クライアントとサーバーは、非同期リモート プロシージャ コールを完了するために RpcAsyncCompleteCall 関数を呼び出します。

戻り値

次の値のほかに、 RpcAsyncCompleteCall は一般的な RPC エラーやアプリケーション固有のエラーを返すこともあります。

値 意味
RPC_S_OK
 呼び出しは正常に完了しました。
RPC_S_INVALID_ASYNC_HANDLE
 非同期呼び出しのハンドルが無効です。
RPC_S_ASYNC_CALL_PENDING
 呼び出しはまだ完了していません。
RPC_S_CALL_CANCELLED
 呼び出しはキャンセルされました。
注意 有効なエラー コードの一覧については、 RPC Return Values を参照してください。

解説(Remarks)

非同期 RPC 呼び出しを完了します。クライアントとサーバーの両方がこの関数を呼び出します。

クライアント: Reply は、応答を受け取るバッファーを指します。応答が到着する前にクライアントがこの関数を呼び出した場合、呼び出しは RPC_S_ASYNC_CALL_PENDING を返します。バッファーは有効であり、戻り値を受け取るのに十分な大きさである必要があります。この呼び出しが成功した場合、 [out] および [in, out] のパラメーターは有効です。呼び出しが RPC_S_ASYNC_CALL_PENDING を返さない場合、この RpcAsyncCompleteCall の呼び出しは、その RPC 呼び出しにとって最終的なものとなります。この関数の呼び出し後は、成功したか失敗したかにかかわらず、RPC ランタイムが割り当てたすべてのリソースが解放されます。RPC_ASYNC_STATE 構造体に対して新しい呼び出しが開始されるまで、以降の RpcAsyncCompleteCall 関数や RpcAsyncCancelCall 関数の呼び出しの結果は未定義です。

サーバー: Reply は、クライアントに送信する必要がある戻り値を格納するバッファーを指します。Reply に有効なバッファーを設定する必要があるのは、関数が戻り値の型を伴って宣言されている場合のみです。
RpcAsyncCompleteCall を呼び出す前に、[out] および [in, out] のパラメーターを更新しておく必要があります。これらのパラメーターと非同期ハンドルには、 RpcAsyncCompleteCall の呼び出しから戻った後は触れないでください。サーバー側での RpcAsyncCompleteCall の呼び出しは最終的なものです。 RpcAsyncCompleteCall 関数の呼び出しが失敗した場合、RPC ランタイムがパラメーターを解放します。

[out] のパラメーター ( [comm_status] および [fault_status] のパラメーターを含む) は、 RpcAsyncCompleteCall の戻り値が RPC_S_OK の場合にのみ有効です。

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

各言語での呼び出し定義

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

RPC_STATUS RpcAsyncCompleteCall(
    RPC_ASYNC_STATE* pAsync,
    void* Reply   // optional
);
[DllImport("RPCRT4.dll", ExactSpelling = true)]
static extern int RpcAsyncCompleteCall(
    IntPtr pAsync,   // RPC_ASYNC_STATE* in/out
    IntPtr Reply   // void* optional, out
);
<DllImport("RPCRT4.dll", ExactSpelling:=True)>
Public Shared Function RpcAsyncCompleteCall(
    pAsync As IntPtr,   ' RPC_ASYNC_STATE* in/out
    Reply As IntPtr   ' void* optional, out
) As Integer
End Function
' pAsync : RPC_ASYNC_STATE* in/out
' Reply : void* optional, out
Declare PtrSafe Function RpcAsyncCompleteCall Lib "rpcrt4" ( _
    ByVal pAsync As LongPtr, _
    ByVal Reply As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RpcAsyncCompleteCall = ctypes.windll.rpcrt4.RpcAsyncCompleteCall
RpcAsyncCompleteCall.restype = ctypes.c_int
RpcAsyncCompleteCall.argtypes = [
    ctypes.c_void_p,  # pAsync : RPC_ASYNC_STATE* in/out
    ctypes.POINTER(None),  # Reply : void* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
	procRpcAsyncCompleteCall = rpcrt4.NewProc("RpcAsyncCompleteCall")
)

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

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

typedef RpcAsyncCompleteCallNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef RpcAsyncCompleteCallDart = int Function(Pointer<Void>, Pointer<Void>);
final RpcAsyncCompleteCall = DynamicLibrary.open('RPCRT4.dll')
    .lookupFunction<RpcAsyncCompleteCallNative, RpcAsyncCompleteCallDart>('RpcAsyncCompleteCall');
// pAsync : RPC_ASYNC_STATE* in/out -> Pointer<Void>
// Reply : void* optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RpcAsyncCompleteCall(
  pAsync: Pointer;   // RPC_ASYNC_STATE* in/out
  Reply: Pointer   // void* optional, out
): Integer; stdcall;
  external 'RPCRT4.dll' name 'RpcAsyncCompleteCall';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RpcAsyncCompleteCall"
  c_RpcAsyncCompleteCall :: Ptr () -> Ptr () -> IO Int32
-- pAsync : RPC_ASYNC_STATE* in/out -> Ptr ()
-- Reply : void* optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rpcasynccompletecall =
  foreign "RpcAsyncCompleteCall"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* pAsync : RPC_ASYNC_STATE* in/out -> (ptr void) *)
(* Reply : void* optional, out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rpcrt4 (t "RPCRT4.dll"))
(cffi:use-foreign-library rpcrt4)

(cffi:defcfun ("RpcAsyncCompleteCall" rpc-async-complete-call :convention :stdcall) :int32
  (p-async :pointer)   ; RPC_ASYNC_STATE* in/out
  (reply :pointer))   ; void* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RpcAsyncCompleteCall = Win32::API::More->new('RPCRT4',
    'int RpcAsyncCompleteCall(LPVOID pAsync, LPVOID Reply)');
# my $ret = $RpcAsyncCompleteCall->Call($pAsync, $Reply);
# pAsync : RPC_ASYNC_STATE* in/out -> LPVOID
# Reply : void* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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