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 so viele 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 in den Puffer kopierten Zeichen.
Wenn die optionale Textbeschreibung nicht vorhanden ist, ist der Rückgabewert 0.
Wenn die Funktion fehlschlägt, wird der Rückgabewert GDI_ERROR.
Hinweise
Die optionale Textbeschreibung enthält zwei Zeichenfolgen: die erste, die die Anwendung identifiziert, die die erweiterte Metadatei erstellt hat, und die zweite, die das in der Metadatei enthaltene Bild identifiziert. Die Zeichenfolgen werden durch ein NULL-Zeichen getrennt und mit zwei NULL-Zeichen beendet, z. B. "XYZ Graphics Editor\0Bald Eagle\0\0", wobei \0 das NULL-Zeichen 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.
Hinweis
Der wingdi.h-Header definiert GetEnhMetaFileDescription als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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
| Unterstützte Mindestversion (Client) | Windows 2000 Professional [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | wingdi.h (einschließlich Windows.h) |
| Bibliothek | Gdi32.lib |
| DLL | Gdi32.dll |