SetupDiGetClassDescription function

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

Syntax


BOOL SetupDiGetClassDescription(
  _In_      const GUID   *ClassGuid,
  _Out_           PTSTR  ClassDescription,
  _In_            DWORD  ClassDescriptionSize,
  _Out_opt_       PDWORD RequiredSize
);

Parameters

ClassGuid [in]

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

ClassDescription [out]

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

ClassDescriptionSize [in]

The size, in characters, of the ClassDescription buffer.

RequiredSize [out, optional]

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

Target platform

Desktop

Version

Available in Microsoft Windows 2000 and later versions of Windows.

Header

Setupapi.h (include Setupapi.h)

Library

Setupapi.lib

See also

SetupDiBuildClassInfoList
SetupDiGetClassDescriptionEx
SetupDiGetINFClass

 

 

Send comments about this topic to Microsoft

Show: