EnumClipboardFormats-Funktion (winuser.h)

Artikel
08/27/2023

Listet die derzeit in der Zwischenablage verfügbaren Datenformate auf.

Zwischenablagedatenformate werden in einer sortierten Liste gespeichert. Um eine Enumeration von Zwischenablagedatenformaten auszuführen, führen Sie eine Reihe von Aufrufen der EnumClipboardFormats-Funktion durch. Für jeden Aufruf gibt der Formatparameter ein verfügbares Zwischenablageformat an, und die Funktion gibt das nächste verfügbare Zwischenablageformat zurück.

Syntax

UINT EnumClipboardFormats(
  [in] UINT format
);

Parameter

[in] format

Typ: UINT

Ein Zwischenablageformat, das bekannt ist, dass es verfügbar ist.

Um eine Enumeration von Zwischenablageformaten zu starten, legen Sie format auf 0 (null) fest. Wenn format null ist, ruft die Funktion das erste verfügbare Zwischenablageformat ab. Legen Sie für nachfolgende Aufrufe während einer Enumeration format auf das Ergebnis des vorherigen EnumClipboardFormats-Aufrufs fest.

Rückgabewert

Typ: UINT

Wenn die Funktion erfolgreich ist, ist der Rückgabewert das Zwischenablageformat, das dem angegebenen Format folgt, nämlich dem nächsten verfügbaren Zwischenablageformat.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf. Wenn die Zwischenablage nicht geöffnet ist, schlägt die Funktion fehl.

Wenn keine weiteren Zwischenablageformate aufgelistet werden müssen, ist der Rückgabewert 0 (null). In diesem Fall gibt die GetLastError-Funktion den Wert ERROR_SUCCESS zurück. Dadurch können Sie zwischen Funktionsfehlern und dem Ende der Enumeration unterscheiden.

Hinweise

Sie müssen die Zwischenablage öffnen, bevor Sie die Formate auflisten. Verwenden Sie die OpenClipboard-Funktion , um die Zwischenablage zu öffnen. Die EnumClipboardFormats-Funktion schlägt fehl, wenn die Zwischenablage nicht geöffnet ist.

Die EnumClipboardFormats-Funktion listet Formate in der Reihenfolge auf, in der sie in der Zwischenablage platziert wurden. Wenn Sie Informationen in die Zwischenablage kopieren, fügen Sie Zwischenablageobjekte in der Reihenfolge vom beschreibendsten Zwischenablageformat zum am wenigsten beschreibenden Zwischenablageformat hinzu. Wenn Sie Informationen aus der Zwischenablage einfügen, rufen Sie das erste Zwischenablageformat ab, das Sie verarbeiten können. Dies ist das beschreibendste Zwischenablageformat, das Sie verarbeiten können.

Das System bietet automatische Typkonvertierungen für bestimmte Zwischenablageformate. Im Fall eines solchen Formats listet diese Funktion das angegebene Format auf und listet dann die Formate auf, in die es konvertiert werden kann. Weitere Informationen finden Sie unter Standard-Zwischenablageformate und synthetisierte Zwischenablageformate.

Beispiele

Ein Beispiel finden Sie unter Beispiel für einen Zwischenablage-Viewer.

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 (windows.h einschließen)
Bibliothek	User32.lib
DLL	User32.dll
APIs	ext-ms-win-ntuser-misc-l1-5-1 (eingeführt in Windows 10, Version 10.0.14393)