SetupDiGetClassDescriptionExA-Funktion (setupapi.h)
Die SetupDiGetClassDescriptionEx--Funktion ruft die Beschreibung einer Setupklasse ab, die auf einem lokalen oder Remotecomputer installiert ist.
Syntax
WINSETUPAPI BOOL SetupDiGetClassDescriptionExA(
[in] const GUID *ClassGuid,
[out] PSTR ClassDescription,
[in] DWORD ClassDescriptionSize,
[out, optional] PDWORD RequiredSize,
[in, optional] PCSTR MachineName,
PVOID Reserved
);
Parameter
[in] ClassGuid
Ein Zeiger auf die GUID für die Setupklasse, deren Beschreibung abgerufen werden soll.
[out] ClassDescription
Ein Zeiger auf einen Zeichenpuffer, der die Klassenbeschreibung empfängt.
[in] ClassDescriptionSize
Die Größe des Puffers, auf den der ClassDescription- Parameter verweist, in Zeichen. Die maximale Länge einer NULL-beendeten Klassenbeschreibung in Zeichen ist LINE_LEN. Weitere Informationen finden Sie im folgenden abschnitt Anmerkungen.
[out, optional] RequiredSize
Ein Zeiger auf eine DWORD-Typvariable, die die Größe in Zeichen empfängt, die zum Speichern der angeforderten NULL-beendeten Klassenbeschreibung erforderlich ist. Dieser Zeiger ist optional und kann NULL-sein.
[in, optional] MachineName
Ein Zeiger auf eine MIT NULL beendete Zeichenfolge, die den Namen eines Remotecomputers angibt, auf dem sich die Setupklasse befindet. Dieser Zeiger ist optional und kann NULL-sein. Wenn die Klasse auf einem lokalen Computer installiert ist, legen Sie den Zeiger auf NULL-fest.
Vorsicht
Die Verwendung dieser Funktion für den Zugriff auf Remotecomputer wird ab Windows 8 und Windows Server 2012 nicht unterstützt, da diese Funktionalität entfernt wurde.
Reserved
Reserviert für die Systemverwendung. Ein Aufrufer dieser Funktion muss diesen Parameter auf NULL-festlegen.
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
Wenn im Registrierungsschlüssel für die Klasse ein Anzeigename vorhanden ist, gibt diese Routine den Anzeigenamen zurück. Andernfalls gibt diese Routine den Klassennamen zurück.
SetupDiGetClassDescriptionEx erzwingt keine Einschränkung der Klassenbeschreibung, die zurückgegeben werden kann. Diese Funktion gibt die erforderliche Größe für eine BESCHREIBUNG der MIT NULL beendeten Klasse zurück, auch wenn sie größer als LINE_LEN ist. LINE_LEN ist jedoch die maximale Länge einer gültigen NULL-beendeten Klassenbeschreibung. Ein Aufrufer sollte niemals einen Puffer benötigen, der größer als LINE_LEN ist.
Anmerkung
Der header setupapi.h definiert SetupDiGetClassDescriptionEx 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 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 |