ITextRange::SetIndex メソッド (tom.h)
この範囲をストーリーの指定した単位に変更します。
構文
HRESULT SetIndex(
[in] long Unit,
[in] long Index,
[in] long Extend
);
パラメーター
[in] Unit
型: long
範囲のインデックスを作成するために使用される単位。 単位値の一覧については、「 ITextRange」を参照してください。
[in] Index
型: long
Unit のインデックス。 この範囲は、このインデックス番号を持つ Unit に再配置されます。 正の場合、 ユニットの番号付けはストーリーの開始時に開始され、先に進みます。 負の場合、段落番号はストーリーの最後から始まり、後方に進みます。 ストーリーの開始は、存在するすべてのユニットの Index 1 に対応し、ストーリーの最後のユニットは -1 の インデックス に対応します。
[in] Extend
型: long
範囲の範囲を示すフラグ。 0 (既定値) の場合、指定した Unit の開始位置にある挿入ポイントに範囲が折りたた まれます。 0 以外の場合、範囲は Unit 全体に設定されます。
戻り値
種類: HRESULT
メソッドは HRESULT 値を返します。 メソッドが成功すると、 S_OKが返されます。 メソッドが失敗した場合は、次のいずれかのエラー コードが返されます。 COM エラー コードの詳細については、「COM でのエラー処理」を参照してください。
リターン コード | 説明 |
---|---|
|
インデックスが無効です。 |
|
ユニットはサポートされていません。 |
|
何らかの理由で失敗しました。 |
注釈
このメソッドを使用すると、アプリケーションは、プログラムなどの行指向のテキストを便利な方法で操作できます。 たとえば、 SetIndex(tomLine, 10, 0)
範囲を 10 行目の先頭の挿入ポイントに変換します。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
対象プラットフォーム | Windows |
ヘッダー | tom.h |
[DLL] | Msftedit.dll |
関連項目
概念
リファレンス