Función SetupDiLoadClassIcon (setupapi.h)

La función SetupDiLoadClassIcon carga el icono grande y miniicono de la clase especificada.

Sintaxis

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

Parámetros

[in] ClassGuid

Puntero al GUID de la clase para la que se deben cargar los iconos.

[out, optional] LargeIcon

Puntero a un identificador de icono que recibe el valor de identificador del icono grande cargado para la clase especificada. Este puntero es opcional y puede ser NULL. Si el puntero es NULL, no se carga el icono grande.

[out, optional] MiniIconIndex

Puntero a una variable con tipo INT que recibe el índice del miniicono de la clase especificada. El miniicono se almacena en la memoria caché del miniicono del instalador del dispositivo. El puntero es opcional y puede ser NULL.

Valor devuelto

La función devuelve TRUE si se realiza correctamente. De lo contrario, devuelve FALSE y el error registrado se puede recuperar mediante una llamada a GetLastError.

Comentarios

Los iconos de la clase están predefinidos y cargados desde la memoria caché interna del instalador del dispositivo o se cargan directamente desde el ejecutable del instalador de clase. Esta función consulta el valor del Registro ICON en la sección de la clase especificada. Si se especifica el valor ICON , indica qué miniicono se va a cargar.

Si el valor ICON es negativo, el valor absoluto representa un icono predefinido en el Registro de la clase. Consulte SetupDiDrawMiniIcon para obtener una lista de los mini iconos predefinidos.

Si el valor ICON es positivo, representa un icono en la imagen ejecutable del instalador de clase que se extraerá. El valor 1 está reservado. Esta función también usa el valor del Registro INSTALLER32 y, a continuación, el valor del Registro ENUMPROPPAGES32 para determinar de qué imagen ejecutable extraer los iconos. Para obtener más información sobre estos valores del Registro, vea sección INF ClassInstall32.

Cuando un llamador termina de usar el icono, el autor de la llamada debe llamar a DestroyIcon (que se describe en la documentación de Microsoft Windows SDK).

Si se especifica el parámetro LargeIcon , pero el parámetro ClassGuid no proporciona un GUID de clase válido o el valor del Registro Icon de la clase no es válido, SetupDiLoadClassIcon carga el icono grande predeterminado, devuelve el identificador del icono grande y, si se especifica el parámetro MiniIconIndex , devuelve el índice del miniicono predeterminado.

Requisitos

Cliente mínimo compatible	Disponible en Microsoft Windows 2000 y versiones posteriores de Windows.
Plataforma de destino	Escritorio
Encabezado	setupapi.h (incluya Setupapi.h)
Library	Setupapi.lib
Archivo DLL	Setupapi.dll

Consulte también

SetupDiDrawMiniIcon

SetupDiGetClassBitmapIndex