Função SetupDiGetDeviceRegistryPropertyA (setupapi.h)

A função SetupDiGetDeviceRegistryProperty recupera uma propriedade de dispositivo Plug and Play especificada.

Sintaxe

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

Um identificador para um conjunto de informações do dispositivo que contém um elemento de informações do dispositivo que representa o dispositivo para o qual recuperar uma propriedade Plug and Play.

[in] DeviceInfoData

Um ponteiro para uma estrutura SP_DEVINFO_DATA que especifica o elemento de informações do dispositivo em DeviceInfoSet.

[in] Property

Um dos seguintes valores que especifica a propriedade a ser recuperada:

SPDRP_ADDRESS

A função recupera o endereço do dispositivo.

SPDRP_BUSNUMBER

A função recupera o número do barramento do dispositivo.

SPDRP_BUSTYPEGUID

A função recupera o GUID para o tipo de barramento do dispositivo.

SPDRP_CAPABILITIES

A função recupera um OR bit a bit dos seguintes sinalizadores CM_DEVCAP_Xxx em um DWORD. Os recursos do dispositivo representados por esses sinalizadores correspondem aos recursos do dispositivo representados pelos membros da estrutura DEVICE_CAPABILITIES . As constantes CM_DEVCAP_Xxx são definidas em Cfgmgr32.h.

sinalizador CM_DEVCAP_Xxx Membro da estrutura de DEVICE_CAPABILITIES correspondente
CM_DEVCAP_LOCKSUPPORTED LockSupported
CM_DEVCAP_EJECTSUPPORTED EjectSupported
CM_DEVCAP_REMOVABLE Removível
CM_DEVCAP_DOCKDEVICE DockDevice
CM_DEVCAP_UNIQUEID Uniqueid
CM_DEVCAP_SILENTINSTALL SilentInstall
CM_DEVCAP_RAWDEVICEOK RawDeviceOK
CM_DEVCAP_SURPRISEREMOVALOK SurpriseRemovalOK
CM_DEVCAP_HARDWAREDISABLED Hardware Desabilitado
CM_DEVCAP_NONDYNAMIC NãoDinâmico
 

SPDRP_CHARACTERISTICS

A função recupera um OR bit a bit dos sinalizadores de características de um dispositivo em um DWORD. Para obter uma descrição desses sinalizadores, que são definidos em Wdm.h e Ntddk.h, consulte o parâmetro DeviceCharacteristics da função IoCreateDevice .

SPDRP_CLASS

A função recupera um REG_SZ cadeia de caracteres que contém a classe de configuração do dispositivo de um dispositivo.

SPDRP_CLASSGUID

A função recupera um REG_SZ cadeia de caracteres que contém o GUID que representa a classe de configuração do dispositivo de um dispositivo.

SPDRP_COMPATIBLEIDS

A função recupera um REG_MULTI_SZ cadeia de caracteres que contém a lista de IDs compatíveis para um dispositivo. Para obter informações sobre IDs compatíveis, consulte Cadeias de caracteres de identificação do dispositivo.

SPDRP_CONFIGFLAGS

A função recupera um OR bit a bit dos sinalizadores de configuração de um dispositivo em um valor DWORD. Os sinalizadores de configuração são representados pelos bitmasks CONFIGFLAG_Xxx definidos em Regstr.h.

SPDRP_DEVICE_POWER_DATA

(Windows XP e posterior) A função recupera uma estrutura CM_POWER_DATA que contém as informações de gerenciamento de energia do dispositivo.

SPDRP_DEVICEDESC

A função recupera um REG_SZ cadeia de caracteres que contém a descrição de um dispositivo.

SPDRP_DEVTYPE

A função recupera um valor DWORD que representa o tipo do dispositivo. Para obter mais informações, consulte Especificando tipos de dispositivo.

SPDRP_DRIVER

A função recupera uma cadeia de caracteres que identifica a chave de software do dispositivo (às vezes chamada de chave de driver). Para obter mais informações sobre chaves de driver, consulte Árvores e Chaves do Registro para Dispositivos e Drivers.

SPDRP_ENUMERATOR_NAME

A função recupera um REG_SZ cadeia de caracteres que contém o nome do enumerador do dispositivo.

SPDRP_EXCLUSIVE

A função recupera um valor DWORD que indica se um usuário pode obter o uso exclusivo do dispositivo. O valor retornado será um se o uso exclusivo for permitido ou zero, caso contrário, zero. Para obter mais informações, consulte IoCreateDevice.

SPDRP_FRIENDLYNAME

A função recupera um REG_SZ cadeia de caracteres que contém o nome amigável de um dispositivo.

SPDRP_HARDWAREID

A função recupera um REG_MULTI_SZ cadeia de caracteres que contém a lista de IDs de hardware de um dispositivo. Para obter informações sobre IDs de hardware, consulte Cadeias de caracteres de identificação do dispositivo.

SPDRP_INSTALL_STATE

(Windows XP e posterior) A função recupera um valor DWORD que indica o estado de instalação de um dispositivo. O estado de instalação é representado por um dos valores CM_INSTALL_STATE_Xxx definidos em Cfgmgr32.h. Os valores CM_INSTALL_STATE_Xxx correspondem aos valores de enumeração DEVICE_INSTALL_STATE .

