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

RoRegisterForApartmentShutdown

関数
アパートメント終了通知を受け取るコールバックを登録する。
DLLapi-ms-win-core-winrt-l1-1-0.dll呼出規約winapi対応OSwindows8.0

シグネチャ

// api-ms-win-core-winrt-l1-1-0.dll
#include <windows.h>

HRESULT RoRegisterForApartmentShutdown(
    IApartmentShutdown* callbackObject,
    ULONGLONG* apartmentIdentifier,
    APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* regCookie
);

パラメーター

名前方向説明
callbackObjectIApartmentShutdown*inアパートメント終了時に通知を受けるIApartmentShutdownコールバック。
apartmentIdentifierULONGLONG*out出力として現在のアパートメント識別子を受け取るULONGLONGポインタ。
regCookieAPARTMENT_SHUTDOWN_REGISTRATION_COOKIE*out出力として登録解除用のAPARTMENT_SHUTDOWN_REGISTRATION_COOKIEを受け取るポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

// api-ms-win-core-winrt-l1-1-0.dll
#include <windows.h>

HRESULT RoRegisterForApartmentShutdown(
    IApartmentShutdown* callbackObject,
    ULONGLONG* apartmentIdentifier,
    APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* regCookie
);
[DllImport("api-ms-win-core-winrt-l1-1-0.dll", ExactSpelling = true)]
static extern int RoRegisterForApartmentShutdown(
    IntPtr callbackObject,   // IApartmentShutdown*
    out ulong apartmentIdentifier,   // ULONGLONG* out
    IntPtr regCookie   // APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out
);
<DllImport("api-ms-win-core-winrt-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function RoRegisterForApartmentShutdown(
    callbackObject As IntPtr,   ' IApartmentShutdown*
    <Out> ByRef apartmentIdentifier As ULong,   ' ULONGLONG* out
    regCookie As IntPtr   ' APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out
) As Integer
End Function
' callbackObject : IApartmentShutdown*
' apartmentIdentifier : ULONGLONG* out
' regCookie : APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out
Declare PtrSafe Function RoRegisterForApartmentShutdown Lib "api-ms-win-core-winrt-l1-1-0" ( _
    ByVal callbackObject As LongPtr, _
    ByRef apartmentIdentifier As LongLong, _
    ByVal regCookie As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RoRegisterForApartmentShutdown = ctypes.windll.LoadLibrary("api-ms-win-core-winrt-l1-1-0.dll").RoRegisterForApartmentShutdown
RoRegisterForApartmentShutdown.restype = ctypes.c_int
RoRegisterForApartmentShutdown.argtypes = [
    ctypes.c_void_p,  # callbackObject : IApartmentShutdown*
    ctypes.POINTER(ctypes.c_ulonglong),  # apartmentIdentifier : ULONGLONG* out
    ctypes.c_void_p,  # regCookie : APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-winrt-l1-1-0.dll')
RoRegisterForApartmentShutdown = Fiddle::Function.new(
  lib['RoRegisterForApartmentShutdown'],
  [
    Fiddle::TYPE_VOIDP,  # callbackObject : IApartmentShutdown*
    Fiddle::TYPE_VOIDP,  # apartmentIdentifier : ULONGLONG* out
    Fiddle::TYPE_VOIDP,  # regCookie : APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-core-winrt-l1-1-0")]
extern "system" {
    fn RoRegisterForApartmentShutdown(
        callbackObject: *mut core::ffi::c_void,  // IApartmentShutdown*
        apartmentIdentifier: *mut u64,  // ULONGLONG* out
        regCookie: *mut *mut core::ffi::c_void  // APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("api-ms-win-core-winrt-l1-1-0.dll")]
public static extern int RoRegisterForApartmentShutdown(IntPtr callbackObject, out ulong apartmentIdentifier, IntPtr regCookie);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-winrt-l1-1-0_RoRegisterForApartmentShutdown' -Namespace Win32 -PassThru
# $api::RoRegisterForApartmentShutdown(callbackObject, apartmentIdentifier, regCookie)
#uselib "api-ms-win-core-winrt-l1-1-0.dll"
#func global RoRegisterForApartmentShutdown "RoRegisterForApartmentShutdown" sptr, sptr, sptr
; RoRegisterForApartmentShutdown callbackObject, varptr(apartmentIdentifier), regCookie   ; 戻り値は stat
; callbackObject : IApartmentShutdown* -> "sptr"
; apartmentIdentifier : ULONGLONG* out -> "sptr"
; regCookie : APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "api-ms-win-core-winrt-l1-1-0.dll"
#cfunc global RoRegisterForApartmentShutdown "RoRegisterForApartmentShutdown" sptr, var, sptr
; res = RoRegisterForApartmentShutdown(callbackObject, apartmentIdentifier, regCookie)
; callbackObject : IApartmentShutdown* -> "sptr"
; apartmentIdentifier : ULONGLONG* out -> "var"
; regCookie : APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT RoRegisterForApartmentShutdown(IApartmentShutdown* callbackObject, ULONGLONG* apartmentIdentifier, APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* regCookie)
#uselib "api-ms-win-core-winrt-l1-1-0.dll"
#cfunc global RoRegisterForApartmentShutdown "RoRegisterForApartmentShutdown" intptr, var, intptr
; res = RoRegisterForApartmentShutdown(callbackObject, apartmentIdentifier, regCookie)
; callbackObject : IApartmentShutdown* -> "intptr"
; apartmentIdentifier : ULONGLONG* out -> "var"
; regCookie : APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_core_winrt_l1_1_0 = windows.NewLazySystemDLL("api-ms-win-core-winrt-l1-1-0.dll")
	procRoRegisterForApartmentShutdown = api_ms_win_core_winrt_l1_1_0.NewProc("RoRegisterForApartmentShutdown")
)

// callbackObject (IApartmentShutdown*), apartmentIdentifier (ULONGLONG* out), regCookie (APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out)
r1, _, err := procRoRegisterForApartmentShutdown.Call(
	uintptr(callbackObject),
	uintptr(apartmentIdentifier),
	uintptr(regCookie),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function RoRegisterForApartmentShutdown(
  callbackObject: Pointer;   // IApartmentShutdown*
  apartmentIdentifier: Pointer;   // ULONGLONG* out
  regCookie: Pointer   // APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out
): Integer; stdcall;
  external 'api-ms-win-core-winrt-l1-1-0.dll' name 'RoRegisterForApartmentShutdown';
result := DllCall("api-ms-win-core-winrt-l1-1-0\RoRegisterForApartmentShutdown"
    , "Ptr", callbackObject   ; IApartmentShutdown*
    , "Ptr", apartmentIdentifier   ; ULONGLONG* out
    , "Ptr", regCookie   ; APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out
    , "Int")   ; return: HRESULT
●RoRegisterForApartmentShutdown(callbackObject, apartmentIdentifier, regCookie) = DLL("api-ms-win-core-winrt-l1-1-0.dll", "int RoRegisterForApartmentShutdown(void*, void*, void*)")
# 呼び出し: RoRegisterForApartmentShutdown(callbackObject, apartmentIdentifier, regCookie)
# callbackObject : IApartmentShutdown* -> "void*"
# apartmentIdentifier : ULONGLONG* out -> "void*"
# regCookie : APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef RoRegisterForApartmentShutdownNative = Int32 Function(Pointer<Void>, Pointer<Uint64>, Pointer<Void>);
typedef RoRegisterForApartmentShutdownDart = int Function(Pointer<Void>, Pointer<Uint64>, Pointer<Void>);
final RoRegisterForApartmentShutdown = DynamicLibrary.open('api-ms-win-core-winrt-l1-1-0.dll')
    .lookupFunction<RoRegisterForApartmentShutdownNative, RoRegisterForApartmentShutdownDart>('RoRegisterForApartmentShutdown');
// callbackObject : IApartmentShutdown* -> Pointer<Void>
// apartmentIdentifier : ULONGLONG* out -> Pointer<Uint64>
// regCookie : APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RoRegisterForApartmentShutdown(
  callbackObject: Pointer;   // IApartmentShutdown*
  apartmentIdentifier: Pointer;   // ULONGLONG* out
  regCookie: Pointer   // APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out
): Integer; stdcall;
  external 'api-ms-win-core-winrt-l1-1-0.dll' name 'RoRegisterForApartmentShutdown';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RoRegisterForApartmentShutdown"
  c_RoRegisterForApartmentShutdown :: Ptr () -> Ptr Word64 -> Ptr () -> IO Int32
-- callbackObject : IApartmentShutdown* -> Ptr ()
-- apartmentIdentifier : ULONGLONG* out -> Ptr Word64
-- regCookie : APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let roregisterforapartmentshutdown =
  foreign "RoRegisterForApartmentShutdown"
    ((ptr void) @-> (ptr uint64_t) @-> (ptr void) @-> returning int32_t)
(* callbackObject : IApartmentShutdown* -> (ptr void) *)
(* apartmentIdentifier : ULONGLONG* out -> (ptr uint64_t) *)
(* regCookie : APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library api-ms-win-core-winrt-l1-1-0 (t "api-ms-win-core-winrt-l1-1-0.dll"))
(cffi:use-foreign-library api-ms-win-core-winrt-l1-1-0)

(cffi:defcfun ("RoRegisterForApartmentShutdown" ro-register-for-apartment-shutdown :convention :stdcall) :int32
  (callback-object :pointer)   ; IApartmentShutdown*
  (apartment-identifier :pointer)   ; ULONGLONG* out
  (reg-cookie :pointer))   ; APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RoRegisterForApartmentShutdown = Win32::API::More->new('api-ms-win-core-winrt-l1-1-0',
    'int RoRegisterForApartmentShutdown(LPVOID callbackObject, LPVOID apartmentIdentifier, HANDLE regCookie)');
# my $ret = $RoRegisterForApartmentShutdown->Call($callbackObject, $apartmentIdentifier, $regCookie);
# callbackObject : IApartmentShutdown* -> LPVOID
# apartmentIdentifier : ULONGLONG* out -> LPVOID
# regCookie : APARTMENT_SHUTDOWN_REGISTRATION_COOKIE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型