Función SetupDiGetHwProfileListExA (setupapi.h)

La función SetupDiGetHwProfileListEx recupera una lista de todos los identificadores de perfil de hardware definidos actualmente en un equipo local o remoto.

Sintaxis

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

Puntero a una matriz para recibir la lista de identificadores de perfil de hardware definidos actualmente.

[in] HwProfileListSize

Número de DWORD en el búfer HwProfileList .

[out] RequiredSize

Puntero a una variable de tipo DWORD que recibe el número de perfiles de hardware definidos actualmente. Si el número es mayor que HwProfileListSize, la lista se trunca para ajustarse al tamaño de la matriz. El valor devuelto en RequiredSize indica el tamaño de matriz necesario para almacenar toda la lista de perfiles de hardware.

[out, optional] CurrentlyActiveIndex

Puntero a una variable que recibe el índice del perfil de hardware activo actualmente en la lista de perfiles de hardware recuperado. 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 sistema remoto para el que se va a recuperar la lista de identificadores de perfil de hardware. Este parámetro es opcional y puede ser NULL. Si este parámetro es NULL, la lista se recupera para el sistema 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. Si el tamaño necesario es mayor que HwProfileListSize, SetupDiGetHwProfileListEx devuelve FALSE y una llamada a GetLastError devuelve ERROR_INSUFFICIENT_BUFFER.

Comentarios

Nota

El encabezado setupapi.h define SetupDiGetHwProfileListEx 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

SetupDiGetHwProfileFriendlyNameEx