ITextRange::GetIndex メソッド (tom.h)

  • [アーティクル]

指定した範囲の開始文字位置にある Unit パラメーターのストーリー インデックスを取得します。 ストーリーの最初の Unit のインデックス値は 1 です。 Unit のインデックスは、Unit の直前のすべての文字位置で、Unit 内の最後の文字まで同じです。

構文

HRESULT GetIndex(
  long Unit,
  long *pIndex
);

パラメーター

Unit

型: long

インデックスが作成される単位。 使用可能な Unit 値の一覧については、「 ITextRange」の説明を参照してください。

pIndex

種類: long*

インデックス値。 Unit が存在しない場合、値は 0 です。

戻り値

種類: HRESULT

メソッドは HRESULT 値を返します。 メソッドが成功すると、 S_OKが返されます。 メソッドが失敗した場合は、次のいずれかのエラー コードが返されます。 COM エラー コードの詳細については、「COM でのエラー処理」を参照してください。

リターン コード 説明
E_INVALIDARG
 pIndex が null です。
E_NOTIMPL
 ユニットが存在しません。

注釈

ITextRange::GetIndex メソッドは、Start の範囲にある単語、行、文、段落などのストーリー インデックスを取得します。 Unit は、単語 (tomWord)、行 (tomLine)、文 (tomSentence)、段落 (tomParagraph) など、インデックスを作成するエンティティの種類を指定します。 たとえば、 ITextRange::GetIndex は pIndex を範囲内の最初の行の行番号と同じに設定します。 ストーリーの末尾にある範囲の 場合、ITextRange::GetIndex はストーリー内の Unitの数を返します。 したがって、ストーリー内の単語、行、オブジェクトなどの数を取得できます。

テキストが後で編集された場合、 ITextRange::GetIndex メソッドによって返されるインデックス値は無効です。 したがって、特に値を任意の期間格納する場合は、インデックス値を返すメソッドの使用に注意する必要があります。 これは、テキストの編集時に有効な範囲へのポインターとは対照的です。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー tom.h
[DLL] Msftedit.dll

関連項目

概念

ITextRange

リファレンス

Text オブジェクト モデル