ホーム › Storage.Xps › IXpsOMDocumentCollection

IXpsOMDocumentCollection

COM

📘 Microsoft Learn (日本語) · English

IIDd1c87f0d-e947-4754-8a25-971478f7e83e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IXpsOMDocument インターフェースポインターのコレクションです。

解説(Remarks)

コレクションのメソッドの詳細については、XPS OM コレクションインターフェースの操作を参照してください。

メソッド 6

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetCount(DWORD* count)

コレクション内の IXpsOMDocument インターフェースポインターの数を取得します。

count

DWORD*

out

コレクション内の IXpsOMDocument インターフェースポインターの数。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

コレクションのメソッドの詳細については、XPS OM コレクションインターフェースの操作を参照してください。

vtbl 4 HRESULT GetAt(DWORD index, IXpsOMDocument** document)

コレクション内の指定した位置から IXpsOMDocument インターフェースポインターを取得します。

index	DWORD	in	取得する IXpsOMDocument インターフェースポインターの、0 から始まるインデックス。
document	IXpsOMDocument**	out	index で指定した位置にある IXpsOMDocument インターフェースポインター。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

コレクションのメソッドの詳細については、XPS OM コレクションインターフェースの操作を参照してください。

vtbl 5 HRESULT InsertAt(DWORD index, IXpsOMDocument* document)

コレクション内の指定した位置に IXpsOMDocument インターフェースポインターを挿入します。

index	DWORD	in	document で渡すインターフェースポインターを挿入する、コレクション内の 0 から始まるインデックス。
document	IXpsOMDocument*	in	index で指定した位置に挿入する IXpsOMDocument インターフェースポインター。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドは、index で指定した位置に、document で渡された IXpsOMDocument インターフェースポインターを挿入します。挿入に先立って、この位置以降にあるすべてのポインターはインデックスが 1 つずつ繰り下がります。

コレクションのメソッドの詳細については、XPS OM コレクションインターフェースの操作を参照してください。

vtbl 6 HRESULT RemoveAt(DWORD index)

コレクション内の指定した位置から IXpsOMDocument インターフェースポインターを削除し、解放します。

index

DWORD

IXpsOMDocument インターフェースポインターを削除して解放する、コレクション内の 0 から始まるインデックス。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドは、index で指定した位置にあるポインターが参照するインターフェースを解放します。インターフェースを解放した後、このメソッドは index より後ろにある各ポインターのインデックスを 1 ずつ減らし、コレクションを詰めます。

コレクションのメソッドの詳細については、XPS OM コレクションインターフェースの操作を参照してください。

vtbl 7 HRESULT SetAt(DWORD index, IXpsOMDocument* document)

コレクション内の指定した位置にある IXpsOMDocument インターフェースポインターを置き換えます。

index	DWORD	in	IXpsOMDocument インターフェースポインターを置き換える、コレクション内の 0 から始まるインデックス。
document	IXpsOMDocument*	in	index で指定した位置の現在の内容を置き換える IXpsOMDocument インターフェースポインター。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドは、index で指定した位置において、既存のポインターが参照する IXpsOMDocument インターフェースを解放し、document で渡されたポインターを書き込みます。

コレクションのメソッドの詳細については、XPS OM コレクションインターフェースの操作を参照してください。

vtbl 8 HRESULT Append(IXpsOMDocument* document)

IXpsOMDocument インターフェースをコレクションの末尾に追加します。

document

IXpsOMDocument*

コレクションに追加する IXpsOMDocument インターフェースへのポインター。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

コレクションのメソッドの詳細については、XPS OM コレクションインターフェースの操作を参照してください。

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IXpsOMDocumentCollection "{D1C87F0D-E947-4754-8A25-971478F7E83E}"
#usecom global IXpsOMDocumentCollection IID_IXpsOMDocumentCollection "{}"
#comfunc global IXpsOMDocumentCollection_GetCount  3 var
#comfunc global IXpsOMDocumentCollection_GetAt     4 int,sptr
#comfunc global IXpsOMDocumentCollection_InsertAt  5 int,sptr
#comfunc global IXpsOMDocumentCollection_RemoveAt  6 int
#comfunc global IXpsOMDocumentCollection_SetAt     7 int,sptr
#comfunc global IXpsOMDocumentCollection_Append    8 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IXpsOMDocumentCollection "{D1C87F0D-E947-4754-8A25-971478F7E83E}"
#usecom global IXpsOMDocumentCollection IID_IXpsOMDocumentCollection "{}"
#comfunc global IXpsOMDocumentCollection_GetCount  3 sptr
#comfunc global IXpsOMDocumentCollection_GetAt     4 int,sptr
#comfunc global IXpsOMDocumentCollection_InsertAt  5 int,sptr
#comfunc global IXpsOMDocumentCollection_RemoveAt  6 int
#comfunc global IXpsOMDocumentCollection_SetAt     7 int,sptr
#comfunc global IXpsOMDocumentCollection_Append    8 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。