Edit

SetupDiGetClassDescriptionA function (setupapi.h)

  • Article

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

Syntax

WINSETUPAPI BOOL SetupDiGetClassDescriptionA(
  [in]            const GUID *ClassGuid,
  [out]           PSTR       ClassDescription,
  [in]            DWORD      ClassDescriptionSize,
  [out, optional] PDWORD     RequiredSize
);

Parameters

[in] ClassGuid

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

[out] ClassDescription

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

[in] ClassDescriptionSize

The size, in characters, of the ClassDescription buffer.

[out, optional] 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.

Note

The setupapi.h header defines SetupDiGetClassDescription as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client 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