Win32 API 日本語リファレンス
ホームStorage.FileSystem › SetResourceManagerCompletionPort

SetResourceManagerCompletionPort

関数
KTMリソースマネージャーにI/O完了ポートを関連付ける。
DLLktmw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL SetResourceManagerCompletionPort(
    HANDLE ResourceManagerHandle,
    HANDLE IoCompletionPortHandle,
    UINT_PTR CompletionKey
);

パラメーター

名前方向説明
ResourceManagerHandleHANDLEinリソースマネージャーへのハンドルです。
IoCompletionPortHandleHANDLEinI/O 完了ポートへのハンドルです。
CompletionKeyUINT_PTRinユーザー定義の識別子です。通常、受信した通知を特定のリソースマネージャーに関連付けるために使用します。

戻り値の型: BOOL

公式ドキュメント

指定した I/O 完了ポートを、指定したリソースマネージャー (RM) に関連付けます。このポートは、その RM に対するすべての通知を受け取ります。

戻り値

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

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

次の一覧は、発生する可能性のあるエラーコードを示しています。

解説(Remarks)

この関数は、GetNotificationResourceManagerAsync 関数と組み合わせて使用する必要があります。この関数は、KTM が通知を非同期に配信するために使用するバッファーを提供します。これらの関数は、KTM から通知を受け取るための別の方法を提供します。これら 2 つの関数は、GetNotificationResourceManager 関数の代わりに使用できます。

この関数は、GetNotificationResourceManagerAsync を呼び出す前に呼び出す必要があります。

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

各言語での呼び出し定義

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

BOOL SetResourceManagerCompletionPort(
    HANDLE ResourceManagerHandle,
    HANDLE IoCompletionPortHandle,
    UINT_PTR CompletionKey
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetResourceManagerCompletionPort(
    IntPtr ResourceManagerHandle,   // HANDLE
    IntPtr IoCompletionPortHandle,   // HANDLE
    UIntPtr CompletionKey   // UINT_PTR
);
<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetResourceManagerCompletionPort(
    ResourceManagerHandle As IntPtr,   ' HANDLE
    IoCompletionPortHandle As IntPtr,   ' HANDLE
    CompletionKey As UIntPtr   ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' ResourceManagerHandle : HANDLE
' IoCompletionPortHandle : HANDLE
' CompletionKey : UINT_PTR
Declare PtrSafe Function SetResourceManagerCompletionPort Lib "ktmw32" ( _
    ByVal ResourceManagerHandle As LongPtr, _
    ByVal IoCompletionPortHandle As LongPtr, _
    ByVal CompletionKey As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetResourceManagerCompletionPort = ctypes.windll.ktmw32.SetResourceManagerCompletionPort
SetResourceManagerCompletionPort.restype = wintypes.BOOL
SetResourceManagerCompletionPort.argtypes = [
    wintypes.HANDLE,  # ResourceManagerHandle : HANDLE
    wintypes.HANDLE,  # IoCompletionPortHandle : HANDLE
    ctypes.c_size_t,  # CompletionKey : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	ktmw32 = windows.NewLazySystemDLL("ktmw32.dll")
	procSetResourceManagerCompletionPort = ktmw32.NewProc("SetResourceManagerCompletionPort")
)

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

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

typedef SetResourceManagerCompletionPortNative = Int32 Function(Pointer<Void>, Pointer<Void>, UintPtr);
typedef SetResourceManagerCompletionPortDart = int Function(Pointer<Void>, Pointer<Void>, int);
final SetResourceManagerCompletionPort = DynamicLibrary.open('ktmw32.dll')
    .lookupFunction<SetResourceManagerCompletionPortNative, SetResourceManagerCompletionPortDart>('SetResourceManagerCompletionPort');
// ResourceManagerHandle : HANDLE -> Pointer<Void>
// IoCompletionPortHandle : HANDLE -> Pointer<Void>
// CompletionKey : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetResourceManagerCompletionPort(
  ResourceManagerHandle: THandle;   // HANDLE
  IoCompletionPortHandle: THandle;   // HANDLE
  CompletionKey: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'ktmw32.dll' name 'SetResourceManagerCompletionPort';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetResourceManagerCompletionPort"
  c_SetResourceManagerCompletionPort :: Ptr () -> Ptr () -> CUIntPtr -> IO CInt
-- ResourceManagerHandle : HANDLE -> Ptr ()
-- IoCompletionPortHandle : HANDLE -> Ptr ()
-- CompletionKey : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setresourcemanagercompletionport =
  foreign "SetResourceManagerCompletionPort"
    ((ptr void) @-> (ptr void) @-> size_t @-> returning int32_t)
(* ResourceManagerHandle : HANDLE -> (ptr void) *)
(* IoCompletionPortHandle : HANDLE -> (ptr void) *)
(* CompletionKey : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ktmw32 (t "ktmw32.dll"))
(cffi:use-foreign-library ktmw32)

(cffi:defcfun ("SetResourceManagerCompletionPort" set-resource-manager-completion-port :convention :stdcall) :int32
  (resource-manager-handle :pointer)   ; HANDLE
  (io-completion-port-handle :pointer)   ; HANDLE
  (completion-key :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetResourceManagerCompletionPort = Win32::API::More->new('ktmw32',
    'BOOL SetResourceManagerCompletionPort(HANDLE ResourceManagerHandle, HANDLE IoCompletionPortHandle, WPARAM CompletionKey)');
# my $ret = $SetResourceManagerCompletionPort->Call($ResourceManagerHandle, $IoCompletionPortHandle, $CompletionKey);
# ResourceManagerHandle : HANDLE -> HANDLE
# IoCompletionPortHandle : HANDLE -> HANDLE
# CompletionKey : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目