Função SetupDiGetHwProfileFriendlyNameA (setupapi.h)

A função SetupDiGetHwProfileFriendlyName recupera o nome amigável associado a uma ID de perfil de hardware.

Sintaxe

WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameA(
  [in]            DWORD  HwProfile,
  [out]           PSTR   FriendlyName,
  [in]            DWORD  FriendlyNameSize,
  [out, optional] PDWORD RequiredSize
);

Parâmetros

[in] HwProfile

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 cadeia 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 do tipo DWORD que recebe o número de caracteres necessários para recuperar o nome amigável (incluindo um terminador 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

Chame SetupDiGetHwProfileFriendlyNameEx para obter o nome amigável de uma ID de perfil de hardware em um computador remoto.

Nota

O cabeçalho setupapi.h define SetupDiGetHwProfileFriendlyName 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

SetupDiGetHwProfileList