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

CoInitialize

関数
現在のスレッドでCOMライブラリを初期化する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoInitialize(
    void* pvReserved   // optional
);

パラメーター

名前方向説明
pvReservedvoid*inoptionalこのパラメーターは予約されており、NULL でなければなりません。

戻り値の型: HRESULT

公式ドキュメント

現在のスレッドで COM ライブラリを初期化し、並行性モデルをシングルスレッドアパートメント (STA) として指定します。

戻り値

この関数は、標準的な戻り値 E_INVALIDARGE_OUTOFMEMORYE_UNEXPECTED に加え、以下の値を返すことがあります。

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

解説(Remarks)

標準アロケーターへのポインターを取得するための CoGetMalloc とメモリ割り当て関数を除き、ライブラリの関数を呼び出す前に、スレッドで COM ライブラリを初期化する必要があります。

スレッドの並行性モデルは一度設定すると変更できません。以前にマルチスレッドとして初期化されたアパートメントに対して CoInitialize を呼び出すと失敗し、RPC_E_CHANGED_MODE を返します。

CoInitializeExCoInitialize と同じ機能を提供するとともに、スレッドの並行性モデルを明示的に指定するためのパラメーターも提供します。CoInitializeCoInitializeEx を呼び出し、並行性モデルをシングルスレッドアパートメントとして指定します。今日開発されるアプリケーションでは、CoInitialize ではなく CoInitializeEx を呼び出すべきです。

通常、COM ライブラリはスレッドにつき一度だけ初期化されます。同じスレッドで CoInitialize または CoInitializeEx を続けて呼び出した場合、並行性モデルを変更しようとしない限り成功しますが、S_FALSE を返します。COM ライブラリを正しく終了するには、S_FALSE を返したものも含め、CoInitialize または CoInitializeEx の成功した各呼び出しを、対応する CoUninitialize の呼び出しと対にする必要があります。ただし、アプリケーション内で CoInitialize を 0 で(または CoInitializeExCOINIT_APARTMENTTHREADED で)呼び出した最初のスレッドは、CoUninitialize を呼び出す最後のスレッドでなければなりません。そうでない場合、STA に対する以降の CoInitialize の呼び出しは失敗し、アプリケーションは動作しなくなります。

インプロセスサーバーが読み込まれる順序やアンロードされる順序を制御する方法はないため、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 CoInitialize(
    void* pvReserved   // optional
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoInitialize(
    IntPtr pvReserved   // void* optional
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoInitialize(
    pvReserved As IntPtr   ' void* optional
) As Integer
End Function
' pvReserved : void* optional
Declare PtrSafe Function CoInitialize Lib "ole32" ( _
    ByVal pvReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoInitialize = ole32.NewProc("CoInitialize")
)

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

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

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

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

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

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

関連項目

類似 API