SetupDiGetClassDescriptionExA-Funktion (setupapi.h)

  • Artikel

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 in Zeichen, auf den der ClassDescription-Parameter verweist. Die maximale Länge (in Zeichen) einer Beschreibung einer NULL-beendeten Klasse ist LINE_LEN. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise" .

[out, optional] RequiredSize

Ein Zeiger auf eine Variable vom Typ DWORD, die die Größe in Zeichen empfängt, die zum Speichern der angeforderten KLASSENbeschreibung mit NULL-Beendigung erforderlich ist. Dieser Zeiger ist optional und kann NULL sein.

[in, optional] MachineName

Ein Zeiger auf eine NULL-endende 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.

Achtung

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

Ist für das System reserviert. 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 GetLastError abgerufen werden.

Hinweise

Wenn der Registrierungsschlüssel für die Klasse einen Anzeigenamen enthält, gibt diese Routine den Anzeigenamen zurück. Andernfalls gibt diese Routine den Klassennamen zurück.

SetupDiGetClassDescriptionEx erzwingt keine Einschränkung für die Länge der Klassenbeschreibung, die zurückgegeben werden kann. Diese Funktion gibt die erforderliche Größe für eine Beschreibung einer 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 Klassenbeschreibung mit NULL-Beendigung. Ein Aufrufer sollte niemals einen Puffer benötigen, der größer als LINE_LEN ist.

Hinweis

Der Setupapi.h-Header definiert SetupDiGetClassDescriptionEx 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
Unterstützte Mindestversion (Client) Verfügbar in Microsoft Windows 2000 und höheren Versionen von Windows.
Zielplattform Desktop
Kopfzeile setupapi.h (schließen Sie Setupapi.h ein)
Bibliothek Setupapi.lib

Weitere Informationen

SetupDiBuildClassInfoList

SetupDiBuildClassInfoListEx

SetupDiGetDeviceInfoListDetail

SetupDiGetINFClass