Win32 API 日本語リファレンス
ホーム › Storage.Xps › IXpsOMVisualCollection

IXpsOMVisualCollection

COM
📘 Microsoft Learn (日本語) · English
IID94d8abde-ab91-46a8-82b7-f5b05ef01a96継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

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

解説(Remarks)

コレクションのメソッドの詳細については、Working with XPS OM Collection Interfaces を参照してください。

メソッド 6

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

vtbl 3 HRESULT GetCount(DWORD* count)

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

countDWORD*outコレクション内の IXpsOMVisual インターフェイスポインターの数。

戻り値

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

解説(Remarks)

コレクションのメソッドの詳細については、Working with XPS OM Collection Interfaces を参照してください。

vtbl 4 HRESULT GetAt(DWORD index, IXpsOMVisual** object)

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

indexDWORDin取得する IXpsOMVisual インターフェイスポインターの、0 から始まるインデックス。
objectIXpsOMVisual**outindex で指定された位置にある IXpsOMVisual インターフェイスポインター。

戻り値

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

解説(Remarks)

コレクションのメソッドの詳細については、Working with XPS OM Collection Interfaces を参照してください。

vtbl 5 HRESULT InsertAt(DWORD index, IXpsOMVisual* object)

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

indexDWORDinobject で渡されたインターフェイスポインターを挿入する、コレクション内の 0 から始まるインデックス。
objectIXpsOMVisual*inindex で指定された位置に挿入する IXpsOMVisual インターフェイスポインター。

戻り値

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

解説(Remarks)

このメソッドは、index で指定された位置に、object で渡された IXpsOMVisual インターフェイスポインターを挿入します。挿入前に、この位置以降のすべてのポインターはインデックスが 1 つずつ繰り上がります。

コレクションのメソッドの詳細については、Working with XPS OM Collection Interfaces を参照してください。

vtbl 6 HRESULT RemoveAt(DWORD index)

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

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

戻り値

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

解説(Remarks)

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

コレクションのメソッドの詳細については、Working with XPS OM Collection Interfaces を参照してください。

vtbl 7 HRESULT SetAt(DWORD index, IXpsOMVisual* object)

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

indexDWORDinIXpsOMVisual インターフェイスポインターを置き換える、コレクション内の 0 から始まるインデックス。
objectIXpsOMVisual*inindex で指定された位置の現在の内容を置き換える IXpsOMVisual インターフェイスポインター。

戻り値

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

解説(Remarks)

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

コレクションのメソッドの詳細については、Working with XPS OM Collection Interfaces を参照してください。

vtbl 8 HRESULT Append(IXpsOMVisual* object)

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

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

戻り値

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

解説(Remarks)

コレクションのメソッドの詳細については、Working with XPS OM Collection Interfaces を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IXpsOMVisualCollection "{94D8ABDE-AB91-46A8-82B7-F5B05EF01A96}"
#usecom global IXpsOMVisualCollection IID_IXpsOMVisualCollection "{}"
#comfunc global IXpsOMVisualCollection_GetCount  3 var
#comfunc global IXpsOMVisualCollection_GetAt     4 int,sptr
#comfunc global IXpsOMVisualCollection_InsertAt  5 int,sptr
#comfunc global IXpsOMVisualCollection_RemoveAt  6 int
#comfunc global IXpsOMVisualCollection_SetAt     7 int,sptr
#comfunc global IXpsOMVisualCollection_Append    8 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。