GetEnhMetaFileDescriptionA-Funktion (wingdi.h)
Die GetEnhMetaFileDescription--Funktion ruft eine optionale Textbeschreibung aus einer Metadatei im erweiterten Format ab und kopiert die Zeichenfolge in den angegebenen Puffer.
Syntax
UINT GetEnhMetaFileDescriptionA(
[in] HENHMETAFILE hemf,
[in] UINT cchBuffer,
[out] LPSTR lpDescription
);
Parameter
[in] hemf
Ein Handle für die erweiterte Metadatei.
[in] cchBuffer
Die Größe des Puffers, der die Daten empfangen soll, in Zeichen. Nur diese anzahl Zeichen werden kopiert.
[out] lpDescription
Ein Zeiger auf einen Puffer, der die optionale Textbeschreibung empfängt.
Rückgabewert
Wenn die optionale Textbeschreibung vorhanden ist und der Pufferzeiger NULL-ist, ist der Rückgabewert die Länge der Textzeichenfolge in Zeichen.
Wenn die optionale Textbeschreibung vorhanden ist und der Pufferzeiger ein gültiger Zeiger ist, ist der Rückgabewert die Anzahl der Zeichen, die in den Puffer kopiert wurden.
Wenn die optionale Textbeschreibung nicht vorhanden ist, ist der Rückgabewert null.
Wenn die Funktion fehlschlägt, wird der Rückgabewert GDI_ERROR.
Bemerkungen
Die optionale Textbeschreibung enthält zwei Zeichenfolgen, die erste identifizieren die Anwendung, die die erweiterte Metadatei erstellt hat, und die zweite, die das Bild in der Metadatei identifiziert. Die Zeichenfolgen werden durch ein NULL-Zeichen getrennt und mit zwei Nullzeichen beendet, z. B. "XYZ Graphics Editor\0Bald Eagle\0\0", wobei "\0" das Nullzeichen darstellt.
Wenn Textargumente Unicode-Zeichen verwenden müssen, verwenden Sie diese Funktion als Breitzeichenfunktion. Wenn Textargumente Zeichen aus dem Windows-Zeichensatz verwenden müssen, verwenden Sie diese Funktion als ANSI-Funktion.
Anmerkung
The wingdi.h header defines GetEnhMetaFileDescription as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, 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 |
---|---|
mindestens unterstützte Client- | Windows 2000 Professional [nur Desktop-Apps] |
mindestens unterstützte Server- | Windows 2000 Server [nur Desktop-Apps] |
Zielplattform- | Fenster |
Header- | wingdi.h (enthalten Windows.h) |
Library | Gdi32.lib |
DLL- | Gdi32.dll |
Siehe auch
übersicht über Metadateien