Função SetupDiLoadDeviceIcon (setupapi.h)

A função SetupDiLoadDeviceIcon recupera um ícone para um dispositivo especificado.

Sintaxe

WINSETUPAPI BOOL SetupDiLoadDeviceIcon(
  [in]  HDEVINFO         DeviceInfoSet,
  [in]  PSP_DEVINFO_DATA DeviceInfoData,
  [in]  UINT             cxIcon,
  [in]  UINT             cyIcon,
  [in]  DWORD            Flags,
  [out] HICON            *hIcon
);

Parâmetros

[in] DeviceInfoSet

Um identificador para o conjunto de informações do dispositivo que contém o elemento de informações do dispositivo que representa o dispositivo para o qual recuperar um ícone.

[in] DeviceInfoData

Um ponteiro para uma estrutura SP_DEVINFO_DATA que especifica o elemento de informações do dispositivo em DeviceInfoSet.

[in] cxIcon

A largura, em pixels, do ícone a ser recuperado. Use o índice de métrica do sistema SM_CXICON para especificar um ícone de tamanho padrão ou usar o índice de métrica do sistema SM_CXSMICON para especificar um ícone pequeno. Os índices de métrica do sistema são definidos em Winuser.h e seus valores associados podem ser recuperados por uma chamada para a função GetSystemMetrics . (A função GetSystemMetrics está documentada no SDK do Microsoft Windows.)

[in] cyIcon

A altura, em pixels, do ícone a ser recuperado. Use SM_CXICON para especificar um ícone de tamanho padrão ou usar SM_CXSMICON para especificar um ícone pequeno.

[in] Flags

Não usado. Deve ser definido como zero.

[out] hIcon

Um ponteiro para um identificador para um ícone que recebe um identificador para o ícone que essa função recupera. Depois que o aplicativo que chama essa função terminar de usar o ícone, o aplicativo deverá chamar DestroyIcon para excluir o ícone. (DestroyIcon está documentado no SDK do Microsoft Windows.)

Retornar valor

SetupDiLoadDeviceIcon retornará TRUE se a função tiver êxito na recuperação do ícone do dispositivo especificado. Caso contrário, a função retornará FALSE e o erro registrado poderá ser recuperado por uma chamada para GetLastError.

Comentários

SetupDiLoadDeviceIcon tenta recuperar um ícone para o dispositivo da seguinte maneira:

• Se a propriedade DEVPKEY_DrvPkg_Icon dispositivo do dispositivo incluir uma lista de cadeias de caracteres de identificador de recurso, a função tentará recuperar o ícone especificado pela primeira cadeia de caracteres do identificador de recurso na lista.

  O tipo de dados de propriedade do dispositivo da propriedade do dispositivo DEVPKEY_DrvPkg_Icon é DEVPROP_TYPE_STRING_LIST.

  O formato de uma cadeia de caracteres de identificador de recurso é

  [filepath\]filename,-resourceID
  

  Em que:

  • filepath, seguido pelo caractere de barra invertida (\\), é opcional e especifica um caminho do arquivo que contém o ícone.
  • FileName, seguido pelo caractere de vírgula (",") especifica o nome do arquivo que contém o ícone.
  • ResourceID, precedido por um caractere de traço ("-"), especifica a ID do recurso do ícone.
• Se a função não puder recuperar um ícone específico do dispositivo, ela tentará recuperar o ícone de classe do dispositivo. Para obter informações sobre ícones de classe, consulte SetupDiLoadClassIcon.
• Se a função não puder recuperar o ícone de classe do dispositivo, ela tentará recuperar o ícone da classe de configuração de dispositivo Desconhecido, em que o ícone da classe de configuração de dispositivo Desconhecido inclui a imagem de um ponto de interrogação (?).

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Disponível no Windows Vista e versões posteriores do Windows.
Plataforma de Destino	Área de Trabalho
Cabeçalho	setupapi.h (inclua Setupapi.h)
Biblioteca	Setupapi.lib
DLL	Setupapi.dll

Confira também

DEVPROP_TYPE_STRING_LIST

SetupDiLoadClassIcon