Función SetupDiGetClassPropertyExW (setupapi.h)

Artículo
03/15/2023

La función SetupDiGetClassPropertyEx recupera una propiedad de clase para una clase de instalación de dispositivo o una clase de interfaz de dispositivo en un equipo local o remoto.

Sintaxis

WINSETUPAPI BOOL SetupDiGetClassPropertyExW(
  [in]            const GUID       *ClassGuid,
  [in]            const DEVPROPKEY *PropertyKey,
  [out]           DEVPROPTYPE      *PropertyType,
  [out, optional] PBYTE            PropertyBuffer,
  [in]            DWORD            PropertyBufferSize,
  [out, optional] PDWORD           RequiredSize,
  [in]            DWORD            Flags,
  [in, optional]  PCWSTR           MachineName,
                  PVOID            Reserved
);

Parámetros

[in] ClassGuid

Puntero a un GUID que identifica la clase de configuración del dispositivo o la clase de interfaz de dispositivo para la que se va a recuperar una propiedad de dispositivo para la clase de dispositivo. Para obtener información sobre cómo especificar el tipo de clase, vea el parámetro Flags .

[in] PropertyKey

Puntero a una estructura DEVPROPKEY que representa la clave de propiedad del dispositivo de la propiedad de clase de dispositivo solicitada.

[out] PropertyType

Puntero a una variable con tipo DEVPROPTYPE que recibe el identificador property-data-type de la propiedad de clase de dispositivo solicitada, donde el identificador property-data-type es el OR bit a bit entre un identificador de tipo de datos base y, si se modifica el tipo de datos base, un modificador property-data-type.

[out, optional] PropertyBuffer

Puntero a un búfer que recibe la propiedad de clase de dispositivo solicitada. SetupDiGetClassPropertyEx recupera el valor de propiedad solicitado solo si el búfer es lo suficientemente grande como para contener todos los datos de valor de propiedad. El puntero puede ser NULL. Si el puntero se establece en NULL y se proporciona RequiredSize , SetupDiGetClassPropertyEx devuelve el tamaño de la propiedad de clase de dispositivo, en bytes, en *RequiredSize.

[in] PropertyBufferSize

Tamaño, en bytes, del búfer PropertyBuffer . Si PropertyBuffer está establecido en NULL, PropertyBufferSize debe establecerse en cero.

[out, optional] RequiredSize

Puntero a una variable con tipo DWORD que recibe el tamaño, en bytes, de la propiedad de clase de dispositivo si la propiedad se recupera o el tamaño de búfer necesario si el búfer no es lo suficientemente grande. Este puntero se puede establecer en NULL.

[in] Flags

Uno de los siguientes valores, que especifica si la clase es una clase de configuración de dispositivo o una clase de interfaz de dispositivo:

DICLASSPROP_INSTALLER

ClassGuid especifica una clase de configuración de dispositivo. Esta marca no se puede usar con DICLASSPROP_INTERFACE.

DICLASSPROP_INTERFACE

ClassGuid especifica una clase de interfaz de dispositivo. Esta marca no se puede usar con DICLASSPROP_INSTALLER.

[in, optional] MachineName

Puntero a una cadena terminada en NULL que contiene el nombre UNC, incluido el prefijo "\", de un equipo. El puntero se puede establecer en NULL. Si MachineName es NULL, SetupDiGetClassPropertyEx recupera la propiedad de clase de dispositivo solicitada del 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

Este parámetro debe establecerse en NULL.

Valor devuelto

SetupDiGetClassPropertyEx devuelve TRUE si se realiza correctamente. De lo contrario, devuelve FALSE y el error registrado se puede recuperar llamando a GetLastError.

En la tabla siguiente se incluyen algunos de los códigos de error más comunes que esta función podría registrar.

Código devuelto	Descripción
ERROR_INVALID_FLAGS	El valor de Flags no es cero.
ERROR_INVALID_CLASS	La clase de instalación del dispositivo especificada por ClassGuid no es válida. Este error solo puede producirse si se especifica la marca DICLASSPROP_INSTALLER.
ERROR_INVALID_PARAMETER	Un parámetro no especificado no es válido.
ERROR_INVALID_REG_PROPERTY	La clave de propiedad proporcionada por PropertyKey no es válida.
ERROR_INVALID_REFERENCE_STRING	La cadena de referencia de la interfaz de dispositivo no es válida. Este error se puede devolver si se especifica la marca DICLASSPROP_INTERFACE.
ERROR_INVALID_DATA	Un valor de datos interno no especificado no era válido.
ERROR_INVALID_USER_BUFFER	Un búfer de usuario no es válido. Una posibilidad es que PropertyBuffer sea NULL y PropertyBufferSize no sea cero.
ERROR_INVALID_MACHINENAME	El nombre de equipo especificado por MachineName no es válido.
ERROR_NO_SUCH_INTERFACE_CLASS	La clase de interfaz de dispositivo especificada por ClassGuid no existe. Este error solo puede producirse si se especifica la marca DICLASSPROP_INTERFACE.
ERROR_INSUFFICIENT_BUFFER	Un búfer de datos interno que se pasó a una llamada del sistema era demasiado pequeño.
ERROR_NOT_ENOUGH_MEMORY	No había suficiente memoria del sistema disponible para completar la operación.
ERROR_NOT_FOUND	La propiedad del dispositivo solicitada no existe.
ERROR_ACCESS_DENIED	El autor de la llamada no tiene privilegios de administrador.

Comentarios

SetupDiGetClassPropertyEx forma parte del modelo de propiedades de dispositivo unificado.

SetupAPI solo admite una versión Unicode de SetupDiGetClassPropertyEx.

Un autor de llamada de SetupDiGetClassPropertyEx debe ser miembro del grupo Administradores para establecer una propiedad de interfaz de dispositivo.

Para obtener las claves de propiedad del dispositivo que representan las propiedades del dispositivo que se establecen para una clase de dispositivo en un equipo remoto, llame a SetupDiGetClassPropertyKeysEx.

Para recuperar una propiedad de clase de dispositivo en un equipo local, llame a SetupDiGetClassProperty.

Para establecer una propiedad de clase de dispositivo en un equipo local, llame a SetupDiSetClassPropertyy para establecer una propiedad de clase de dispositivo en un equipo remoto, llame a SetupDiSetClassPropertyEx.

Requisitos

Requisito	Value
Cliente mínimo compatible	Disponible en Windows Vista y versiones posteriores de Windows.
Plataforma de destino	DesktopFor universal, call CM_Get_Class_Property_ExW
Encabezado	setupapi.h (incluya Setupapi.h)
Library	Setupapi.lib