IXpsOMGlyphs::GetProhibitedCaretStops メソッド (xpsobjectmodel.h)

  • [アーティクル]

禁止されているキャレット停止位置の配列を取得します。

構文

HRESULT GetProhibitedCaretStops(
  [in, out] UINT32 *prohibitedCaretStopCount,
  [out]     UINT32 *prohibitedCaretStops
);

パラメーター

[in, out] prohibitedCaretStopCount

prohibitedCaretStops によって参照される配列に収まる禁止キャレット停止位置の数。 メソッドが戻ると、 prohibitedCaretStopCount には、prohibitedCaretStops によって参照される配列で返される値 の数が含まれます。

[out] prohibitedCaretStops

禁止されたキャレット停止位置の配列。定義されていない場合は、 NULL ポインターが返されます。

戻り値

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

リターン コード 説明
S_OK
 メソッドが成功しました。
E_POINTER
 prohibitedCaretStopCount、 prohibitedCaretStops、またはその両方が NULL です。
ERROR_MORE_DATA
 prohibitedCaretStops は、禁止されたキャレット停止データを受信するのに十分な大きさではありません。 prohibitedCaretStopCount には、必要な数の要素が含まれています。

注釈

各キャレット停止インデックスは、UTF-16 UnicodeString プロパティのスカラー値に対応します。 インデックス 0 は、 UnicodeString の最初の UTF-16 スカラー値の直前の位置を表します。インデックス 1 は、1 番目と 2 番目の UTF-16 スカラー値の間の位置を表します。などです。 UnicodeString の末尾に追加のインデックスがあります。 指定されていないインデックスは、有効なキャレット停止位置です。

GetProhibitedCaretStopCount は、禁止されたキャレット停止の数を取得します。

キャレットストップは、グリフの UnicodeString プロパティ内の UTF-16 コード ポイントのインデックスです。

要件

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

こちらもご覧ください

GetProhibitedCaretStopCount

IXpsOMGlyphs

XML Paper Specification

XPS ドキュメント エラー