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

BIND_OPTS

構造体
サイズx64: 16 バイト / x86: 16 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
cbStructDWORD4+0+0この構造体のサイズ (バイト単位)。
grfFlagsDWORD4+4+4モニカーのバインド操作の動作を制御するフラグ。この値は BIND_FLAGS 列挙型のビットフラグの任意の組み合わせです。CreateBindCtx 関数は、このメンバーを 0 に初期化します。
grfModeDWORD4+8+8モニカーが識別するオブジェクトを格納しているファイルを開くときに使用するフラグ。指定できる値は STGM 定数 です。バインド操作は、ファイルを読み込む際の IPersistFile::Load の呼び出しでこれらのフラグを使用します。オブジェクトが既に実行中の場合、これらのフラグはバインド操作によって無視されます。CreateBindCtx 関数は、このフィールドを STGM_READWRITE に初期化します。
dwTickCountDeadlineDWORD4+12+12

呼び出し元がバインド操作を完了させたいと考えるクロック時刻 (ミリ秒単位)。このメンバーにより、速度が最も重要な場合に、呼び出し元は操作の実行時間を制限できます。0 は期限がないことを示します。呼び出し元は主に IMoniker::GetTimeOfLastChange メソッドを呼び出すときにこの機能を使用しますが、他の操作にも有効に適用できます。CreateBindCtx 関数は、このフィールドを 0 に初期化します。

一般的な期限は、数百ミリ秒程度の実行時間を許容します。この期限は推奨であり、要件ではありません。ただし、期限を大幅に超過する操作は、エンドユーザーにとって遅延の原因となる場合があります。各モニカーの実装は、期限までに操作を完了するよう努めるか、エラー MK_E_EXCEEDEDDEADLINE で失敗させる必要があります。

必要なオブジェクトの 1 つ以上が実行されていないためにバインド操作が期限を超過した場合、モニカーの実装は IBindCtx::RegisterObjectParam を使用して、原因となったオブジェクトをバインドコンテキストに登録する必要があります。オブジェクトは "ExceededDeadline"、"ExceededDeadline1"、"ExceededDeadline2" のようなパラメーター名で登録します。呼び出し元が後で実行中オブジェクトテーブルでそのオブジェクトを見つけた場合は、バインド操作を再試行できます。

GetTickCount 関数はシステム起動からの経過ミリ秒数を示し、2^31 ミリ秒後に 0 へ折り返します。そのため、呼び出し元は誤って 0 (期限なしを示す) を渡さないよう注意し、モニカーの実装はクロックの折り返しの問題に注意する必要があります。

公式ドキュメント

モニカーのバインド操作中に使用されるパラメーターを格納します。

BIND_OPTS 構造体の代わりに、BIND_OPTS2 構造体または BIND_OPTS3 構造体を使用できます。

解説(Remarks)

BIND_OPTS 構造体はバインドコンテキストに格納されます。バインド時には複合モニカーの各コンポーネントが同じバインドコンテキストを使用するため、複合モニカーのすべてのコンポーネントに同じパラメーターを渡すことができます。バインドコンテキストの詳細については、IBindCtx を参照してください。

モニカーのクライアント (モニカーを使用してオブジェクトへのインターフェイスポインターを取得する側) は、通常この構造体のメンバーに値を指定する必要はありません。CreateBindCtx 関数は、ほとんどの状況に適した既定値がバインドオプションに設定されたバインドコンテキストを作成します。BindMoniker 関数も、モニカーのバインドに使用するバインドコンテキストを作成する際に同じ処理を行います。これらのバインドオプションの値を変更したい場合は、BIND_OPTS 構造体を IBindCtx::SetBindOptions メソッドに渡すことで変更できます。モニカーの実装者は、BIND_OPTS 構造体を IBindCtx::GetBindOptions メソッドに渡して、これらのバインドオプションの値を取得できます。

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

各言語での定義

#include <windows.h>

// BIND_OPTS  (x64 16 / x86 16 バイト)
typedef struct BIND_OPTS {
    DWORD cbStruct;
    DWORD grfFlags;
    DWORD grfMode;
    DWORD dwTickCountDeadline;
} BIND_OPTS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct BIND_OPTS
{
    public uint cbStruct;
    public uint grfFlags;
    public uint grfMode;
    public uint dwTickCountDeadline;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure BIND_OPTS
    Public cbStruct As UInteger
    Public grfFlags As UInteger
    Public grfMode As UInteger
    Public dwTickCountDeadline As UInteger
End Structure
import ctypes
from ctypes import wintypes

class BIND_OPTS(ctypes.Structure):
    _fields_ = [
        ("cbStruct", wintypes.DWORD),
        ("grfFlags", wintypes.DWORD),
        ("grfMode", wintypes.DWORD),
        ("dwTickCountDeadline", wintypes.DWORD),
    ]
#[repr(C)]
pub struct BIND_OPTS {
    pub cbStruct: u32,
    pub grfFlags: u32,
    pub grfMode: u32,
    pub dwTickCountDeadline: u32,
}
import "golang.org/x/sys/windows"

type BIND_OPTS struct {
	cbStruct uint32
	grfFlags uint32
	grfMode uint32
	dwTickCountDeadline uint32
}
type
  BIND_OPTS = record
    cbStruct: DWORD;
    grfFlags: DWORD;
    grfMode: DWORD;
    dwTickCountDeadline: DWORD;
  end;
const BIND_OPTS = extern struct {
    cbStruct: u32,
    grfFlags: u32,
    grfMode: u32,
    dwTickCountDeadline: u32,
};
type
  BIND_OPTS {.bycopy.} = object
    cbStruct: uint32
    grfFlags: uint32
    grfMode: uint32
    dwTickCountDeadline: uint32
struct BIND_OPTS
{
    uint cbStruct;
    uint grfFlags;
    uint grfMode;
    uint dwTickCountDeadline;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; BIND_OPTS サイズ: 16 バイト(x64)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; cbStruct : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; grfFlags : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; grfMode : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; dwTickCountDeadline : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global BIND_OPTS
    #field int cbStruct
    #field int grfFlags
    #field int grfMode
    #field int dwTickCountDeadline
#endstruct

stdim st, BIND_OPTS        ; NSTRUCT 変数を確保
st->cbStruct = 100
mes "cbStruct=" + st->cbStruct