GetClipboardFormatNameA-Funktion (winuser.h)

Ruft den Namen des angegebenen registrierten Formats aus der Zwischenablage ab. Die Funktion kopiert den Namen in den angegebenen Puffer.

Syntax

int GetClipboardFormatNameA(
  [in]  UINT  format,
  [out] LPSTR lpszFormatName,
  [in]  int   cchMaxCount
);

Parameter

[in] format

Typ: UINT

Der Typ des abzurufenden Formats. Dieser Parameter darf keines der vordefinierten Zwischenablageformate angeben.

[out] lpszFormatName

Typ: LPTSTR

Der Puffer, der den Formatnamen empfangen soll.

[in] cchMaxCount

Typ: int

Die maximale Länge der Zeichenfolge in Zeichen, die in den Puffer kopiert werden soll. Wenn der Name diesen Grenzwert überschreitet, wird er abgeschnitten.

Rückgabewert

Typ: int

Wenn die Funktion erfolgreich ist, ist der Rückgabewert die Länge der in den Puffer kopierten Zeichenfolge in Zeichen.

Wenn die Funktion fehlschlägt, ist der Rückgabewert 0, was angibt, dass das angeforderte Format nicht vorhanden oder vordefiniert ist. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Sicherheitsüberlegungen

Die falsche Verwendung dieser Funktion kann die Sicherheit Ihres Programms beeinträchtigen. Beispielsweise kann eine Fehlberechnung der richtigen Größe des lpszFormatName-Puffers , insbesondere wenn die Anwendung sowohl in ANSI- als auch in Unicode-Versionen verwendet wird, zu einem Pufferüberlauf führen. Beachten Sie außerdem, dass die Zeichenfolge abgeschnitten wird, wenn sie länger als der Parameter cchMaxCount ist, was zu Einem Informationsverlust führen kann.

Beispiele

Ein Beispiel finden Sie unter Beispiel für eine Zwischenablageanzeige.

Hinweis

Der winuser.h-Header definiert GetClipboardFormatName als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

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-misc-l1-1-0 (eingeführt in Windows 8)

Weitere Informationen

Zwischenablage

Konzept

EnumClipboardFormats

Referenz

RegisterClipboardFormat