SPDRP_LEGACYBUSTYPE

A função recupera o tipo de barramento herdado do dispositivo como um valor INTERFACE_TYPE (definido em Wdm.h e Ntddk.h).

SPDRP_LOCATION_INFORMATION

A função recupera um REG_SZ cadeia de caracteres que contém o local de hardware de um dispositivo.

SPDRP_LOCATION_PATHS

(Windows Server 2003 e posterior) A função recupera um REG_MULTI_SZ cadeia de caracteres que representa o local do dispositivo na árvore de dispositivos.

SPDRP_LOWERFILTERS

A função recupera um REG_MULTI_SZ cadeia de caracteres que contém os nomes dos drivers de filtro inferior de um dispositivo.

SPDRP_MFG

A função recupera um REG_SZ cadeia de caracteres que contém o nome do fabricante do dispositivo.

SPDRP_PHYSICAL_DEVICE_OBJECT_NAME

A função recupera um REG_SZ cadeia de caracteres que contém o nome associado ao PDO do dispositivo. Para obter mais informações, consulte IoCreateDevice.

SPDRP_REMOVAL_POLICY

(Windows XP e posterior) A função recupera a política de remoção atual do dispositivo como um DWORD que contém um dos valores CM_REMOVAL_POLICY_Xxx definidos em Cfgmgr32.h.

SPDRP_REMOVAL_POLICY_HW_DEFAULT

(Windows XP e posterior) A função recupera a política de remoção padrão especificada por hardware do dispositivo como um DWORD que contém um dos valores CM_REMOVAL_POLICY_Xxx definidos em Cfgmgr32.h.

SPDRP_REMOVAL_POLICY_OVERRIDE

(Windows XP e posterior) A função recupera a política de remoção de substituição do dispositivo (se existir) do registro, como um DWORD que contém um dos valores CM_REMOVAL_POLICY_Xxx definidos em Cfgmgr32.h.

SPDRP_SECURITY

A função recupera uma estrutura de SECURITY_DESCRIPTOR para um dispositivo.

SPDRP_SECURITY_SDS

A função recupera uma cadeia de caracteres REG_SZ que contém o descritor de segurança do dispositivo. Para obter informações sobre cadeias de caracteres de descritor de segurança, consulte Linguagem de definição do descritor de segurança (Windows). Para obter informações sobre o formato das cadeias de caracteres do descritor de segurança, consulte Linguagem de definição do descritor de segurança (Windows).

SPDRP_SERVICE

A função recupera uma cadeia de caracteres REG_SZ que contém o nome do serviço de um dispositivo.

SPDRP_UI_NUMBER

A função recupera um valor DWORD definido como o valor do membro UINumber da estrutura DEVICE_CAPABILITIES do dispositivo.

SPDRP_UI_NUMBER_DESC_FORMAT

A função recupera uma cadeia de caracteres de formato (REG_SZ) usada para exibir o valor UINumber .

SPDRP_UPPERFILTERS

A função recupera uma cadeia de caracteres REG_MULTI_SZ que contém os nomes dos drivers de filtro superior de um dispositivo.

[out, optional] PropertyRegDataType

Um ponteiro para uma variável que recebe o tipo de dados da propriedade que está sendo recuperada. Esse é um dos tipos de dados padrão do Registro. Esse parâmetro é opcional e pode ser NULL.

[out, optional] PropertyBuffer

Um ponteiro para um buffer que recebe a propriedade que está sendo recuperada. Se esse parâmetro for definido como NULL e PropertyBufferSize também for definido como zero, a função retornará o tamanho necessário para o buffer em RequiredSize.

[in] PropertyBufferSize

O tamanho, em bytes, do buffer PropertyBuffer .

[out, optional] RequiredSize

Um ponteiro para uma variável do tipo DWORD que recebe o tamanho necessário, em bytes, do buffer PropertyBuffer necessário para armazenar os dados da propriedade solicitada. Esse parâmetro é opcional e pode ser NULL.

Valor retornado

SetupDiGetDeviceRegistryProperty retornará TRUE se a chamada tiver sido bem-sucedida. Caso contrário, ele retornará FALSE e o erro registrado poderá ser recuperado fazendo uma chamada para GetLastError. SetupDiGetDeviceRegistryProperty retornará o código de erro ERROR_INVALID_DATA se a propriedade solicitada não existir para um dispositivo ou se os dados da propriedade não forem válidos.

Comentários

Observação

O cabeçalho setupapi.h define SetupDiGetDeviceRegistryProperty como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

   
Cliente mínimo com suporte Disponível no Microsoft Windows 2000 e versões posteriores do Windows.
Plataforma de Destino DesktopPara universal, chame CM_Get_DevNode_Registry_Property
Cabeçalho setupapi.h (inclua Setupapi.h)
Biblioteca Setupapi.lib

Confira também

IoGetDeviceProperty

SetupDiGetClassRegistryProperty

SetupDiSetClassRegistryProperty

SetupDiSetDeviceRegistryProperty