ITextRange::GetIndex-Methode (tom.h)

Ruft den Story-Index des Unit-Parameters an der angegebenen Startzeichenposition ab. Die erste Einheit in einem Story hat den Indexwert 1. Der Index einer Einheit ist für alle Zeichenpositionen von der unmittelbar vor der Einheit bis zum letzten Zeichen in der Einheit gleich.

Syntax

HRESULT GetIndex(
  long Unit,
  long *pIndex
);

Parameter

Unit

Typ: long

Indizierte Einheit. Eine Liste der möglichen Unit-Werte finden Sie in der Diskussion unter ITextRange.

pIndex

Typ: long*

Der Indexwert. Der Wert ist null, wenn Unit nicht vorhanden ist.

Rückgabewert

Typ: HRESULT

Die -Methode gibt einen HRESULT-Wert zurück. Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Wenn die Methode fehlschlägt, gibt sie einen der folgenden Fehlercodes zurück. Weitere Informationen zu COM-Fehlercodes finden Sie unter Fehlerbehandlung in COM.

Rückgabecode	Beschreibung
E_INVALIDARG	pIndex ist NULL.
E_NOTIMPL	Die Einheit ist nicht vorhanden.

Hinweise

Die ITextRange::GetIndex-Methode ruft den Textabschnittsindex eines Worts, einer Zeile, eines Satzes, eines Absatzes usw. im Bereich Start ab. Unit gibt an, welche Art von Entität indiziert werden soll, z. B. Wörter (tomWord), Zeilen (tomLine), Sätze (tomSentence) oder Absätze (tomParagraph). Beispielsweise legt ITextRange::GetIndexpIndex gleich der Zeilennummer der ersten Zeile im Bereich fest. Für einen Bereich am Ende des Storys gibt ITextRange::GetIndex die Anzahl der Einheitenim Storyabschnitt zurück. Daher können Sie die Anzahl von Wörtern, Zeilen, Objekten usw. in einer Geschichte abrufen.

Der von der ITextRange::GetIndex-Methode zurückgegebene Indexwert ist ungültig, wenn der Text anschließend bearbeitet wird. Daher sollten Benutzer bei der Verwendung von Methoden, die Indexwerte zurückgeben, vorsichtig sein, insbesondere wenn die Werte für eine beliebige Dauer gespeichert werden sollen. Dies steht im Gegensatz zu einem Zeiger auf einen Bereich, der bei der Bearbeitung des Texts gültig bleibt.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	tom.h
DLL	Msftedit.dll

Siehe auch

Konzept

ITextRange

Referenz

Textobjektmodell