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

CreateBindCtx

関数
モニカー操作用のバインドコンテキストを作成する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CreateBindCtx(
    DWORD reserved,
    IBindCtx** ppbc
);

パラメーター

名前方向説明
reservedDWORDinこのパラメーターは予約されており、0 を指定する必要があります。
ppbcIBindCtx**out新しいバインドコンテキストオブジェクトへのインターフェイスポインターを受け取る IBindCtx* ポインター変数のアドレスです。関数が成功した場合、呼び出し元はバインドコンテキストに対して Release を呼び出す責任があります。バインドコンテキストが NULL 値の場合は、エラーが発生したことを示します。

戻り値の型: HRESULT

公式ドキュメント

IBindCtx(バインドコンテキストオブジェクト)の実装へのポインターを返します。このオブジェクトは、特定のモニカーバインド操作に関する情報を格納します。

戻り値

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

解説(Remarks)

CreateBindCtx は、モニカーのバインド(モニカーを通じてインターフェイスを識別し、その位置を特定してポインターを取得する)の過程で最も一般的に使用されます。手順は次のとおりです。

  1. CreateBindCtx 関数を呼び出して、バインドコンテキストへのポインターを取得します。
  2. モニカーに対して IMoniker::BindToObject メソッドを呼び出し、モニカーが参照するオブジェクトへのインターフェイスポインターを取得します。
  3. バインドコンテキストを解放します。
  4. インターフェイスポインターを使用します。
  5. インターフェイスポインターを解放します。
次のコードフラグメントは、これらの手順を示しています。
// pMnk is an IMoniker * that points to a previously acquired moniker
IInterface *pInterface;
IBindCtx *pbc;
 
CreateBindCtx( 0, &pbc );
pMnk->BindToObject( pbc, NULL, IID_IInterface, &pInterface );
pbc->Release();

// pInterface now points to the object; safe to use pInterface
pInterface->Release();

バインドコンテキストは、IMoniker::BindToObject 以外の IMoniker インターフェイスのメソッドや、MkParseDisplayName 関数でも使用されます。

バインドコンテキストは、バインド操作中にバインドされたオブジェクトへの参照を保持します。これにより、バインドコンテキストが解放されるまで、バインドされたオブジェクトはアクティブな状態(オブジェクトのサーバーが実行され続ける状態)を維持します。後続の操作で同じオブジェクトにバインドする際にバインドコンテキストを再利用すると、パフォーマンスが向上する場合があります。ただし、オブジェクトを不必要にアクティブな状態に保つ可能性があるため、バインドコンテキストはできるだけ早く解放する必要があります。

バインドコンテキストには BIND_OPTS 構造体が含まれており、この構造体にはバインド操作のすべての手順に適用されるパラメーターが格納されます。CreateBindCtx を使用してバインドコンテキストを作成すると、BIND_OPTS 構造体のフィールドは次のように初期化されます。

cbStruct = sizeof(BIND_OPTS) 
grfFlags = 0 
grfMode = STGM_READWRITE 
dwTickCountDeadline = 0

これらの既定値を変更するには、IBindCtx::SetBindOptions メソッドを呼び出します。

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

各言語での呼び出し定義

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

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

CreateBindCtx = ctypes.windll.ole32.CreateBindCtx
CreateBindCtx.restype = ctypes.c_int
CreateBindCtx.argtypes = [
    wintypes.DWORD,  # reserved : DWORD
    ctypes.c_void_p,  # ppbc : IBindCtx** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCreateBindCtx = ole32.NewProc("CreateBindCtx")
)

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

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

typedef CreateBindCtxNative = Int32 Function(Uint32, Pointer<Void>);
typedef CreateBindCtxDart = int Function(int, Pointer<Void>);
final CreateBindCtx = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CreateBindCtxNative, CreateBindCtxDart>('CreateBindCtx');
// reserved : DWORD -> Uint32
// ppbc : IBindCtx** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateBindCtx(
  reserved: DWORD;   // DWORD
  ppbc: Pointer   // IBindCtx** out
): Integer; stdcall;
  external 'OLE32.dll' name 'CreateBindCtx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateBindCtx"
  c_CreateBindCtx :: Word32 -> Ptr () -> IO Int32
-- reserved : DWORD -> Word32
-- ppbc : IBindCtx** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

関連項目

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