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

CoIncrementMTAUsage

関数
マルチスレッドアパートメントの使用参照を増加させ維持する。
DLLOLE32.dll呼出規約winapi

シグネチャ

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

HRESULT CoIncrementMTAUsage(
    CO_MTA_USAGE_COOKIE* pCookie
);

パラメーター

名前方向説明
pCookieCO_MTA_USAGE_COOKIE*outCoDecrementMTAUsage 関数に渡すクッキーを受け取る PVOID 変数のアドレス。呼び出しが失敗した場合は NULL を受け取ります。

戻り値の型: HRESULT

公式ドキュメント

MTA スレッドが 1 つも実行されていない場合でも、MTA のサポートを有効な状態に保ちます。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

CoIncrementMTAUsage 関数を使用すると、クライアントは MTA ワーカーを作成し、プロセスを終了する前にそれらの完了を待機できます。

CoIncrementMTAUsage 関数は、MTA のスレッド数が 0 になった場合でも、システムが MTA サポートに関連するリソースを解放しないようにします。

成功した場合は、CoDecrementMTAUsage を 1 回だけ呼び出します。失敗した場合は、CoDecrementMTAUsage 関数を呼び出さないでください。

プロセスのシャットダウン中や dllmain 内では CoIncrementMTAUsage を呼び出さないでください。シャットダウン処理を開始する呼び出しの前であれば、CoIncrementMTAUsage を呼び出すことができます。

CoIncrementMTAUsage が以前に返したクッキーを CoDecrementMTAUsage に渡す限り、あるスレッドから CoIncrementMTAUsage を呼び出し、別のスレッドから CoDecrementMTAUsage を呼び出すことができます。

CoIncrementMTAUsage は、MTA がまだ存在しない場合に MTA を作成します。現在のスレッドがまだアパートメントに属していない場合、CoIncrementMTAUsage は現在のスレッドを MTA に配置します。

CoIncrementMTAUsage は、次のような場合に使用できます。

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

各言語での呼び出し定義

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

