ITextRange::SetIndex 方法 (tom.h)

将此范围更改为文章的指定单位。

语法

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

参数

[in] Unit

类型: long

用于为范围编制索引的单位。 有关单位值的列表,请参阅 ITextRange

[in] Index

类型: long

单位的索引。 此范围将重定位到具有此索引号的 Unit 。 如果为正数, 则单位的编号从故事的开头开始并向前推进。 如果为负值,则编号从文章末尾开始,然后向后进行。 文章的开头对应于所有存在的单位的 索引 1,故事中的最后一个单位对应于 索引 -1。

[in] Extend

类型: long

指示范围范围的标志。 如果零 (默认) ,则范围将折叠到指定 单位的起始位置的插入点。 如果不是零值,则范围设置为整个 单位

返回值

类型: HRESULT

方法返回 HRESULT 值。 如果方法成功,则返回 S_OK。 如果方法失败,它将返回以下错误代码之一。 有关 COM 错误代码的详细信息,请参阅 COM 中的错误处理

返回代码 说明
E_INVALIDARG
索引无效。
E_NOTIMPL
不支持 Unit。
S_FALSE
由于其他某种原因而失败。

注解

此方法允许应用程序以方便的方式处理面向行的文本(如程序)。 例如, SetIndex(tomLine, 10, 0) 将范围转换为第十行开头的插入点。

要求

要求
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 tom.h
DLL Msftedit.dll

请参阅

概念性

ITextRange

引用

文本对象模型