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

CoUnmarshalInterface

関数
ストリームからインターフェイスポインタをアンマーシャリングして復元する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoUnmarshalInterface(
    IStream* pStm,
    const GUID* riid,
    void** ppv
);

パラメーター

名前型方向説明
pStmIStream*inインターフェイスのアンマーシャリング元となるストリームへのポインター。
riidGUID*inアンマーシャリングするインターフェイスの識別子への参照。IID_NULL の場合、返されるインターフェイスはストリームによって定義されるもの (objref.iid) になります。
ppvvoid**outriid で要求したインターフェイスポインターを受け取るポインター変数のアドレス。正常に終了すると、*ppv にはアンマーシャリングされたインターフェイスに対して要求されたインターフェイスポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

CoMarshalInterface 関数の以前の呼び出しによってストリームに書き込まれたデータを使用して、新しく作成されたプロキシを初期化し、そのプロキシへのインターフェイスポインターを返します。

戻り値

この関数は、標準の戻り値 E_FAIL、CoCreateInstance が返すエラー、および次の値を返すことがあります。

戻り値 説明
S_OK
インターフェイスポインターが正常にアンマーシャリングされました。
STG_E_INVALIDPOINTER
pStm が無効なポインターです。
CO_E_NOTINITIALIZED
この関数を呼び出す前に、現在のスレッドで CoInitialize 関数または OleInitialize 関数が呼び出されていません。
CO_E_OBJNOTCONNECTED
オブジェクトアプリケーションがリモート処理システムから切断されています (たとえば、CoDisconnectObject 関数の呼び出しの結果として)。
REGDB_E_CLASSNOTREG
登録データベースの読み取り中にエラーが発生しました。
E_NOINTERFACE
要求されたインターフェイスに対するこの関数の最終的な QueryInterface が E_NOINTERFACE を返しました。

解説(Remarks)

重要

セキュリティに関する注意: 信頼されていないデータを使用してこのメソッドを呼び出すことは、セキュリティ上のリスクとなります。信頼されたデータの場合にのみ、このメソッドを呼び出してください。

CoUnmarshalInterface 関数は、次の処理を実行します。
  1. プロキシのインスタンスの作成に使用する CLSID をストリームから読み取ります。
  2. アンマーシャリングを行うプロキシへの IMarshal ポインターを取得します。オブジェクトが COM の既定のマーシャリング実装を使用している場合、こうして取得されるポインターは汎用プロキシオブジェクトのインスタンスを指します。マーシャリングが同一プロセス内の 2 つのスレッド間で行われる場合、ポインターはインプロセスのフリースレッドマーシャラーのインスタンスを指します。オブジェクトが独自のマーシャリングコードを提供している場合、CoUnmarshalInterface は、マーシャリングストリームから読み取った CLSID を渡して CoCreateInstance 関数を呼び出します。CoCreateInstance はオブジェクトのプロキシのインスタンスを作成し、そのプロキシへの IMarshal インターフェイスポインターを返します。
  3. 取得した IMarshal インターフェイスポインターを使用して、この関数は IMarshal::UnmarshalInterface を呼び出し、必要に応じて IMarshal::ReleaseMarshalData を呼び出します。
この関数の主な呼び出し元は COM 自体であり、インターフェイスポインターをアンマーシャリングするインターフェイスプロキシまたはスタブの内部から呼び出されます。ただし、CoUnmarshalInterface を呼び出す場合もあります。たとえば、スタブを実装していて、そのスタブがメソッド呼び出しのパラメーターとしてインターフェイスポインターを受け取る場合、実装から CoUnmarshalInterface を呼び出すことになります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

CoUnmarshalInterface = ctypes.windll.ole32.CoUnmarshalInterface
CoUnmarshalInterface.restype = ctypes.c_int
CoUnmarshalInterface.argtypes = [
    ctypes.c_void_p,  # pStm : IStream*
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoUnmarshalInterface = Fiddle::Function.new(
  lib['CoUnmarshalInterface'],
  [
    Fiddle::TYPE_VOIDP,  # pStm : IStream*
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ole32")]
extern "system" {
    fn CoUnmarshalInterface(
        pStm: *mut core::ffi::c_void,  // IStream*
        riid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoUnmarshalInterface(IntPtr pStm, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoUnmarshalInterface' -Namespace Win32 -PassThru
# $api::CoUnmarshalInterface(pStm, riid, ppv)
#uselib "OLE32.dll"
#func global CoUnmarshalInterface "CoUnmarshalInterface" sptr, sptr, sptr
; CoUnmarshalInterface pStm, varptr(riid), ppv   ; 戻り値は stat
; pStm : IStream* -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OLE32.dll"
#cfunc global CoUnmarshalInterface "CoUnmarshalInterface" sptr, var, sptr
; res = CoUnmarshalInterface(pStm, riid, ppv)
; pStm : IStream* -> "sptr"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT CoUnmarshalInterface(IStream* pStm, GUID* riid, void** ppv)
#uselib "OLE32.dll"
#cfunc global CoUnmarshalInterface "CoUnmarshalInterface" intptr, var, intptr
; res = CoUnmarshalInterface(pStm, riid, ppv)
; pStm : IStream* -> "intptr"
; riid : GUID* -> "var"
; ppv : void** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoUnmarshalInterface = ole32.NewProc("CoUnmarshalInterface")
)

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

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

typedef CoUnmarshalInterfaceNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef CoUnmarshalInterfaceDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final CoUnmarshalInterface = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoUnmarshalInterfaceNative, CoUnmarshalInterfaceDart>('CoUnmarshalInterface');
// pStm : IStream* -> Pointer<Void>
// riid : GUID* -> Pointer<Void>
// ppv : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoUnmarshalInterface(
  pStm: Pointer;   // IStream*
  riid: PGUID;   // GUID*
  ppv: Pointer   // void** out
): Integer; stdcall;
  external 'OLE32.dll' name 'CoUnmarshalInterface';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoUnmarshalInterface"
  c_CoUnmarshalInterface :: Ptr () -> Ptr () -> Ptr () -> IO Int32
-- pStm : IStream* -> Ptr ()
-- riid : GUID* -> Ptr ()
-- ppv : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let counmarshalinterface =
  foreign "CoUnmarshalInterface"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pStm : IStream* -> (ptr void) *)
(* riid : GUID* -> (ptr void) *)
(* ppv : void** 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 ("CoUnmarshalInterface" co-unmarshal-interface :convention :stdcall) :int32
  (p-stm :pointer)   ; IStream*
  (riid :pointer)   ; GUID*
  (ppv :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoUnmarshalInterface = Win32::API::More->new('OLE32',
    'int CoUnmarshalInterface(LPVOID pStm, LPVOID riid, LPVOID ppv)');
# my $ret = $CoUnmarshalInterface->Call($pStm, $riid, $ppv);
# pStm : IStream* -> LPVOID
# riid : GUID* -> LPVOID
# ppv : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型