IXpsOMGradientStop::GetOffset メソッド (xpsobjectmodel.h)

グラデーションの停止位置のオフセット値を取得します。

構文

HRESULT GetOffset(
  [out, retval] FLOAT *offset
);

[out, retval] offset

グラデーションの分岐点のオフセット値。グラデーションパスの分数として表されます。

このメソッドは HRESULT を返します。使用可能な値には、次の表に示す値が含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、「 XPS ドキュメントエラー」を参照してください。

リターンコード	説明
S_OK	メソッドが成功しました。
E_POINTER	offset は NULL です。

offset で返される値の有効な範囲は 0.0 から 1.0 です。 0.0 はグラデーションの始点、1.0 は終点、0.0 から 1.0 の値は始点と終点の間で線形補間される位置です。

要件	値
サポートされている最小のクライアント	Windows 7、Windows Vista SP2 および Windows Vista 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	xpsobjectmodel.h