iTextRange::GetIndex 方法 (tom.h)

检索指定范围 Start 字符位置处 的 Unit 参数的文字索引。 故事中的第一个 单位 的索引值为 1。 单位的索引对于从紧靠在 Unit 前面到单位中最后一个字符的所有字符位置都是相同的。

语法

HRESULT GetIndex(
  long Unit,
  long *pIndex
);

参数

Unit

类型: long

已编制索引的单位。 有关可能 单位 值的列表,请参阅 ITextRange 下的讨论。

pIndex

类型: long*

索引值。 如果 Unit 不存在,则值为零。

返回值

类型: HRESULT

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

返回代码 说明
E_INVALIDARG
pIndex 为 null。
E_NOTIMPL
单位不存在。

注解

ITextRange::GetIndex 方法检索 Start 范围内的单词、行、句子、段落等文章索引。 单位 指定要编制索引的实体类型,例如 tomWord) (单词、 (tomLine) 的行、 (tomSentence) 的句子或 tomParagraph) (段落。 例如, ITextRange::GetIndexpIndex 设置为等于范围中第一行的行号。 对于文章末尾的范围, ITextRange::GetIndex 返回文章中的 单位数。 因此,可以获取文章中的单词、行数、对象数等。

如果随后编辑文本, 则 ITextRange::GetIndex 方法返回的索引值无效。 因此,用户应谨慎使用返回索引值的方法,尤其是在值存储任何持续时间时。 这与指向区域的指针形成鲜明对比,该区域在编辑文本时仍然有效。

要求

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

请参阅

概念性

ITextRange

引用

文本对象模型