BindMoniker

関数

モニカーをバインドして指定インターフェースのオブジェクトを取得する。

DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT BindMoniker(
    IMoniker* pmk,
    DWORD grfOpt,
    const GUID* iidResult,
    void** ppvResult
);

パラメーター

名前	型	方向	説明
pmk	IMoniker*	in	オブジェクトのモニカーへのポインター。IMoniker を参照してください。
grfOpt	DWORD	in	このパラメーターは将来の使用のために予約されており、0 を指定する必要があります。
iidResult	GUID*	in	オブジェクトとの通信に使用するインターフェイス識別子。
ppvResult	void**	out	iidResult で要求されたインターフェイスポインターを受け取るポインター変数のアドレス。正常に返された場合、ppvResult には要求されたインターフェイスポインターが格納されます。エラーが発生した場合、ppvResult は NULL になります。呼び出しが成功した場合、呼び出し側はオブジェクトの IUnknown::Release メソッドを呼び出してポインターを解放する責任があります。

戻り値の型: HRESULT

公式ドキュメント

モニカーを使ってオブジェクトを特定し、オブジェクトが非アクティブな場合はアクティブ化し、そのオブジェクト上の指定されたインターフェイスへのポインターを取得します。

戻り値

この関数は次のエラーコード、または IMoniker::BindToObject メソッドが返すエラー値のいずれかを返すことがあります。

戻り値	説明
S_OK	オブジェクトが特定され、必要に応じてアクティブ化され、要求されたインターフェイスへのポインターが返されました。
MK_E_NOOBJECT	モニカーオブジェクトが識別したオブジェクトが見つかりませんでした。

解説(Remarks)

BindMoniker は、オブジェクトのモニカーを持つクライアントが、そのオブジェクトのインターフェイスの 1 つへのポインターを取得するための便利な手段として提供されるヘルパー関数です。BindMoniker は次の呼び出しをまとめたものです。

CreateBindCtx(0, &pbc);
pmk->BindToObject(pbc, NULL, riid, ppvObj);

CreateBindCtx は、IBindContext のシステム実装をサポートするバインドコンテキストオブジェクトを作成します。pmk パラメーターは実際にはモニカーオブジェクト上の IMoniker 実装へのポインターです。この実装の BindToObject メソッドが、要求されたインターフェイスポインターへのポインターを提供します。

短時間に連続してバインドするモニカーが複数あり、それらのモニカーが同じオブジェクトをアクティブ化することがわかっている場合は、IMoniker::BindToObject メソッドを直接呼び出す方が効率的な場合があります。この方法では、すべてのモニカーに対して同じバインドコンテキストオブジェクトを使用できます。詳細については、IBindCtx インターフェイスを参照してください。

ドキュメントにリンクされたオブジェクトを含めることを許可するコンテナーアプリケーションは、通常 IMoniker メソッドを直接呼び出さない特殊なクライアントです。代わりに、クライアントは IOleLink インターフェイスを通じてリンクされたオブジェクトを操作します。既定のハンドラーがこのインターフェイスを実装し、必要に応じて適切な IMoniker メソッドを呼び出します。

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

各言語での呼び出し定義

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

HRESULT BindMoniker(
    IMoniker* pmk,
    DWORD grfOpt,
    const GUID* iidResult,
    void** ppvResult
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int BindMoniker(
    IntPtr pmk,   // IMoniker*
    uint grfOpt,   // DWORD
    ref Guid iidResult,   // GUID*
    IntPtr ppvResult   // void** out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function BindMoniker(
    pmk As IntPtr,   ' IMoniker*
    grfOpt As UInteger,   ' DWORD
    ByRef iidResult As Guid,   ' GUID*
    ppvResult As IntPtr   ' void** out
) As Integer
End Function

' pmk : IMoniker*
' grfOpt : DWORD
' iidResult : GUID*
' ppvResult : void** out
Declare PtrSafe Function BindMoniker Lib "ole32" ( _
    ByVal pmk As LongPtr, _
    ByVal grfOpt As Long, _
    ByVal iidResult As LongPtr, _
    ByVal ppvResult As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BindMoniker = ctypes.windll.ole32.BindMoniker
BindMoniker.restype = ctypes.c_int
BindMoniker.argtypes = [
    ctypes.c_void_p,  # pmk : IMoniker*
    wintypes.DWORD,  # grfOpt : DWORD
    ctypes.c_void_p,  # iidResult : GUID*
    ctypes.c_void_p,  # ppvResult : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
BindMoniker = Fiddle::Function.new(
  lib['BindMoniker'],
  [
    Fiddle::TYPE_VOIDP,  # pmk : IMoniker*
    -Fiddle::TYPE_INT,  # grfOpt : DWORD
    Fiddle::TYPE_VOIDP,  # iidResult : GUID*
    Fiddle::TYPE_VOIDP,  # ppvResult : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn BindMoniker(
        pmk: *mut core::ffi::c_void,  // IMoniker*
        grfOpt: u32,  // DWORD
        iidResult: *const GUID,  // GUID*
        ppvResult: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int BindMoniker(IntPtr pmk, uint grfOpt, ref Guid iidResult, IntPtr ppvResult);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_BindMoniker' -Namespace Win32 -PassThru
# $api::BindMoniker(pmk, grfOpt, iidResult, ppvResult)

#uselib "OLE32.dll"
#func global BindMoniker "BindMoniker" sptr, sptr, sptr, sptr
; BindMoniker pmk, grfOpt, varptr(iidResult), ppvResult   ; 戻り値は stat
; pmk : IMoniker* -> "sptr"
; grfOpt : DWORD -> "sptr"
; iidResult : GUID* -> "sptr"
; ppvResult : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global BindMoniker "BindMoniker" sptr, int, var, sptr
; res = BindMoniker(pmk, grfOpt, iidResult, ppvResult)
; pmk : IMoniker* -> "sptr"
; grfOpt : DWORD -> "int"
; iidResult : GUID* -> "var"
; ppvResult : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global BindMoniker "BindMoniker" sptr, int, sptr, sptr
; res = BindMoniker(pmk, grfOpt, varptr(iidResult), ppvResult)
; pmk : IMoniker* -> "sptr"
; grfOpt : DWORD -> "int"
; iidResult : GUID* -> "sptr"
; ppvResult : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。