SetupDiGetClassDescriptionA function

The SetupDiGetClassDescription function retrieves the class description associated with the specified setup class GUID.

Syntax

WINSETUPAPI BOOL SetupDiGetClassDescriptionA(
  CONST GUID *ClassGuid,
  PSTR       ClassDescription,
  DWORD      ClassDescriptionSize,
  PDWORD     RequiredSize
);

Parameters

ClassGuid

The GUID of the setup class whose description is to be retrieved.

ClassDescription

A pointer to a character buffer that receives the class description.

ClassDescriptionSize

The size, in characters, of the ClassDescription buffer.

RequiredSize

A pointer to variable of type DWORD that receives the size, in characters, that is required to store the class description (including a NULL terminator). RequiredSize is always less than LINE_LEN. This parameter is optional and can be NULL.

Return Value

The function returns TRUE if it is successful. Otherwise, it returns FALSE and the logged error can be retrieved with a call to GetLastError.

Remarks

Call SetupDiGetClassDescriptionEx to retrieve the description of a setup class installed on a remote computer.

Requirements

   
Windows version Available in Microsoft Windows 2000 and later versions of Windows.
Target Platform Desktop
Header setupapi.h (include Setupapi.h)
Library Setupapi.lib

See Also

SetupDiBuildClassInfoList

SetupDiGetClassDescriptionEx

SetupDiGetINFClass