ホーム › Storage.Xps › IXpsOMDashCollection

IXpsOMDashCollection

COM

📘 Microsoft Learn (日本語) · English

IID081613f4-74eb-48f2-83b3-37a9ce2d7dc6継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

XPS_DASH 構造体のコレクションです。

解説(Remarks)

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

メソッド 6

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

vtbl 3 HRESULT GetCount(DWORD* count)

コレクション内の XPS_DASH 構造体の数を取得します。

count

DWORD*

out

コレクション内の XPS_DASH 構造体の数。

戻り値

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

解説(Remarks)

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

vtbl 4 HRESULT GetAt(DWORD index, XPS_DASH* dash)

コレクション内の指定した位置から XPS_DASH 構造体を取得します。

index	DWORD	in	XPS_DASH 構造体を取得する、コレクション内の 0 から始まるインデックス。
dash	XPS_DASH*	out	index で指定された位置にある XPS_DASH 構造体。

戻り値

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

解説(Remarks)

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

vtbl 5 HRESULT InsertAt(DWORD index, XPS_DASH* dash)

コレクション内の指定した位置に XPS_DASH 構造体を挿入します。

index	DWORD	in	dash が参照する構造体を挿入する、コレクション内の 0 から始まるインデックス。
dash	XPS_DASH*	in	index で指定された位置に挿入する XPS_DASH 構造体へのポインター。

戻り値

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

解説(Remarks)

このメソッドは、index で指定された位置に、dash で渡された XPS_DASH 構造体を挿入します。挿入に先立ち、その位置以降にあるすべての構造体は、インデックスが 1 つ大きい位置へ移動されます。

次の図は、InsertAt メソッドによってコレクションがどのように変化するかを示しています。

vtbl 6 HRESULT RemoveAt(DWORD index)

コレクション内の指定した位置から XPS_DASH 構造体を削除し、解放します。

index

DWORD

XPS_DASH 構造体を削除して解放する、コレクション内の 0 から始まるインデックス。

戻り値

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

解説(Remarks)

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

次の図は、RemoveAt メソッドによってコレクションがどのように変化するかを示しています。

vtbl 7 HRESULT SetAt(DWORD index, XPS_DASH* dash)

コレクション内の指定した位置にある XPS_DASH 構造体を置き換えます。

index	DWORD	in	XPS_DASH 構造体を置き換える、コレクション内の 0 から始まるインデックス。
dash	XPS_DASH*	in	index で指定された位置の現在の内容を置き換える XPS_DASH 構造体へのポインター。

戻り値

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

解説(Remarks)

このメソッドは、index で指定された位置にある既存の XPS_DASH 構造体を解放し、dash で渡された構造体に置き換えます。

次の図は、SetAt メソッドによってコレクションがどのように変化するかを示しています。

vtbl 8 HRESULT Append(XPS_DASH* dash)

コレクションの末尾に XPS_DASH 構造体を追加します。

dash

XPS_DASH*

コレクションに追加する XPS_DASH 構造体へのポインター。

戻り値

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

解説(Remarks)

次の図は、Append メソッドによってコレクションがどのように変化するかを示しています。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IXpsOMDashCollection "{081613F4-74EB-48F2-83B3-37A9CE2D7DC6}"
#usecom global IXpsOMDashCollection IID_IXpsOMDashCollection "{}"
#comfunc global IXpsOMDashCollection_GetCount  3 var
#comfunc global IXpsOMDashCollection_GetAt     4 int,var
#comfunc global IXpsOMDashCollection_InsertAt  5 int,var
#comfunc global IXpsOMDashCollection_RemoveAt  6 int
#comfunc global IXpsOMDashCollection_SetAt     7 int,var
#comfunc global IXpsOMDashCollection_Append    8 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IXpsOMDashCollection "{081613F4-74EB-48F2-83B3-37A9CE2D7DC6}"
#usecom global IXpsOMDashCollection IID_IXpsOMDashCollection "{}"
#comfunc global IXpsOMDashCollection_GetCount  3 sptr
#comfunc global IXpsOMDashCollection_GetAt     4 int,sptr
#comfunc global IXpsOMDashCollection_InsertAt  5 int,sptr
#comfunc global IXpsOMDashCollection_RemoveAt  6 int
#comfunc global IXpsOMDashCollection_SetAt     7 int,sptr
#comfunc global IXpsOMDashCollection_Append    8 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。