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

PostQueuedCompletionStatus

関数
I/O完了ポートに完了パケットを投入する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL PostQueuedCompletionStatus(
    HANDLE CompletionPort,
    DWORD dwNumberOfBytesTransferred,
    UINT_PTR dwCompletionKey,
    OVERLAPPED* lpOverlapped   // optional
);

パラメーター

名前方向説明
CompletionPortHANDLEinI/O 完了パケットのポスト先となる I/O 完了ポートへのハンドル。
dwNumberOfBytesTransferredDWORDinGetQueuedCompletionStatus 関数の lpNumberOfBytesTransferred パラメーターを通じて返される値。
dwCompletionKeyUINT_PTRinGetQueuedCompletionStatus 関数の lpCompletionKey パラメーターを通じて返される値。
lpOverlappedOVERLAPPED*inoptionalGetQueuedCompletionStatus 関数の lpOverlapped パラメーターを通じて返される値。

戻り値の型: BOOL

公式ドキュメント

I/O 完了パケットを I/O 完了ポートにポストします。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

I/O 完了パケットは、 GetQueuedCompletionStatus 関数への未処理の呼び出しを満たします。この関数は、PostQueuedCompletionStatus の呼び出しの第 2、第 3、第 4 パラメーターとして渡された 3 つの値を返します。システムはこれらの値を使用したり検証したりしません。特に、lpOverlapped パラメーターが OVERLAPPED 構造体を指している必要はありません。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 トランスペアレント フェールオーバー (TFO) はい
SMB 3.0 とスケールアウト ファイル共有 (SO) はい
クラスターの共有ボリューム ファイル システム (CsvFS) はい
回復性のあるファイル システム (ReFS) はい

CsvFs は、圧縮ファイルに対してリダイレクト I/O を実行します。

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

各言語での呼び出し定義

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

