IFsrmCommittableCollection
COMIDispatch (デュアル)comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。公式ドキュメント
同じ種類のオブジェクトをコレクションに追加したり、コレクションから削除したりできる FSRM オブジェクトのコレクションを定義します。コレクション内のすべてのオブジェクトは、単一のバッチ操作でコミットすることもできます。
メソッド 1
vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。
コレクション内のすべてのオブジェクトをコミットし、各オブジェクトのコミット結果を返します。
| options | FsrmCommitOptions | in | オブジェクトのコレクションをコミットするときに使用する 1 つ以上のオプション。指定できる値については、 FsrmCommitOptions 列挙型を参照してください。 |
| results | IFsrmCollection** | out | コレクション内のオブジェクトに直接対応する HRESULT 値のコレクション。 HRESULT 値は、そのオブジェクトのコミットが成功したか失敗したかを示します。 メソッドが FSRM_S_PARTIAL_BATCH または FSRM_E_FAIL_BATCH を返した場合は、この結果を確認してください。 |
戻り値
このメソッドは次の戻り値を返します。
解説(Remarks)
オブジェクトをバッチ操作でコミットすると、コレクション内の各オブジェクトを個別にコミットする場合 (たとえば IFsrmFileScreen::Commit メソッドを呼び出す場合) よりも高いパフォーマンスが得られます。
コレクション内のオブジェクトの状態は同一でなければならない点に注意してください。たとえば、コレクションには すべて新規のオブジェクト、削除対象としてマークされたオブジェクト、または変更されたオブジェクトのいずれかのみを 含める必要があります。変更されたオブジェクトという分類は、新規でも削除対象としてマークされてもいないオブジェクトを 指し、必ずしも実際に変更されたことを意味するわけではありません。
インポートされたオブジェクトのコレクションは、変更されたオブジェクトのコレクションと見なされます。 インポートしたオブジェクトのうち 1 つ以上を削除対象としてマークした場合 (オブジェクトに対して Delete メソッドを呼び出した場合)、残りをコミットする前に、まずそれらのオブジェクトをコレクションから 削除 する必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IFsrmCommittableCollection "{96DEB3B5-8B91-4A2A-9D93-80A35D8AA847}"
#usecom global IFsrmCommittableCollection IID_IFsrmCommittableCollection "{}"
#comfunc global IFsrmCommittableCollection_Commit 18 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。