Metodo ITextRange::GetIndex (tom.h)

Recupera l'indice della storia del parametro Unit nella posizione del carattere Start dell'intervallo specificato. La prima unità in una storia ha un valore di indice pari a 1. L'indice di un'unità è lo stesso per tutte le posizioni dei caratteri immediatamente precedenti all'unità fino all'ultimo carattere nell'unità.

Sintassi

HRESULT GetIndex(
  long Unit,
  long *pIndex
);

Parametri

Unit

Tipo: long

Unità indicizzata. Per un elenco dei possibili valori unit , vedere la discussione in ITextRange.

pIndex

Tipo: long*

Valore di indice. Il valore è zero se Unit non esiste.

Valore restituito

Tipo: HRESULT

Il metodo restituisce un valore HRESULT . Se il metodo ha esito positivo, restituisce S_OK. Se il metodo ha esito negativo, restituisce uno dei codici di errore seguenti. Per altre informazioni sui codici di errore COM, vedere Gestione degli errori in COM.

Commenti

Il metodo ITextRange::GetIndex recupera l'indice della storia di una parola, una riga, una frase, un paragrafo e così via, all'intervallo Start. Unità specifica il tipo di entità da indicizzare, ad esempio parole (tomWord), righe (tomLine), frasi (tomSentence) o paragrafi (tomParagraph). Ad esempio, ITextRange::GetIndex imposta pIndex uguale al numero di riga della prima riga dell'intervallo. Per un intervallo alla fine della storia, ITextRange::GetIndex restituisce il numero di unitànella storia. È quindi possibile ottenere il numero di parole, righe, oggetti e così via, in una storia.

Il valore dell'indice restituito dal metodo ITextRange::GetIndex non è valido se il testo viene successivamente modificato. Pertanto, gli utenti devono prestare attenzione all'uso di metodi che restituiscono i valori dell'indice, soprattutto se i valori devono essere archiviati per qualsiasi durata. A differenza di un puntatore a un intervallo, che rimane valido quando il testo viene modificato.

Requisiti

Vedi anche

Informazioni concettuali

ITextRange

Riferimento

Modello a oggetti testo