ITextRange::SetIndex-Methode (tom.h)

  • Artikel

Ändert diesen Bereich in die angegebene Einheit des Storys.

Syntax

HRESULT SetIndex(
  [in] long Unit,
  [in] long Index,
  [in] long Extend
);

Parameter

[in] Unit

Typ: long

Einheit, die zum Indizieren des Bereichs verwendet wird. Eine Liste der Einheitenwerte finden Sie unter ITextRange.

[in] Index

Typ: long

Index für die Einheit. Dieser Bereich wird in die Einheit mit dieser Indexnummer verschoben. Wenn die Nummerierung positiv ist, beginnt die Nummerierung der Einheits am Anfang der Geschichte und geht weiter. Wenn die Nummerierung negativ ist, beginnt die Nummerierung am Ende der Geschichte und verläuft rückwärts. Der Anfang der Geschichte entspricht einem Index von 1 für alle vorhandenen Einheiten, und die letzte Einheit in der Geschichte entspricht einem Index von -1.

[in] Extend

Typ: long

Flag, das die Ausdehnung des Bereichs angibt. Wenn null (Standard) ist, wird der Bereich an der Startposition der angegebenen Einheit auf eine Einfügemarke reduziert. Bei nichtzero wird der Bereich auf die gesamte Einheit festgelegt.

Rückgabewert

Typ: HRESULT

Die -Methode gibt einen HRESULT-Wert zurück. Wenn die Methode erfolgreich ist, gibt sie S_OK zurück. 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
 Der Index ist ungültig.
E_NOTIMPL
 Unit wird nicht unterstützt.
S_FALSE
 Fehler aus einem anderen Grund.

Hinweise

Diese Methode ermöglicht es einer Anwendung, mit zeilenorientiertem Text, z. B. Programmen, auf bequeme Weise zu arbeiten. Konvertiert beispielsweise SetIndex(tomLine, 10, 0) einen Bereich am Anfang der zehnten Zeile in eine Einfügemarke.

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