Função SetupDiGetHwProfileListExA (setupapi.h)

Artigo
11/20/2024

A função SetupDiGetHwProfileListEx recupera uma lista de todas as IDs de perfil de hardware definidas no momento em um computador local ou remoto.

Sintaxe

WINSETUPAPI BOOL SetupDiGetHwProfileListExA(
  [out]           PDWORD HwProfileList,
  [in]            DWORD  HwProfileListSize,
  [out]           PDWORD RequiredSize,
  [out, optional] PDWORD CurrentlyActiveIndex,
  [in, optional]  PCSTR  MachineName,
                  PVOID  Reserved
);

Parâmetros

[out] HwProfileList

Um ponteiro para uma matriz para receber a lista de IDs de perfil de hardware definidas no momento.

[in] HwProfileListSize

O número de DWORDs no buffer de HwProfileList .

[out] RequiredSize

Um ponteiro para uma variável do tipo DWORD que recebe o número de perfis de hardware definidos no momento. Se o número for maior que HwProfileListSize, a lista será truncada para se ajustar ao tamanho da matriz. O valor retornado em RequiredSize indica o tamanho da matriz necessário para armazenar toda a lista de perfis de hardware.

[out, optional] CurrentlyActiveIndex

Um ponteiro para uma variável que recebe o índice do perfil de hardware atualmente ativo na lista de perfis de hardware recuperado. Esse parâmetro é opcional e pode ser NULL.

[in, optional] MachineName

Um ponteiro para uma cadeia de caracteres terminada em NULL que contém o nome de um sistema remoto para o qual recuperar a lista de IDs de perfil de hardware. Esse parâmetro é opcional e pode ser NULL. Se esse parâmetro for NULL, a lista será recuperada para o sistema local.

Cuidado

Não há suporte para o uso dessa função para acessar computadores remotos a partir do Windows 8 e do Windows Server 2012, pois essa funcionalidade foi removida.

Reserved

Deve ser NULL.

Valor de retorno

A função retornará TRUE se for bem-sucedida. Caso contrário, ele retornará FALSE e o erro registrado poderá ser recuperado fazendo uma chamada para GetLastError. Se o tamanho necessário for maior que HwProfileListSize, SetupDiGetHwProfileListEx retornará FALSE e uma chamada para GetLastError retornará ERROR_INSUFFICIENT_BUFFER.

Observações

Nota

O cabeçalho setupapi.h define SetupDiGetHwProfileListEx como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Disponível no Microsoft Windows 2000 e versões posteriores do Windows.
da Plataforma de Destino	Área de trabalho
cabeçalho	setupapi.h (inclua Setupapi.h)
biblioteca	Setupapi.lib

Consulte também

SetupDiGetHwProfileFriendlyNameEx

Compartilhar via