ホーム › System.Com › CoCreateFreeThreadedMarshaler
CoCreateFreeThreadedMarshaler
関数フリースレッドマーシャラを作成して集約する。
シグネチャ
// OLE32.dll
#include <windows.h>
HRESULT CoCreateFreeThreadedMarshaler(
IUnknown* punkOuter, // optional
IUnknown** ppunkMarshal
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| punkOuter | IUnknown* | inoptional | 集約するオブジェクトの制御 IUnknown へのポインターです。 |
| ppunkMarshal | IUnknown** | out | 集約可能なマーシャラーへのインターフェイス ポインターを受け取るポインター変数のアドレスです。 |
戻り値の型: HRESULT
公式ドキュメント
コンテキスト依存のマーシャリングが可能な、集約可能なオブジェクトを作成します。
戻り値
この関数は、標準の戻り値 E_OUTOFMEMORY のほか、次の値を返すことがあります。
| 戻り値 | 説明 |
|---|---|
| マーシャラーが作成されました。 |
解説(Remarks)
CoCreateFreeThreadedMarshaler 関数は、同一プロセス内のスレッド間でインターフェイス ポインターを効率的にマーシャリングできるようにします。オブジェクトがスレッド間マーシャリングをサポートしない場合、この関数を呼び出す必要はありません。この関数は、シングルスレッド アパートメントに関連付けられたスレッドを含め、プロセス内のすべてのスレッドから直接アクセスされる必要があるフリースレッド DLL サーバーでの使用を意図しています。実メモリ ポインターを偽の「プロキシ」として他のアパートメントへカスタム マーシャリングすることで、呼び出し元がフリースレッドでない場合でも、すべての呼び出し元に直接アクセスを提供します。
CoCreateFreeThreadedMarshaler 関数は、次のタスクを実行します。
- フリースレッド マーシャラー オブジェクトを作成します。
- このマーシャラーを punkOuter パラメーターで指定されたオブジェクトに集約します。通常、このオブジェクトはインターフェイス ポインターをマーシャリングする対象のオブジェクトです。
- CoMarshalInterface 関数の dwDestContext パラメーターで指定された宛先コンテキストを確認します。
- 宛先コンテキストが MSHCTX_INPROC の場合、インターフェイス ポインターをマーシャリング ストリームにコピーします。
- 宛先コンテキストがそれ以外の値の場合、COM の既定 (標準) マーシャラーのインスタンスを検索または作成し、マーシャリングをそのマーシャラーに委譲します。
CoCreateFreeThreadedMarshaler 関数を使用する際は、細心の注意を払う必要があります。これは、フリースレッド マーシャラーを集約するオブジェクトのパフォーマンスが、COM のルールを意図的に破ることによって得られているためであり、オブジェクトが一定の制限の範囲内で動作しない限り、常に未定義の動作を引き起こすリスクが伴います。最も重要な制限は次のとおりです。
- フリースレッド マーシャラー オブジェクトは、フリースレッド マーシャラーを自身の状態の一部として集約していないオブジェクトのインターフェイスへの直接ポインターを保持できません。オブジェクトが通常のシングルスレッド集約オブジェクトへの直接参照を使用すると、それらのシングルスレッド特性を損なう可能性があります。通常のマルチスレッド集約オブジェクトへの直接参照を使用すると、それらのオブジェクトは、直接的なシングルスレッド集約クライアントの要求に対する配慮を欠いた挙動を示すことがあります。たとえば、これらのオブジェクトは新しいスレッドを生成し、通常のシングルスレッド集約オブジェクトへの参照であるパラメーターをそのスレッドに渡す可能性があります。
- フリースレッド マーシャラー オブジェクトは、他のアパートメント内のオブジェクトへのプロキシへの参照を保持できません。プロキシはスレッド モデルに依存しており、誤ったクライアントから呼び出された場合は RPC_E_WRONG_THREAD を返すことがあります。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CoCreateFreeThreadedMarshaler(
IUnknown* punkOuter, // optional
IUnknown** ppunkMarshal
);[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoCreateFreeThreadedMarshaler(
IntPtr punkOuter, // IUnknown* optional
IntPtr ppunkMarshal // IUnknown** out
);<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoCreateFreeThreadedMarshaler(
punkOuter As IntPtr, ' IUnknown* optional
ppunkMarshal As IntPtr ' IUnknown** out
) As Integer
End Function' punkOuter : IUnknown* optional
' ppunkMarshal : IUnknown** out
Declare PtrSafe Function CoCreateFreeThreadedMarshaler Lib "ole32" ( _
ByVal punkOuter As LongPtr, _
ByVal ppunkMarshal As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CoCreateFreeThreadedMarshaler = ctypes.windll.ole32.CoCreateFreeThreadedMarshaler
CoCreateFreeThreadedMarshaler.restype = ctypes.c_int
CoCreateFreeThreadedMarshaler.argtypes = [
ctypes.c_void_p, # punkOuter : IUnknown* optional
ctypes.c_void_p, # ppunkMarshal : IUnknown** out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLE32.dll')
CoCreateFreeThreadedMarshaler = Fiddle::Function.new(
lib['CoCreateFreeThreadedMarshaler'],
[
Fiddle::TYPE_VOIDP, # punkOuter : IUnknown* optional
Fiddle::TYPE_VOIDP, # ppunkMarshal : IUnknown** out
],
Fiddle::TYPE_INT)#[link(name = "ole32")]
extern "system" {
fn CoCreateFreeThreadedMarshaler(
punkOuter: *mut core::ffi::c_void, // IUnknown* optional
ppunkMarshal: *mut *mut core::ffi::c_void // IUnknown** out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoCreateFreeThreadedMarshaler(IntPtr punkOuter, IntPtr ppunkMarshal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoCreateFreeThreadedMarshaler' -Namespace Win32 -PassThru
# $api::CoCreateFreeThreadedMarshaler(punkOuter, ppunkMarshal)#uselib "OLE32.dll"
#func global CoCreateFreeThreadedMarshaler "CoCreateFreeThreadedMarshaler" sptr, sptr
; CoCreateFreeThreadedMarshaler punkOuter, ppunkMarshal ; 戻り値は stat
; punkOuter : IUnknown* optional -> "sptr"
; ppunkMarshal : IUnknown** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "OLE32.dll"
#cfunc global CoCreateFreeThreadedMarshaler "CoCreateFreeThreadedMarshaler" sptr, sptr
; res = CoCreateFreeThreadedMarshaler(punkOuter, ppunkMarshal)
; punkOuter : IUnknown* optional -> "sptr"
; ppunkMarshal : IUnknown** out -> "sptr"; HRESULT CoCreateFreeThreadedMarshaler(IUnknown* punkOuter, IUnknown** ppunkMarshal)
#uselib "OLE32.dll"
#cfunc global CoCreateFreeThreadedMarshaler "CoCreateFreeThreadedMarshaler" intptr, intptr
; res = CoCreateFreeThreadedMarshaler(punkOuter, ppunkMarshal)
; punkOuter : IUnknown* optional -> "intptr"
; ppunkMarshal : IUnknown** out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ole32 = windows.NewLazySystemDLL("OLE32.dll")
procCoCreateFreeThreadedMarshaler = ole32.NewProc("CoCreateFreeThreadedMarshaler")
)
// punkOuter (IUnknown* optional), ppunkMarshal (IUnknown** out)
r1, _, err := procCoCreateFreeThreadedMarshaler.Call(
uintptr(punkOuter),
uintptr(ppunkMarshal),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction CoCreateFreeThreadedMarshaler(
punkOuter: Pointer; // IUnknown* optional
ppunkMarshal: Pointer // IUnknown** out
): Integer; stdcall;
external 'OLE32.dll' name 'CoCreateFreeThreadedMarshaler';result := DllCall("OLE32\CoCreateFreeThreadedMarshaler"
, "Ptr", punkOuter ; IUnknown* optional
, "Ptr", ppunkMarshal ; IUnknown** out
, "Int") ; return: HRESULT●CoCreateFreeThreadedMarshaler(punkOuter, ppunkMarshal) = DLL("OLE32.dll", "int CoCreateFreeThreadedMarshaler(void*, void*)")
# 呼び出し: CoCreateFreeThreadedMarshaler(punkOuter, ppunkMarshal)
# punkOuter : IUnknown* optional -> "void*"
# ppunkMarshal : IUnknown** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ole32" fn CoCreateFreeThreadedMarshaler(
punkOuter: ?*anyopaque, // IUnknown* optional
ppunkMarshal: ?*anyopaque // IUnknown** out
) callconv(std.os.windows.WINAPI) i32;proc CoCreateFreeThreadedMarshaler(
punkOuter: pointer, # IUnknown* optional
ppunkMarshal: pointer # IUnknown** out
): int32 {.importc: "CoCreateFreeThreadedMarshaler", stdcall, dynlib: "OLE32.dll".}pragma(lib, "ole32");
extern(Windows)
int CoCreateFreeThreadedMarshaler(
void* punkOuter, // IUnknown* optional
void* ppunkMarshal // IUnknown** out
);ccall((:CoCreateFreeThreadedMarshaler, "OLE32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Cvoid}),
punkOuter, ppunkMarshal)
# punkOuter : IUnknown* optional -> Ptr{Cvoid}
# ppunkMarshal : IUnknown** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CoCreateFreeThreadedMarshaler(
void* punkOuter,
void* ppunkMarshal);
]]
local ole32 = ffi.load("ole32")
-- ole32.CoCreateFreeThreadedMarshaler(punkOuter, ppunkMarshal)
-- punkOuter : IUnknown* optional
-- ppunkMarshal : IUnknown** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const CoCreateFreeThreadedMarshaler = lib.func('__stdcall', 'CoCreateFreeThreadedMarshaler', 'int32_t', ['void *', 'void *']);
// CoCreateFreeThreadedMarshaler(punkOuter, ppunkMarshal)
// punkOuter : IUnknown* optional -> 'void *'
// ppunkMarshal : IUnknown** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLE32.dll", {
CoCreateFreeThreadedMarshaler: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.CoCreateFreeThreadedMarshaler(punkOuter, ppunkMarshal)
// punkOuter : IUnknown* optional -> "pointer"
// ppunkMarshal : IUnknown** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CoCreateFreeThreadedMarshaler(
void* punkOuter,
void* ppunkMarshal);
C, "OLE32.dll");
// $ffi->CoCreateFreeThreadedMarshaler(punkOuter, ppunkMarshal);
// punkOuter : IUnknown* optional
// ppunkMarshal : IUnknown** 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 CoCreateFreeThreadedMarshaler(
Pointer punkOuter, // IUnknown* optional
Pointer ppunkMarshal // IUnknown** out
);
}@[Link("ole32")]
lib LibOLE32
fun CoCreateFreeThreadedMarshaler = CoCreateFreeThreadedMarshaler(
punkOuter : Void*, # IUnknown* optional
ppunkMarshal : Void* # IUnknown** out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CoCreateFreeThreadedMarshalerNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef CoCreateFreeThreadedMarshalerDart = int Function(Pointer<Void>, Pointer<Void>);
final CoCreateFreeThreadedMarshaler = DynamicLibrary.open('OLE32.dll')
.lookupFunction<CoCreateFreeThreadedMarshalerNative, CoCreateFreeThreadedMarshalerDart>('CoCreateFreeThreadedMarshaler');
// punkOuter : IUnknown* optional -> Pointer<Void>
// ppunkMarshal : IUnknown** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CoCreateFreeThreadedMarshaler(
punkOuter: Pointer; // IUnknown* optional
ppunkMarshal: Pointer // IUnknown** out
): Integer; stdcall;
external 'OLE32.dll' name 'CoCreateFreeThreadedMarshaler';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CoCreateFreeThreadedMarshaler"
c_CoCreateFreeThreadedMarshaler :: Ptr () -> Ptr () -> IO Int32
-- punkOuter : IUnknown* optional -> Ptr ()
-- ppunkMarshal : IUnknown** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let cocreatefreethreadedmarshaler =
foreign "CoCreateFreeThreadedMarshaler"
((ptr void) @-> (ptr void) @-> returning int32_t)
(* punkOuter : IUnknown* optional -> (ptr void) *)
(* ppunkMarshal : IUnknown** 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 ("CoCreateFreeThreadedMarshaler" co-create-free-threaded-marshaler :convention :stdcall) :int32
(punk-outer :pointer) ; IUnknown* optional
(ppunk-marshal :pointer)) ; IUnknown** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CoCreateFreeThreadedMarshaler = Win32::API::More->new('OLE32',
'int CoCreateFreeThreadedMarshaler(LPVOID punkOuter, LPVOID ppunkMarshal)');
# my $ret = $CoCreateFreeThreadedMarshaler->Call($punkOuter, $ppunkMarshal);
# punkOuter : IUnknown* optional -> LPVOID
# ppunkMarshal : IUnknown** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f CoGetInterfaceAndReleaseStream — ストリームからインターフェイスを復元しストリームを解放する。
- f CoMarshalInterThreadInterfaceInStream — スレッド間で渡すためインターフェイスをストリームにマーシャリングする。
使用する型