Edit

SetupDiGetClassBitmapIndex function (setupapi.h)

  • Article

The SetupDiGetClassBitmapIndex function retrieves the index of the mini-icon supplied for the specified class.

Syntax

WINSETUPAPI BOOL SetupDiGetClassBitmapIndex(
  [in, optional] const GUID *ClassGuid,
  [out]          PINT       MiniIconIndex
);

Parameters

[in, optional] ClassGuid

A pointer to the GUID of the device setup class for which to retrieve the mini-icon. This pointer is optional and can be NULL.

[out] MiniIconIndex

A pointer to a variable of type INT that receives the index of the mini-icon for the specified device setup class. If the ClassGuid parameter is NULL or if there is no mini-icon for the specified class, SetupDiGetClassBitmapIndex returns the index of the mini-icon for the Unknown device setup class.

Return value

If there is a min-icon for the specified device setup class, SetupDiGetClassBitmapIndex returns TRUE. Otherwise, this function returns FALSE and the logged error can be retrieved with a call to GetLastError. If the ClassGuid parameter is NULL, or if there is no mini-icon for the specified class, the function returns FALSE and GetLastError returns ERROR_NO_DEVICE_ICON.

Remarks

For a list of the device setup class mini-icons and their corresponding indexes, see SetupDiDrawMiniIcon.

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
DLL Setupapi.dll

See also

SetupDiDrawMiniIcon

SetupDiLoadClassIcon