ホーム › System.Ole › OleInitialize
OleInitialize
関数現在のスレッドでOLEライブラリを初期化する。
シグネチャ
// OLE32.dll
#include <windows.h>
HRESULT OleInitialize(
void* pvReserved
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pvReserved | void* | in | このパラメーターは予約されており、NULL を指定する必要があります。 |
戻り値の型: HRESULT
公式ドキュメント
現在のアパートメントで COM ライブラリを初期化し、並行性モデルをシングルスレッドアパートメント (STA) として指定したうえで、以下の「Remarks」セクションで説明する追加機能を有効にします。
戻り値
この関数は成功時に S_OK を返します。その他に返される可能性のある値は次のとおりです。
| 戻り値 | 説明 |
|---|---|
| このアパートメントでは COM ライブラリが既に初期化されています。 | |
| お使いのマシン上の COMPOBJ.DLL と OLE2.DLL のバージョンが互いに互換性がありません。 | |
| 以前の CoInitializeEx の呼び出しで、このアパートメントの並行性モデルがマルチスレッドアパートメント (MTA) として指定されています。これは、ニュートラルスレッドアパートメントからシングルスレッドアパートメントへの変更が発生したことを意味する場合もあります。 |
解説(Remarks)
次の機能を使用するアプリケーションは、COM ライブラリの他の関数を呼び出す前に OleInitialize を呼び出す必要があります。
- クリップボード
- ドラッグ アンド ドロップ
- オブジェクトのリンクと埋め込み (OLE)
- インプレース アクティベーション
アパートメントの並行性モデルは、いったん設定すると変更できません。以前にマルチスレッドとして初期化されたアパートメントで OleInitialize を呼び出すと失敗し、RPC_E_CHANGED_MODE が返されます。
標準アロケーターへのポインターを取得するための CoGetMalloc およびメモリ割り当て関数を除き、ライブラリの関数を呼び出す前にアパートメントで COM ライブラリを初期化する必要があります。
通常、COM ライブラリはアパートメントごとに一度だけ初期化されます。以降の呼び出しは、アパートメントの並行性モデルを変更しようとしない限り成功しますが、S_FALSE を返します。COM ライブラリを正常に終了するには、S_FALSE を返したものを含め、OleInitialize の成功した各呼び出しを、対応する OleUninitialize の呼び出しで対にする必要があります。
インプロセスサーバーの読み込みや解放の順序を制御する方法はないため、DllMain 関数から OleInitialize や OleUninitialize を呼び出さないでください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// OLE32.dll
#include <windows.h>
HRESULT OleInitialize(
void* pvReserved
);[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleInitialize(
IntPtr pvReserved // void*
);<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleInitialize(
pvReserved As IntPtr ' void*
) As Integer
End Function' pvReserved : void*
Declare PtrSafe Function OleInitialize 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
OleInitialize = ctypes.windll.ole32.OleInitialize
OleInitialize.restype = ctypes.c_int
OleInitialize.argtypes = [
ctypes.POINTER(None), # pvReserved : void*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLE32.dll')
OleInitialize = Fiddle::Function.new(
lib['OleInitialize'],
[
Fiddle::TYPE_VOIDP, # pvReserved : void*
],
Fiddle::TYPE_INT)#[link(name = "ole32")]
extern "system" {
fn OleInitialize(
pvReserved: *mut () // void*
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleInitialize(IntPtr pvReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleInitialize' -Namespace Win32 -PassThru
# $api::OleInitialize(pvReserved)#uselib "OLE32.dll"
#func global OleInitialize "OleInitialize" sptr
; OleInitialize pvReserved ; 戻り値は stat
; pvReserved : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "OLE32.dll"
#cfunc global OleInitialize "OleInitialize" sptr
; res = OleInitialize(pvReserved)
; pvReserved : void* -> "sptr"; HRESULT OleInitialize(void* pvReserved)
#uselib "OLE32.dll"
#cfunc global OleInitialize "OleInitialize" intptr
; res = OleInitialize(pvReserved)
; pvReserved : void* -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ole32 = windows.NewLazySystemDLL("OLE32.dll")
procOleInitialize = ole32.NewProc("OleInitialize")
)
// pvReserved (void*)
r1, _, err := procOleInitialize.Call(
uintptr(pvReserved),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction OleInitialize(
pvReserved: Pointer // void*
): Integer; stdcall;
external 'OLE32.dll' name 'OleInitialize';result := DllCall("OLE32\OleInitialize"
, "Ptr", pvReserved ; void*
, "Int") ; return: HRESULT●OleInitialize(pvReserved) = DLL("OLE32.dll", "int OleInitialize(void*)")
# 呼び出し: OleInitialize(pvReserved)
# pvReserved : void* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ole32" fn OleInitialize(
pvReserved: ?*anyopaque // void*
) callconv(std.os.windows.WINAPI) i32;proc OleInitialize(
pvReserved: pointer # void*
): int32 {.importc: "OleInitialize", stdcall, dynlib: "OLE32.dll".}pragma(lib, "ole32");
extern(Windows)
int OleInitialize(
void* pvReserved // void*
);ccall((:OleInitialize, "OLE32.dll"), stdcall, Int32,
(Ptr{Cvoid},),
pvReserved)
# pvReserved : void* -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t OleInitialize(
void* pvReserved);
]]
local ole32 = ffi.load("ole32")
-- ole32.OleInitialize(pvReserved)
-- pvReserved : void*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const OleInitialize = lib.func('__stdcall', 'OleInitialize', 'int32_t', ['void *']);
// OleInitialize(pvReserved)
// pvReserved : void* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLE32.dll", {
OleInitialize: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.OleInitialize(pvReserved)
// pvReserved : void* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t OleInitialize(
void* pvReserved);
C, "OLE32.dll");
// $ffi->OleInitialize(pvReserved);
// pvReserved : void*
// 構造体/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 OleInitialize(
Pointer pvReserved // void*
);
}@[Link("ole32")]
lib LibOLE32
fun OleInitialize = OleInitialize(
pvReserved : Void* # void*
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef OleInitializeNative = Int32 Function(Pointer<Void>);
typedef OleInitializeDart = int Function(Pointer<Void>);
final OleInitialize = DynamicLibrary.open('OLE32.dll')
.lookupFunction<OleInitializeNative, OleInitializeDart>('OleInitialize');
// pvReserved : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function OleInitialize(
pvReserved: Pointer // void*
): Integer; stdcall;
external 'OLE32.dll' name 'OleInitialize';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "OleInitialize"
c_OleInitialize :: Ptr () -> IO Int32
-- pvReserved : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let oleinitialize =
foreign "OleInitialize"
((ptr void) @-> returning int32_t)
(* pvReserved : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)
(cffi:defcfun ("OleInitialize" ole-initialize :convention :stdcall) :int32
(pv-reserved :pointer)) ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $OleInitialize = Win32::API::More->new('OLE32',
'int OleInitialize(LPVOID pvReserved)');
# my $ret = $OleInitialize->Call($pvReserved);
# pvReserved : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f CoInitializeEx — 指定した並行モデルでCOMライブラリを初期化する。
- f OleUninitialize — OLEライブラリを終了し関連リソースを解放する。