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

OpenEnlistment

関数
既存のKTMエンリストメントをIDで開く。
DLLktmw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

HANDLE OpenEnlistment(
    DWORD dwDesiredAccess,
    HANDLE ResourceManagerHandle,
    GUID* EnlistmentId
);

パラメーター

名前方向説明
dwDesiredAccessDWORDinこのエンリストメントに対して要求するアクセス権です。有効な値の一覧については、Enlistment Access Masks を参照してください。
ResourceManagerHandleHANDLEinリソース マネージャーへのハンドルです。
EnlistmentIdGUID*inoutエンリストメント識別子です。

戻り値の型: HANDLE

公式ドキュメント

既存のエンリストメント オブジェクトを開き、そのエンリストメントへのハンドルを返します。

戻り値

関数が成功した場合、戻り値はエンリストメントへのハンドルです。

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

次の一覧は、発生し得るエラー コードを示しています:

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

各言語での呼び出し定義

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

HANDLE OpenEnlistment(
    DWORD dwDesiredAccess,
    HANDLE ResourceManagerHandle,
    GUID* EnlistmentId
);
[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr OpenEnlistment(
    uint dwDesiredAccess,   // DWORD
    IntPtr ResourceManagerHandle,   // HANDLE
    ref Guid EnlistmentId   // GUID* in/out
);
<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenEnlistment(
    dwDesiredAccess As UInteger,   ' DWORD
    ResourceManagerHandle As IntPtr,   ' HANDLE
    ByRef EnlistmentId As Guid   ' GUID* in/out
) As IntPtr
End Function
' dwDesiredAccess : DWORD
' ResourceManagerHandle : HANDLE
' EnlistmentId : GUID* in/out
Declare PtrSafe Function OpenEnlistment Lib "ktmw32" ( _
    ByVal dwDesiredAccess As Long, _
    ByVal ResourceManagerHandle As LongPtr, _
    ByVal EnlistmentId As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OpenEnlistment = ctypes.windll.ktmw32.OpenEnlistment
OpenEnlistment.restype = ctypes.c_void_p
OpenEnlistment.argtypes = [
    wintypes.DWORD,  # dwDesiredAccess : DWORD
    wintypes.HANDLE,  # ResourceManagerHandle : HANDLE
    ctypes.c_void_p,  # EnlistmentId : GUID* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	ktmw32 = windows.NewLazySystemDLL("ktmw32.dll")
	procOpenEnlistment = ktmw32.NewProc("OpenEnlistment")
)

// dwDesiredAccess (DWORD), ResourceManagerHandle (HANDLE), EnlistmentId (GUID* in/out)
r1, _, err := procOpenEnlistment.Call(
	uintptr(dwDesiredAccess),
	uintptr(ResourceManagerHandle),
	uintptr(EnlistmentId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function OpenEnlistment(
  dwDesiredAccess: DWORD;   // DWORD
  ResourceManagerHandle: THandle;   // HANDLE
  EnlistmentId: PGUID   // GUID* in/out
): THandle; stdcall;
  external 'ktmw32.dll' name 'OpenEnlistment';
result := DllCall("ktmw32\OpenEnlistment"
    , "UInt", dwDesiredAccess   ; DWORD
    , "Ptr", ResourceManagerHandle   ; HANDLE
    , "Ptr", EnlistmentId   ; GUID* in/out
    , "Ptr")   ; return: HANDLE
●OpenEnlistment(dwDesiredAccess, ResourceManagerHandle, EnlistmentId) = DLL("ktmw32.dll", "void* OpenEnlistment(dword, void*, void*)")
# 呼び出し: OpenEnlistment(dwDesiredAccess, ResourceManagerHandle, EnlistmentId)
# dwDesiredAccess : DWORD -> "dword"
# ResourceManagerHandle : HANDLE -> "void*"
# EnlistmentId : GUID* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef OpenEnlistmentNative = Pointer<Void> Function(Uint32, Pointer<Void>, Pointer<Void>);
typedef OpenEnlistmentDart = Pointer<Void> Function(int, Pointer<Void>, Pointer<Void>);
final OpenEnlistment = DynamicLibrary.open('ktmw32.dll')
    .lookupFunction<OpenEnlistmentNative, OpenEnlistmentDart>('OpenEnlistment');
// dwDesiredAccess : DWORD -> Uint32
// ResourceManagerHandle : HANDLE -> Pointer<Void>
// EnlistmentId : GUID* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenEnlistment(
  dwDesiredAccess: DWORD;   // DWORD
  ResourceManagerHandle: THandle;   // HANDLE
  EnlistmentId: PGUID   // GUID* in/out
): THandle; stdcall;
  external 'ktmw32.dll' name 'OpenEnlistment';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenEnlistment"
  c_OpenEnlistment :: Word32 -> Ptr () -> Ptr () -> IO (Ptr ())
-- dwDesiredAccess : DWORD -> Word32
-- ResourceManagerHandle : HANDLE -> Ptr ()
-- EnlistmentId : GUID* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let openenlistment =
  foreign "OpenEnlistment"
    (uint32_t @-> (ptr void) @-> (ptr void) @-> returning (ptr void))
(* dwDesiredAccess : DWORD -> uint32_t *)
(* ResourceManagerHandle : HANDLE -> (ptr void) *)
(* EnlistmentId : GUID* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ktmw32 (t "ktmw32.dll"))
(cffi:use-foreign-library ktmw32)

(cffi:defcfun ("OpenEnlistment" open-enlistment :convention :stdcall) :pointer
  (dw-desired-access :uint32)   ; DWORD
  (resource-manager-handle :pointer)   ; HANDLE
  (enlistment-id :pointer))   ; GUID* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenEnlistment = Win32::API::More->new('ktmw32',
    'HANDLE OpenEnlistment(DWORD dwDesiredAccess, HANDLE ResourceManagerHandle, LPVOID EnlistmentId)');
# my $ret = $OpenEnlistment->Call($dwDesiredAccess, $ResourceManagerHandle, $EnlistmentId);
# dwDesiredAccess : DWORD -> DWORD
# ResourceManagerHandle : HANDLE -> HANDLE
# EnlistmentId : GUID* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目