Función SetupDiGetDeviceRegistryPropertyA (setupapi.h)
La función SetupDiGetDeviceRegistryProperty recupera una propiedad de dispositivo Plug and Play especificada.
Sintaxis
WINSETUPAPI BOOL SetupDiGetDeviceRegistryPropertyA(
[in] HDEVINFO DeviceInfoSet,
[in] PSP_DEVINFO_DATA DeviceInfoData,
[in] DWORD Property,
[out, optional] PDWORD PropertyRegDataType,
[out, optional] PBYTE PropertyBuffer,
[in] DWORD PropertyBufferSize,
[out, optional] PDWORD RequiredSize
);
Parámetros
[in] DeviceInfoSet
Identificador de un conjunto de información de dispositivo que contiene un elemento de información del dispositivo que representa el dispositivo para el que se va a recuperar una propiedad Plug and Play.
[in] DeviceInfoData
Puntero a una estructura de SP_DEVINFO_DATA que especifica el elemento de información del dispositivo en DeviceInfoSet.
[in] Property
Uno de los siguientes valores que especifica la propiedad que se va a recuperar:
SPDRP_ADDRESS
La función recupera la dirección del dispositivo.
SPDRP_BUSNUMBER
La función recupera el número de bus del dispositivo.
SPDRP_BUSTYPEGUID
La función recupera el GUID del tipo de bus del dispositivo.
SPDRP_CAPABILITIES
La función recupera un OR bit a bit de las marcas CM_DEVCAP_Xxx siguientes en un DWORD. Las funcionalidades del dispositivo representadas por estas marcas corresponden a las funcionalidades del dispositivo representadas por los miembros de la estructura de DEVICE_CAPABILITIES . Las constantes CM_DEVCAP_Xxx se definen en Cfgmgr32.h.
| marca de CM_DEVCAP_Xxx | Miembro de estructura de DEVICE_CAPABILITIES correspondiente |
|---|---|
| CM_DEVCAP_LOCKSUPPORTED | LockSupported |
| CM_DEVCAP_EJECTSUPPORTED | EjectSupported |
| CM_DEVCAP_REMOVABLE | Extraíble |
| CM_DEVCAP_DOCKDEVICE | DockDevice |
| CM_DEVCAP_UNIQUEID | Uniqueid |
| CM_DEVCAP_SILENTINSTALL | SilentInstall |
| CM_DEVCAP_RAWDEVICEOK | RawDeviceOK |
| CM_DEVCAP_SURPRISEREMOVALOK | SurpriseRemovalOK |
| CM_DEVCAP_HARDWAREDISABLED | HardwareDisabled |
| CM_DEVCAP_NONDYNAMIC | NonDynamic |
SPDRP_CHARACTERISTICS
La función recupera un OR bit a bit de las marcas de características de un dispositivo en un DWORD. Para obtener una descripción de estas marcas, que se definen en Wdm.h y Ntddk.h, consulte el parámetro DeviceCharacteristics de la función IoCreateDevice .
SPDRP_CLASS
La función recupera una cadena de REG_SZ que contiene la clase de configuración del dispositivo de un dispositivo.
SPDRP_CLASSGUID
La función recupera una cadena de REG_SZ que contiene el GUID que representa la clase de configuración del dispositivo de un dispositivo.
SPDRP_COMPATIBLEIDS
La función recupera una cadena REG_MULTI_SZ que contiene la lista de identificadores compatibles para un dispositivo. Para obtener información sobre los identificadores compatibles, consulte Cadenas de identificación de dispositivos.
SPDRP_CONFIGFLAGS
La función recupera un OR bit a bit de las marcas de configuración de un dispositivo en un valor DWORD. Las marcas de configuración se representan mediante las máscaras de bits CONFIGFLAG_Xxx definidas en Regstr.h.
SPDRP_DEVICE_POWER_DATA
(Windows XP y versiones posteriores) La función recupera una estructura CM_POWER_DATA que contiene la información de administración de energía del dispositivo.
SPDRP_DEVICEDESC
La función recupera una cadena REG_SZ que contiene la descripción de un dispositivo.
SPDRP_DEVTYPE
La función recupera un valor DWORD que representa el tipo del dispositivo. Para obtener más información, vea Especificar tipos de dispositivo.
SPDRP_DRIVER
La función recupera una cadena que identifica la clave de software del dispositivo (a veces denominada clave de controlador). Para obtener más información sobre las claves de controlador, vea Árboles y claves del Registro para dispositivos y controladores.
SPDRP_ENUMERATOR_NAME
La función recupera una cadena de REG_SZ que contiene el nombre del enumerador del dispositivo.
SPDRP_EXCLUSIVE
La función recupera un valor DWORD que indica si un usuario puede obtener un uso exclusivo del dispositivo. El valor devuelto es uno si se permite el uso exclusivo o cero de lo contrario. Para más información, consulte IoCreateDevice.
SPDRP_FRIENDLYNAME
La función recupera una cadena REG_SZ que contiene el nombre descriptivo de un dispositivo.
SPDRP_HARDWAREID
La función recupera una cadena REG_MULTI_SZ que contiene la lista de identificadores de hardware de un dispositivo. Para obtener información sobre los identificadores de hardware, consulte Cadenas de identificación de dispositivos.
SPDRP_INSTALL_STATE
(Windows XP y versiones posteriores) La función recupera un valor DWORD que indica el estado de instalación de un dispositivo. El estado de instalación se representa mediante uno de los valores CM_INSTALL_STATE_Xxx definidos en Cfgmgr32.h. Los valores CM_INSTALL_STATE_Xxx corresponden a los valores de enumeración DEVICE_INSTALL_STATE .
SPDRP_LEGACYBUSTYPE
La función recupera el tipo de bus heredado del dispositivo como un valor de INTERFACE_TYPE (definido en Wdm.h y Ntddk.h).
SPDRP_LOCATION_INFORMATION
La función recupera una cadena de REG_SZ que contiene la ubicación de hardware de un dispositivo.
SPDRP_LOCATION_PATHS
(Windows Server 2003 y versiones posteriores) La función recupera una cadena REG_MULTI_SZ que representa la ubicación del dispositivo en el árbol de dispositivos.
SPDRP_LOWERFILTERS
La función recupera una cadena de REG_MULTI_SZ que contiene los nombres de los controladores de filtro inferior de un dispositivo.
SPDRP_MFG
La función recupera una cadena de REG_SZ que contiene el nombre del fabricante del dispositivo.
SPDRP_PHYSICAL_DEVICE_OBJECT_NAME
La función recupera una cadena de REG_SZ que contiene el nombre asociado al PDO del dispositivo. Para más información, consulte IoCreateDevice.
SPDRP_REMOVAL_POLICY
(Windows XP y versiones posteriores) La función recupera la directiva de eliminación actual del dispositivo como DWORD que contiene uno de los valores CM_REMOVAL_POLICY_Xxx definidos en Cfgmgr32.h.
SPDRP_REMOVAL_POLICY_HW_DEFAULT
(Windows XP y versiones posteriores) La función recupera la directiva de eliminación predeterminada especificada por hardware del dispositivo como DWORD que contiene uno de los valores CM_REMOVAL_POLICY_Xxx definidos en Cfgmgr32.h.
SPDRP_REMOVAL_POLICY_OVERRIDE
(Windows XP y versiones posteriores) La función recupera la directiva de eliminación de invalidación del dispositivo (si existe) del Registro, como DWORD que contiene uno de los valores CM_REMOVAL_POLICY_Xxx definidos en Cfgmgr32.h.
SPDRP_SECURITY
La función recupera una estructura de SECURITY_DESCRIPTOR para un dispositivo.
SPDRP_SECURITY_SDS
La función recupera una cadena de REG_SZ que contiene el descriptor de seguridad del dispositivo. Para obtener información sobre las cadenas de descriptores de seguridad, vea Security Descriptor Definition Language (Windows) (Lenguaje de definición de descriptores de seguridad [Windows]). Para obtener información sobre el formato de las cadenas de descriptor de seguridad, vea Lenguaje de definición de descriptor de seguridad (Windows).
SPDRP_SERVICE
La función recupera una cadena de REG_SZ que contiene el nombre de servicio de un dispositivo.
SPDRP_UI_NUMBER
La función recupera un valor DWORD establecido en el valor del miembro UINumber de la estructura DEVICE_CAPABILITIES del dispositivo.
SPDRP_UI_NUMBER_DESC_FORMAT
La función recupera una cadena de formato (REG_SZ) usada para mostrar el valor UINumber .
SPDRP_UPPERFILTERS
La función recupera una cadena de REG_MULTI_SZ que contiene los nombres de los controladores de filtro superior de un dispositivo.
[out, optional] PropertyRegDataType
Puntero a una variable que recibe el tipo de datos de la propiedad que se está recuperando. Se trata de uno de los tipos de datos del Registro estándar. Este parámetro es opcional y puede ser NULL.
[out, optional] PropertyBuffer
Puntero a un búfer que recibe la propiedad que se está recuperando. Si este parámetro se establece en NULL y PropertyBufferSize también se establece en cero, la función devuelve el tamaño necesario para el búfer en RequiredSize.
[in] PropertyBufferSize
Tamaño, en bytes, del búfer PropertyBuffer .
[out, optional] RequiredSize
Puntero a una variable de tipo DWORD que recibe el tamaño necesario, en bytes, del búfer PropertyBuffer necesario para contener los datos de la propiedad solicitada. Este parámetro es opcional y puede ser NULL.
Valor devuelto
SetupDiGetDeviceRegistryProperty devuelve TRUE si la llamada se realizó correctamente. De lo contrario, devuelve FALSE y el error registrado se puede recuperar mediante una llamada a GetLastError. SetupDiGetDeviceRegistryProperty devuelve el código de error ERROR_INVALID_DATA si la propiedad solicitada no existe para un dispositivo o si los datos de propiedad no son válidos.
Comentarios
Nota:
El encabezado setupapi.h define SetupDiGetDeviceRegistryProperty 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
| Cliente mínimo compatible | Disponible en Microsoft Windows 2000 y versiones posteriores de Windows. |
| Plataforma de destino | DesktopFor universal, call CM_Get_DevNode_Registry_Property |
| Encabezado | setupapi.h (incluya Setupapi.h) |
| Library | Setupapi.lib |
Consulte también
SetupDiGetClassRegistryProperty