HRESULT CoIncrementMTAUsage(
    CO_MTA_USAGE_COOKIE* pCookie
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoIncrementMTAUsage(
    IntPtr pCookie   // CO_MTA_USAGE_COOKIE* out
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoIncrementMTAUsage(
    pCookie As IntPtr   ' CO_MTA_USAGE_COOKIE* out
) As Integer
End Function
' pCookie : CO_MTA_USAGE_COOKIE* out
Declare PtrSafe Function CoIncrementMTAUsage Lib "ole32" ( _
    ByVal pCookie As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CoIncrementMTAUsage = ctypes.windll.ole32.CoIncrementMTAUsage
CoIncrementMTAUsage.restype = ctypes.c_int
CoIncrementMTAUsage.argtypes = [
    ctypes.c_void_p,  # pCookie : CO_MTA_USAGE_COOKIE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoIncrementMTAUsage = Fiddle::Function.new(
  lib['CoIncrementMTAUsage'],
  [
    Fiddle::TYPE_VOIDP,  # pCookie : CO_MTA_USAGE_COOKIE* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ole32")]
extern "system" {
    fn CoIncrementMTAUsage(
        pCookie: *mut *mut core::ffi::c_void  // CO_MTA_USAGE_COOKIE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoIncrementMTAUsage(IntPtr pCookie);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoIncrementMTAUsage' -Namespace Win32 -PassThru
# $api::CoIncrementMTAUsage(pCookie)
#uselib "OLE32.dll"
#func global CoIncrementMTAUsage "CoIncrementMTAUsage" sptr
; CoIncrementMTAUsage pCookie   ; 戻り値は stat
; pCookie : CO_MTA_USAGE_COOKIE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "OLE32.dll"
#cfunc global CoIncrementMTAUsage "CoIncrementMTAUsage" sptr
; res = CoIncrementMTAUsage(pCookie)
; pCookie : CO_MTA_USAGE_COOKIE* out -> "sptr"
; HRESULT CoIncrementMTAUsage(CO_MTA_USAGE_COOKIE* pCookie)
#uselib "OLE32.dll"
#cfunc global CoIncrementMTAUsage "CoIncrementMTAUsage" intptr
; res = CoIncrementMTAUsage(pCookie)
; pCookie : CO_MTA_USAGE_COOKIE* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoIncrementMTAUsage = ole32.NewProc("CoIncrementMTAUsage")
)

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

extern "ole32" fn CoIncrementMTAUsage(
    pCookie: ?*anyopaque // CO_MTA_USAGE_COOKIE* out
) callconv(std.os.windows.WINAPI) i32;
proc CoIncrementMTAUsage(
    pCookie: pointer  # CO_MTA_USAGE_COOKIE* out
): int32 {.importc: "CoIncrementMTAUsage", stdcall, dynlib: "OLE32.dll".}
pragma(lib, "ole32");
extern(Windows)
int CoIncrementMTAUsage(
    void* pCookie   // CO_MTA_USAGE_COOKIE* out
);
ccall((:CoIncrementMTAUsage, "OLE32.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      pCookie)
# pCookie : CO_MTA_USAGE_COOKIE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CoIncrementMTAUsage(
    void* pCookie);
]]
local ole32 = ffi.load("ole32")
-- ole32.CoIncrementMTAUsage(pCookie)
-- pCookie : CO_MTA_USAGE_COOKIE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const CoIncrementMTAUsage = lib.func('__stdcall', 'CoIncrementMTAUsage', 'int32_t', ['void *']);
// CoIncrementMTAUsage(pCookie)
// pCookie : CO_MTA_USAGE_COOKIE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLE32.dll", {
  CoIncrementMTAUsage: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.CoIncrementMTAUsage(pCookie)
// pCookie : CO_MTA_USAGE_COOKIE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CoIncrementMTAUsage(
    void* pCookie);
C, "OLE32.dll");
// $ffi->CoIncrementMTAUsage(pCookie);
// pCookie : CO_MTA_USAGE_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 Ole32 extends StdCallLibrary {
    Ole32 INSTANCE = Native.load("ole32", Ole32.class);
    int CoIncrementMTAUsage(
        Pointer pCookie   // CO_MTA_USAGE_COOKIE* out
    );
}
@[Link("ole32")]
lib LibOLE32
  fun CoIncrementMTAUsage = CoIncrementMTAUsage(
    pCookie : Void*   # CO_MTA_USAGE_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 CoIncrementMTAUsageNative = Int32 Function(Pointer<Void>);
typedef CoIncrementMTAUsageDart = int Function(Pointer<Void>);
final CoIncrementMTAUsage = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoIncrementMTAUsageNative, CoIncrementMTAUsageDart>('CoIncrementMTAUsage');
// pCookie : CO_MTA_USAGE_COOKIE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoIncrementMTAUsage(
  pCookie: Pointer   // CO_MTA_USAGE_COOKIE* out
): Integer; stdcall;
  external 'OLE32.dll' name 'CoIncrementMTAUsage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoIncrementMTAUsage"
  c_CoIncrementMTAUsage :: Ptr () -> IO Int32
-- pCookie : CO_MTA_USAGE_COOKIE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let coincrementmtausage =
  foreign "CoIncrementMTAUsage"
    ((ptr void) @-> returning int32_t)
(* pCookie : CO_MTA_USAGE_COOKIE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CoIncrementMTAUsage" co-increment-mtausage :convention :stdcall) :int32
  (p-cookie :pointer))   ; CO_MTA_USAGE_COOKIE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoIncrementMTAUsage = Win32::API::More->new('OLE32',
    'int CoIncrementMTAUsage(HANDLE pCookie)');
# my $ret = $CoIncrementMTAUsage->Call($pCookie);
# pCookie : CO_MTA_USAGE_COOKIE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目