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

CreateObjrefMoniker

関数
オブジェクト参照をマーシャルするObjRefモニカーを作成する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CreateObjrefMoniker(
    IUnknown* punk,   // optional
    IMoniker** ppmk
);

パラメーター

名前方向説明
punkIUnknown*inoptionalモニカーが表すオブジェクト上の IUnknown インターフェイスへのポインター。
ppmkIMoniker**out作成された OBJREF モニカー上の IMoniker インターフェイスへのポインターのアドレス。

戻り値の型: HRESULT

公式ドキュメント

オブジェクトへのポインターを基に OBJREF モニカーを作成します。

戻り値

この関数は、標準の戻り値 E_OUTOFMEMORYE_UNEXPECTED、および S_OK を返すことがあります。

解説(Remarks)

クライアントは OBJREF モニカーを使用して、サーバーのアドレス空間で実行中のオブジェクトへのマーシャリングされたポインターを取得します。

サーバーは通常、CreateObjrefMoniker を呼び出して OBJREF モニカーを作成し、続いて IMoniker::GetDisplayName を呼び出し、最後にモニカーを解放します。OBJREF モニカーの表示名は次の形式です。

OBJREF:nnnnnnnn

ここで nnnnnnnn は、実行中のオブジェクトのコンピューターの場所、プロセスのエンドポイント、およびインターフェイス ポインター ID (IPID) をカプセル化した、任意の長さの base-64 エンコードです。

表示名は、テキストとしてクライアントに転送できます。たとえば、表示名はクライアントがダウンロードする HTML ページ上に置くことができます。

クライアントは表示名を MkParseDisplayName に渡すことができ、これにより表示名を基に OBJREF モニカーが作成されます。次に、そのモニカーの IMoniker::BindToObject メソッドを呼び出すと、サーバー上で実行中のインスタンスへのマーシャリングされたポインターが取得されます。

たとえば、Active Server Page に含まれるサーバー側 COM コンポーネントは、OBJREF モニカーを作成し、その表示名を取得して、クライアント ブラウザーに送信される HTML 出力にその表示名を書き込むことができます。クライアント側で実行されるスクリプトは、その表示名を使用して実行中のオブジェクト自体にアクセスできます。たとえば、クライアント側の Visual Basic スクリプトでは、表示名を strMyName という変数に格納し、次の行を記述できます。

objMyInstance = GetObject(strMyName)

スクリプト エンジンは内部で MkParseDisplayName および IMoniker::BindToObject への呼び出しを行い、その後スクリプトは objMyInstance を使用して実行中のオブジェクトを直接参照できます。

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

各言語での呼び出し定義

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

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

CreateObjrefMoniker = ctypes.windll.ole32.CreateObjrefMoniker
CreateObjrefMoniker.restype = ctypes.c_int
CreateObjrefMoniker.argtypes = [
    ctypes.c_void_p,  # punk : IUnknown* optional
    ctypes.c_void_p,  # ppmk : IMoniker** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCreateObjrefMoniker = ole32.NewProc("CreateObjrefMoniker")
)

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

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

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

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

let createobjrefmoniker =
  foreign "CreateObjrefMoniker"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* punk : IUnknown* optional -> (ptr void) *)
(* ppmk : IMoniker** 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 ("CreateObjrefMoniker" create-objref-moniker :convention :stdcall) :int32
  (punk :pointer)   ; IUnknown* optional
  (ppmk :pointer))   ; IMoniker** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateObjrefMoniker = Win32::API::More->new('OLE32',
    'int CreateObjrefMoniker(LPVOID punk, LPVOID ppmk)');
# my $ret = $CreateObjrefMoniker->Call($punk, $ppmk);
# punk : IUnknown* optional -> LPVOID
# ppmk : IMoniker** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型