Função SetupDiGetHwProfileFriendlyNameExA (setupapi.h)
A função SetupDiGetHwProfileFriendlyNameEx recupera o nome amigável associado a uma ID de perfil de hardware em um computador local ou remoto.
Sintaxe
WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameExA(
[in] DWORD HwProfile,
[out] PSTR FriendlyName,
[in] DWORD FriendlyNameSize,
[out, optional] PDWORD RequiredSize,
[in, optional] PCSTR MachineName,
PVOID Reserved
);
Parâmetros
[in] HwProfile
Fornece a ID do perfil de hardware associada ao nome amigável a ser recuperado. Se esse parâmetro for 0, o nome amigável do perfil de hardware atual será recuperado.
[out] FriendlyName
Um ponteiro para um buffer de caracteres para receber o nome amigável.
[in] FriendlyNameSize
O tamanho, em caracteres, do buffer FriendlyName.
[out, optional] RequiredSize
Um ponteiro para uma variável para receber o número de caracteres necessários para armazenar o nome amigável (incluindo um terminador NULL). Esse parâmetro é opcional e pode ser NULL.
[in, optional] MachineName
Um ponteiro para a cadeia de caracteres terminada por NULL que contém o nome de um computador remoto no qual reside a ID do perfil de hardware. Esse parâmetro é opcional e pode ser NULL. Se machinename for NULL, a ID do perfil de hardware estará no computador 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.
Observações
Nota
O cabeçalho setupapi.h define SetupDiGetHwProfileFriendlyNameEx 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 |