Método ITextRange::GetIndex (tom.h)

Recupera el índice de historia del parámetro Unit en la posición del carácter Start del intervalo especificado. La primera unidad de un artículo tiene un valor de índice de 1. El índice de una unidad es el mismo para todas las posiciones de caracteres de que preceden inmediatamente a la unidad hasta el último carácter de la unidad.

Sintaxis

HRESULT GetIndex(
  long Unit,
  long *pIndex
);

Parámetros

Unit

Tipo: long

Unidad indizada. Para obtener una lista de los posibles valores de unidad , vea la discusión en ITextRange.

pIndex

Tipo: long*

Valor del índice. El valor es cero si unit no existe.

Valor devuelto

Tipo: HRESULT

El método devuelve un valor HRESULT . Si el método se realiza correctamente, devuelve S_OK. Si se produce un error en el método, devuelve uno de los siguientes códigos de error. Para obtener más información sobre los códigos de error COM, vea Control de errores en COM.

Código devuelto	Descripción
E_INVALIDARG	pIndex es null.
E_NOTIMPL	La unidad no existe.

Comentarios

El método ITextRange::GetIndex recupera el índice de historia de una palabra, línea, frase, párrafo, etc., en el intervalo Start. Unit especifica qué tipo de entidad se va a indexar, como palabras (tomWord), líneas (tomLine), oraciones (tomSentence) o párrafos (tomParagraph). Por ejemplo, ITextRange::GetIndex establece pIndex igual al número de línea de la primera línea del intervalo. Para un intervalo al final del artículo, ITextRange::GetIndex, devuelve el número de unidadesdel artículo. Por lo tanto, puede obtener el número de palabras, líneas, objetos, etc., en una historia.

El valor de índice devuelto por el método ITextRange::GetIndex no es válido si el texto se edita posteriormente. Por lo tanto, los usuarios deben tener cuidado con el uso de métodos que devuelven valores de índice, especialmente si los valores se van a almacenar durante cualquier tiempo. Esto contrasta con un puntero a un intervalo, que sigue siendo válido cuando se edita el texto.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	tom.h
Archivo DLL	Msftedit.dll

Consulte también

Conceptual

ITextRange

Referencia

Modelo de objetos de texto