SetupDiGetClassDescriptionA-Funktion (setupapi.h)

  • Artikel

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 erforderlich ist (einschließlich eines NULL-Abschlussators). RequiredSize ist immer kleiner als LINE_LEN. Dieser Parameter ist optional und kann NULL sein.

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

Rufen Sie SetupDiGetClassDescriptionEx auf, um die Beschreibung einer Setupklasse abzurufen, die auf einem Remotecomputer installiert ist.

Hinweis

Der setupapi.h-Header definiert SetupDiGetClassDescription 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) Verfügbar in Microsoft Windows 2000 und höheren Versionen von Windows.
Zielplattform Desktop
Kopfzeile setupapi.h (einschließlich Setupapi.h)
Bibliothek Setupapi.lib

Weitere Informationen

SetupDiBuildClassInfoList

SetupDiGetClassDescriptionEx

SetupDiGetINFClass