SetCaretPos-Funktion (winuser.h)

Artikel
03/04/2024

Verschiebt den Caret auf die angegebenen Koordinaten. Wenn das Fenster, das den Caret besitzt, mit dem CS_OWNDC Klassenstil erstellt wurde, unterliegen die angegebenen Koordinaten dem Zuordnungsmodus des diesem Fenster zugeordneten Gerätekontexts.

Syntax

BOOL SetCaretPos(
  [in] int X,
  [in] int Y
);

Parameter

[in] X

Typ: int

Die neue x-Koordinate des Caret.

[in] Y

Typ: int

Die neue y-Koordinate des Caret.

Rückgabewert

Typ: BOOL

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

SetCaretPos verschiebt den Caret, ob das Caret ausgeblendet ist.

Das System stellt einen Caret pro Warteschlange bereit. Ein Fenster sollte nur dann ein Caret erstellen, wenn es den Tastaturfokus hat oder aktiv ist. Das Fenster sollte das Caret zerstören, bevor der Tastaturfokus verloren geht oder inaktiv wird. Ein Fenster kann die Caretposition nur festlegen, wenn es den Caret besitzt.

DPI-Virtualisierung

Diese API ist nicht an der DPI-Virtualisierung beteiligt. Die bereitgestellte Position wird als logische Koordinaten im Sinne des fensters interpretiert, das dem Caret zugeordnet ist. Der aufrufende Thread wird nicht berücksichtigt.

Beispiele

Ein Beispiel finden Sie unter Erstellen und Anzeigen eines Carets.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winuser.h (einschließlich Windows.h)
Bibliothek	User32.lib
DLL	User32.dll
APIs	ext-ms-win-ntuser-caret-l1-1-0 (eingeführt in Windows 8)