BOOL PostQueuedCompletionStatus(
    HANDLE CompletionPort,
    DWORD dwNumberOfBytesTransferred,
    UINT_PTR dwCompletionKey,
    OVERLAPPED* lpOverlapped   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool PostQueuedCompletionStatus(
    IntPtr CompletionPort,   // HANDLE
    uint dwNumberOfBytesTransferred,   // DWORD
    UIntPtr dwCompletionKey,   // UINT_PTR
    IntPtr lpOverlapped   // OVERLAPPED* optional
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PostQueuedCompletionStatus(
    CompletionPort As IntPtr,   ' HANDLE
    dwNumberOfBytesTransferred As UInteger,   ' DWORD
    dwCompletionKey As UIntPtr,   ' UINT_PTR
    lpOverlapped As IntPtr   ' OVERLAPPED* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' CompletionPort : HANDLE
' dwNumberOfBytesTransferred : DWORD
' dwCompletionKey : UINT_PTR
' lpOverlapped : OVERLAPPED* optional
Declare PtrSafe Function PostQueuedCompletionStatus Lib "kernel32" ( _
    ByVal CompletionPort As LongPtr, _
    ByVal dwNumberOfBytesTransferred As Long, _
    ByVal dwCompletionKey As LongPtr, _
    ByVal lpOverlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PostQueuedCompletionStatus = ctypes.windll.kernel32.PostQueuedCompletionStatus
PostQueuedCompletionStatus.restype = wintypes.BOOL
PostQueuedCompletionStatus.argtypes = [
    wintypes.HANDLE,  # CompletionPort : HANDLE
    wintypes.DWORD,  # dwNumberOfBytesTransferred : DWORD
    ctypes.c_size_t,  # dwCompletionKey : UINT_PTR
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procPostQueuedCompletionStatus = kernel32.NewProc("PostQueuedCompletionStatus")
)

// CompletionPort (HANDLE), dwNumberOfBytesTransferred (DWORD), dwCompletionKey (UINT_PTR), lpOverlapped (OVERLAPPED* optional)
r1, _, err := procPostQueuedCompletionStatus.Call(
	uintptr(CompletionPort),
	uintptr(dwNumberOfBytesTransferred),
	uintptr(dwCompletionKey),
	uintptr(lpOverlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function PostQueuedCompletionStatus(
  CompletionPort: THandle;   // HANDLE
  dwNumberOfBytesTransferred: DWORD;   // DWORD
  dwCompletionKey: NativeUInt;   // UINT_PTR
  lpOverlapped: Pointer   // OVERLAPPED* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'PostQueuedCompletionStatus';
result := DllCall("KERNEL32\PostQueuedCompletionStatus"
    , "Ptr", CompletionPort   ; HANDLE
    , "UInt", dwNumberOfBytesTransferred   ; DWORD
    , "UPtr", dwCompletionKey   ; UINT_PTR
    , "Ptr", lpOverlapped   ; OVERLAPPED* optional
    , "Int")   ; return: BOOL
●PostQueuedCompletionStatus(CompletionPort, dwNumberOfBytesTransferred, dwCompletionKey, lpOverlapped) = DLL("KERNEL32.dll", "bool PostQueuedCompletionStatus(void*, dword, int, void*)")
# 呼び出し: PostQueuedCompletionStatus(CompletionPort, dwNumberOfBytesTransferred, dwCompletionKey, lpOverlapped)
# CompletionPort : HANDLE -> "void*"
# dwNumberOfBytesTransferred : DWORD -> "dword"
# dwCompletionKey : UINT_PTR -> "int"
# lpOverlapped : OVERLAPPED* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef PostQueuedCompletionStatusNative = Int32 Function(Pointer<Void>, Uint32, UintPtr, Pointer<Void>);
typedef PostQueuedCompletionStatusDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final PostQueuedCompletionStatus = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<PostQueuedCompletionStatusNative, PostQueuedCompletionStatusDart>('PostQueuedCompletionStatus');
// CompletionPort : HANDLE -> Pointer<Void>
// dwNumberOfBytesTransferred : DWORD -> Uint32
// dwCompletionKey : UINT_PTR -> UintPtr
// lpOverlapped : OVERLAPPED* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PostQueuedCompletionStatus(
  CompletionPort: THandle;   // HANDLE
  dwNumberOfBytesTransferred: DWORD;   // DWORD
  dwCompletionKey: NativeUInt;   // UINT_PTR
  lpOverlapped: Pointer   // OVERLAPPED* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'PostQueuedCompletionStatus';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PostQueuedCompletionStatus"
  c_PostQueuedCompletionStatus :: Ptr () -> Word32 -> CUIntPtr -> Ptr () -> IO CInt
-- CompletionPort : HANDLE -> Ptr ()
-- dwNumberOfBytesTransferred : DWORD -> Word32
-- dwCompletionKey : UINT_PTR -> CUIntPtr
-- lpOverlapped : OVERLAPPED* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let postqueuedcompletionstatus =
  foreign "PostQueuedCompletionStatus"
    ((ptr void) @-> uint32_t @-> size_t @-> (ptr void) @-> returning int32_t)
(* CompletionPort : HANDLE -> (ptr void) *)
(* dwNumberOfBytesTransferred : DWORD -> uint32_t *)
(* dwCompletionKey : UINT_PTR -> size_t *)
(* lpOverlapped : OVERLAPPED* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("PostQueuedCompletionStatus" post-queued-completion-status :convention :stdcall) :int32
  (completion-port :pointer)   ; HANDLE
  (dw-number-of-bytes-transferred :uint32)   ; DWORD
  (dw-completion-key :uint64)   ; UINT_PTR
  (lp-overlapped :pointer))   ; OVERLAPPED* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PostQueuedCompletionStatus = Win32::API::More->new('KERNEL32',
    'BOOL PostQueuedCompletionStatus(HANDLE CompletionPort, DWORD dwNumberOfBytesTransferred, WPARAM dwCompletionKey, LPVOID lpOverlapped)');
# my $ret = $PostQueuedCompletionStatus->Call($CompletionPort, $dwNumberOfBytesTransferred, $dwCompletionKey, $lpOverlapped);
# CompletionPort : HANDLE -> HANDLE
# dwNumberOfBytesTransferred : DWORD -> DWORD
# dwCompletionKey : UINT_PTR -> WPARAM
# lpOverlapped : OVERLAPPED* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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