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

CoInitializeEx

関数
指定した並行モデルでCOMライブラリを初期化する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoInitializeEx(
    void* pvReserved,   // optional
    DWORD dwCoInit
);

パラメーター

名前方向説明
pvReservedvoid*inoptionalこのパラメーターは予約されており、NULL を指定する必要があります。
dwCoInitDWORDinスレッドの並行性モデルおよび初期化オプション。このパラメーターの値は COINIT 列挙体から取得します。COINIT の値は任意に組み合わせて使用できますが、COINIT_APARTMENTTHREADED フラグと COINIT_MULTITHREADED フラグを同時に設定することはできません。既定値は COINIT_MULTITHREADED です。

戻り値の型: HRESULT

公式ドキュメント

呼び出し元スレッドで使用するために COM ライブラリを初期化し、スレッドの並行性モデルを設定し、必要に応じてスレッド用の新しいアパートメントを作成します。

戻り値

この関数は、標準の戻り値 E_INVALIDARGE_OUTOFMEMORYE_UNEXPECTED に加えて、次の値を返すことがあります。

戻り値 説明
S_OK
このスレッドで COM ライブラリが正常に初期化されました。
S_FALSE
このスレッドでは COM ライブラリが既に初期化されています。
RPC_E_CHANGED_MODE
以前の CoInitializeEx の呼び出しで、このスレッドに互換性のない並行性モデルが指定されました。これは、ニュートラルスレッドアパートメントからシングルスレッドアパートメントへの変更が発生したことを示している場合もあります。

解説(Remarks)

CoInitializeEx は、COM ライブラリを使用する各スレッドで少なくとも 1 回呼び出す必要があり、通常は 1 回だけ呼び出されます。同じスレッドから CoInitializeEx を複数回呼び出すことは、同じ並行性フラグを渡す限り許可されますが、それ以降の有効な呼び出しは S_FALSE を返します。 並行性フラグが一致しない場合、呼び出しは失敗し、RPC_E_CHANGED_MODE を返します。 (このルールに関して、CoInitialize の呼び出しは、COINIT_APARTMENTTHREADED フラグを指定して CoInitializeEx を呼び出すことと同等です。) スレッド上で COM ライブラリを正常に初期化解除するには、S_FALSE を返した呼び出しを含め、CoInitialize または CoInitializeEx の成功した各呼び出しを、対応する CoUninitialize の呼び出しと対にする必要があります。 スレッド上で COM が初期化解除された後は、上記の制約に従って任意のモードで再初期化できます。

ライブラリ関数を呼び出す前に、スレッド上で COM ライブラリを初期化する必要があります。ただし、標準アロケーターへのポインターを取得するための CoGetMalloc およびメモリ割り当て関数は例外です。 それ以外の場合、COM 関数は CO_E_NOTINITIALIZED を返します。

シングルスレッドアパートメント (STA) で作成されたオブジェクトは、そのアパートメントのスレッドからのみメソッド呼び出しを受け取るため、呼び出しはシリアル化され、メッセージキューの境界 (PeekMessage 関数または SendMessage 関数が呼び出されたとき) でのみ到着します。

マルチスレッドアパートメント (MTA) 内の COM スレッドで作成されたオブジェクトは、他のスレッドからのメソッド呼び出しをいつでも受け取れる必要があります。通常は、クリティカルセクション、セマフォ、ミューテックスなどの同期プリミティブを使用して、マルチスレッドオブジェクトのコード内に何らかの形態の並行性制御を実装し、オブジェクトのデータを保護します。

ニュートラルスレッドアパートメント (NTA) で実行するよう構成されたオブジェクトが、STA または MTA のいずれかにあるスレッドから呼び出されると、そのスレッドは NTA に移行します。このスレッドがその後 CoInitializeEx を呼び出すと、呼び出しは失敗し、RPC_E_CHANGED_MODE を返します。

OLE テクノロジはスレッドセーフではないため、OleInitialize 関数は COINIT_APARTMENTTHREADED フラグを指定して CoInitializeEx を呼び出します。その結果、マルチスレッドオブジェクトの並行性用に初期化されたアパートメントでは、OleInitialize によって有効になる機能を使用できません。

インプロセスサーバーが読み込まれる順序や解放される順序を制御する方法はないため、DllMain 関数から CoInitializeCoInitializeExCoUninitialize を呼び出さないでください。

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

各言語での呼び出し定義

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

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

CoInitializeEx = ctypes.windll.ole32.CoInitializeEx
CoInitializeEx.restype = ctypes.c_int
CoInitializeEx.argtypes = [
    ctypes.POINTER(None),  # pvReserved : void* optional
    wintypes.DWORD,  # dwCoInit : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoInitializeEx = ole32.NewProc("CoInitializeEx")
)

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

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

typedef CoInitializeExNative = Int32 Function(Pointer<Void>, Uint32);
typedef CoInitializeExDart = int Function(Pointer<Void>, int);
final CoInitializeEx = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoInitializeExNative, CoInitializeExDart>('CoInitializeEx');
// pvReserved : void* optional -> Pointer<Void>
// dwCoInit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoInitializeEx(
  pvReserved: Pointer;   // void* optional
  dwCoInit: DWORD   // DWORD
): Integer; stdcall;
  external 'OLE32.dll' name 'CoInitializeEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoInitializeEx"
  c_CoInitializeEx :: Ptr () -> Word32 -> IO Int32
-- pvReserved : void* optional -> Ptr ()
-- dwCoInit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let coinitializeex =
  foreign "CoInitializeEx"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* pvReserved : void* optional -> (ptr void) *)
(* dwCoInit : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CoInitializeEx" co-initialize-ex :convention :stdcall) :int32
  (pv-reserved :pointer)   ; void* optional
  (dw-co-init :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoInitializeEx = Win32::API::More->new('OLE32',
    'int CoInitializeEx(LPVOID pvReserved, DWORD dwCoInit)');
# my $ret = $CoInitializeEx->Call($pvReserved, $dwCoInit);
# pvReserved : void* optional -> LPVOID
# dwCoInit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API