ITextRange：：GetIndex 方法 (tom.h)

  • 發行項

擷取 Unit 參數在指定範圍開始字元位置的本文索引。 本文中的第一個 單位 具有 1 的索引值。 單位的索引與 Unit 中緊接在 Unit 最後一個字元之前的所有字元位置相同。

語法

HRESULT GetIndex(
  long Unit,
  long *pIndex
);

參數

Unit

類型： long

已編製索引的單位。 如需可能的 Unit 值清單，請參閱 ITextRange 下的討論。

pIndex

類型： long*

索引值。 如果 Unit 不存在，則值為零。

傳回值

類型： HRESULT

方法會傳回 HRESULT 值。 如果方法成功，則會傳回 S_OK。 如果方法失敗，它會傳回下列其中一個錯誤碼。 如需 COM 錯誤碼的詳細資訊，請參閱 COM 中的錯誤處理。

傳回碼 Description
E_INVALIDARG
 pIndex 為 null。
E_NOTIMPL
 單位不存在。

備註

ITextRange：：GetIndex 方法會擷取範圍 Start 之單字、行、句子、段落等的本文索引。 單位 會指定要編製索引的實體類型，例如 tomWord () 、行 (tomLine) 、句子 (tomSentence) ，或 tomParagraph) (段落。 例如， ITextRange：：GetIndex 會將 pIndex 設定為等於範圍中第一行的行號。 對於本文結尾的範圍 ，ITextRange：：GetIndex 會傳回本文中的 Units數目。 因此，您可以在本文中取得字數、行、物件等等。

如果後續編輯文字， ITextRange：：GetIndex 方法所傳回的索引值無效。 因此，用戶應該小心使用傳回索引值的方法，特別是當值儲存在任何持續時間時。 這與範圍指標相反，在編輯文字時仍有效。

規格需求

需求 值
最低支援的用戶端 Windows Vista [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2003 [僅限傳統型應用程式]
目標平台 Windows
標頭 tom.h
Dll Msftedit.dll

另請參閱

概念

ITextRange

參考

文字物件模型