SetupDiGetClassDescriptionA-Funktion (setupapi.h)
Die SetupDiGetClassDescription Funktion ruft die Klassenbeschreibung ab, die der angegebenen Setupklassen-GUID zugeordnet ist.
Syntax
WINSETUPAPI BOOL SetupDiGetClassDescriptionA(
[in] const GUID *ClassGuid,
[out] PSTR ClassDescription,
[in] DWORD ClassDescriptionSize,
[out, optional] PDWORD RequiredSize
);
Parameter
[in] ClassGuid
Die GUID der Setupklasse, deren Beschreibung abgerufen werden soll.
[out] ClassDescription
Ein Zeiger auf einen Zeichenpuffer, der die Klassenbeschreibung empfängt.
[in] ClassDescriptionSize
Die Größe des ClassDescription- Puffers in Zeichen.
[out, optional] RequiredSize
Ein Zeiger auf die Variable vom Typ DWORD, die die Größe in Zeichen empfängt, die zum Speichern der Klassenbeschreibung (einschließlich eines NULL-Terminators) erforderlich ist. RequiredSize ist immer kleiner als LINE_LEN. Dieser Parameter ist optional und kann NULL-werden.
Rückgabewert
Die Funktion gibt TRUE- zurück, wenn sie erfolgreich ist. Andernfalls wird FALSE- zurückgegeben, und der protokollierte Fehler kann mit einem Aufruf von GetLastErrorabgerufen werden.
Bemerkungen
Rufen Sie SetupDiGetClassDescriptionEx- auf, um die Beschreibung einer auf einem Remotecomputer installierten Setupklasse abzurufen.
Anmerkung
Der header setupapi.h definiert SetupDiGetClassDescription 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 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- | Verfügbar in Microsoft Windows 2000 und höheren Versionen von Windows. |
| Zielplattform- | Desktop |
| Header- | setupapi.h (include Setupapi.h) |
| Library | Setupapi.lib |