ITextRange：：SetIndex 方法 (tom.h)

將此範圍變更為本文的指定單位。

語法

HRESULT SetIndex(
  [in] long Unit,
  [in] long Index,
  [in] long Extend
);

參數

[in] Unit

類型： long

用來為範圍編製索引的單位。 如需單位值的清單，請參閱 ITextRange。

[in] Index

類型： long

單位的索引。 此範圍會重新定位至具有此索引編號的 單位 。 如果是正數， 則 Unit 的編號會從本文開頭開始，然後繼續進行。 如果為負數，則編號會從本文結尾開始，然後往後繼續。 本文開頭會對應至所有存在單位的 Index 為 1，而本文中的最後一個單位則對應至 -1 的 索引 。

[in] Extend

類型： long

指出範圍範圍的旗標。 如果零 (預設) ，範圍會折疊至指定 Unit 的起始位置的插入點。 如果為非零，範圍會設定為整個 Unit。

傳回值

類型： HRESULT

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

傳回碼	Description
E_INVALIDARG	索引無效。
E_NOTIMPL	不支持單位。
S_FALSE	因其他原因而失敗。

備註

此方法可讓應用程式以方便的方式使用程序導向文字，例如程式。 例如， SetIndex(tomLine, 10, 0) 將範圍轉換成第十行開頭的插入點。

規格需求

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

另請參閱

概念

ITextRange

參考

文字物件模型