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

Recupera o índice de história do parâmetro Unit na posição do caractere Start do intervalo especificado. A primeira Unidade em uma história tem um valor de índice de 1. O índice de uma Unidade é o mesmo para todas as posições de caractere do que imediatamente precedeu a Unidade até o último caractere na Unidade.

Sintaxe

HRESULT GetIndex(
  long Unit,
  long *pIndex
);

Parâmetros

Unit

Tipo: long

Unidade indexada. Para obter uma lista de possíveis valores unitários , consulte a discussão em ITextRange.

pIndex

Tipo: long*

O valor de índice. O valor será zero se Unit não existir.

Retornar valor

Tipo: HRESULT

O método retorna um valor HRESULT . Se o método for bem-sucedido, ele retornará S_OK. Se o método falhar, ele retornará um dos seguintes códigos de erro. Para obter mais informações sobre códigos de erro COM, consulte Tratamento de erros em COM.

Código de retorno	Descrição
E_INVALIDARG	pIndex é nulo.
E_NOTIMPL	A unidade não existe.

Comentários

O método ITextRange::GetIndex recupera o índice de história de uma palavra, linha, frase, parágrafo e assim por diante, no intervalo Iniciar. A unidade especifica qual tipo de entidade indexar, como palavras (tomWord), linhas (tomLine), frases (tomSentence) ou parágrafos (tomParagraph). Por exemplo, ITextRange::GetIndex define pIndex igual ao número de linha da primeira linha no intervalo. Para um intervalo no final da história, ITextRange::GetIndex, retorna o número de Unidadesna história. Assim, você pode obter o número de palavras, linhas, objetos e assim por diante, em uma história.

O valor de índice retornado pelo método ITextRange::GetIndex não é válido se o texto for editado posteriormente. Portanto, os usuários devem ter cuidado com o uso de métodos que retornam valores de índice, especialmente se os valores devem ser armazenados por qualquer duração. Isso contrasta com um ponteiro para um intervalo, que permanece válido quando o texto é editado.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	tom.h
DLL	Msftedit.dll

Confira também

Conceitual

ITextRange

Referência

Modelo de objeto de texto