ホーム › Storage.Xps › IXpsOMGradientStopCollection

IXpsOMGradientStopCollection

COM

📘 Microsoft Learn (日本語) · English

IIDc9174c3a-3cd3-4319-bda4-11a39392ceef継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

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

解説(Remarks)

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

メソッド 6

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

vtbl 3 HRESULT GetCount(DWORD* count)

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

count

DWORD*

out

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

戻り値

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

解説(Remarks)

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

vtbl 4 HRESULT GetAt(DWORD index, IXpsOMGradientStop** stop)

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

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

戻り値

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

解説(Remarks)

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

vtbl 5 HRESULT InsertAt(DWORD index, IXpsOMGradientStop* stop)

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

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

戻り値

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

解説(Remarks)

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

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

vtbl 6 HRESULT RemoveAt(DWORD index)

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

index

DWORD

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

戻り値

このメソッドは HRESULT を返します。指定できる値には、以下の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	グラデーションストップのコレクションにストップが 2 つしかありません。グラデーションストップのコレクションには少なくとも 2 つのグラデーションストップが必要であり、指定されたグラデーションストップを削除するとコレクション内のグラデーションストップが 2 つ未満になってしまいます。

戻り値

説明

S_OK

メソッドは成功しました。

E_INVALIDARG

グラデーションストップのコレクションにストップが 2 つしかありません。グラデーションストップのコレクションには少なくとも 2 つのグラデーションストップが必要であり、指定されたグラデーションストップを削除するとコレクション内のグラデーションストップが 2 つ未満になってしまいます。

解説(Remarks)

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

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

vtbl 7 HRESULT SetAt(DWORD index, IXpsOMGradientStop* stop)

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

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

戻り値

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

解説(Remarks)

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

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

vtbl 8 HRESULT Append(IXpsOMGradientStop* stop)

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

stop

IXpsOMGradientStop*

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

戻り値

メソッドが成功した場合は 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_IXpsOMGradientStopCollection "{C9174C3A-3CD3-4319-BDA4-11A39392CEEF}"
#usecom global IXpsOMGradientStopCollection IID_IXpsOMGradientStopCollection "{}"
#comfunc global IXpsOMGradientStopCollection_GetCount  3 var
#comfunc global IXpsOMGradientStopCollection_GetAt     4 int,sptr
#comfunc global IXpsOMGradientStopCollection_InsertAt  5 int,sptr
#comfunc global IXpsOMGradientStopCollection_RemoveAt  6 int
#comfunc global IXpsOMGradientStopCollection_SetAt     7 int,sptr
#comfunc global IXpsOMGradientStopCollection_Append    8 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IXpsOMGradientStopCollection "{C9174C3A-3CD3-4319-BDA4-11A39392CEEF}"
#usecom global IXpsOMGradientStopCollection IID_IXpsOMGradientStopCollection "{}"
#comfunc global IXpsOMGradientStopCollection_GetCount  3 sptr
#comfunc global IXpsOMGradientStopCollection_GetAt     4 int,sptr
#comfunc global IXpsOMGradientStopCollection_InsertAt  5 int,sptr
#comfunc global IXpsOMGradientStopCollection_RemoveAt  6 int
#comfunc global IXpsOMGradientStopCollection_SetAt     7 int,sptr
#comfunc global IXpsOMGradientStopCollection_Append    8 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。