Función SetupDiGetHwProfileFriendlyNameExA (setupapi.h)

  • Artículo

La función SetupDiGetHwProfileFriendlyNameEx recupera el nombre descriptivo asociado a un identificador de perfil de hardware en un equipo local o remoto.

Sintaxis

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

Proporciona el identificador de perfil de hardware asociado al nombre descriptivo que se va a recuperar. Si este parámetro es 0, se recupera el nombre descriptivo del perfil de hardware actual.

[out] FriendlyName

Puntero a un búfer de caracteres para recibir el nombre descriptivo.

[in] FriendlyNameSize

Tamaño, en caracteres, del búfer FriendlyName .

[out, optional] RequiredSize

Puntero a una variable para recibir el número de caracteres necesarios para almacenar el nombre descriptivo (incluido un terminador NULL). Este parámetro es opcional y puede ser NULL.

[in, optional] MachineName

Puntero a una cadena terminada en NULL que contiene el nombre de un equipo remoto en el que reside el identificador de perfil de hardware. Este parámetro es opcional y puede ser NULL. Si MachineName es NULL, el identificador de perfil de hardware se encuentra en el equipo local.

Precaución

No se admite el uso de esta función para acceder a máquinas remotas a partir de Windows 8 y Windows Server 2012, ya que esta funcionalidad se ha quitado.

Reserved

Debe 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

Nota

El encabezado setupapi.h define SetupDiGetHwProfileFriendlyNameEx como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito Value
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

Consulte también

SetupDiGetHwProfileFriendlyName

SetupDiGetHwProfileListEx