Функция SetupDiGetClassRegistryPropertyA (setupapi.h)

Статья
11/20/2024

Функция SetupDiGetClassRegistryProperty извлекает свойство для указанного класса установки устройства из реестра.

Синтаксис

WINSETUPAPI BOOL SetupDiGetClassRegistryPropertyA(
  [in]            const GUID *ClassGuid,
  [in]            DWORD      Property,
  [out, optional] PDWORD     PropertyRegDataType,
  [out]           PBYTE      PropertyBuffer,
  [in]            DWORD      PropertyBufferSize,
  [out, optional] PDWORD     RequiredSize,
  [in, optional]  PCSTR      MachineName,
                  PVOID      Reserved
);

Параметры

[in] ClassGuid

Указатель на GUID, представляющий класс установки устройства, для которого требуется получить свойство.

[in] Property

Значение, определяющее извлекаемое свойство. Это должно быть одно из следующих значений:

SPCRP_CHARACTERISTICS

Функция возвращает флаги, указывающие характеристики устройства для класса. Список флагов характеристик см. в параметре DeviceCharacteristics для IoCreateDevice.

SPCRP_DEVTYPE

Функция возвращает значение DWORD, представляющее тип устройства для класса. Дополнительные сведения см. в разделе Указание типов устройств.

SPCRP_EXCLUSIVE

Функция возвращает значение DWORD, указывающее, могут ли пользователи получить эксклюзивный доступ к устройствам для этого класса. Возвращаемое значение равно одному, если разрешен монопольный доступ или ноль в противном случае.

SPCRP_LOWERFILTERS

(Windows Vista и более поздние версии) Функция возвращает REG_MULTI_SZ список имен служб более низких драйверов фильтров, установленных для класса установки устройства.

SPCRP_SECURITY

Функция возвращает дескриптор безопасности устройства в виде SECURITY_DESCRIPTOR структуры в автономном формате (описано в документации по пакету SDK для Microsoft Windows).

SPCRP_SECURITY_SDS

Функция возвращает дескриптор безопасности устройства в виде текстовой строки. Сведения о строках дескриптора безопасности см. вязыка дескриптора безопасности (Windows). Сведения о формате строк дескриптора безопасности см. в разделе "Язык определения дескриптора безопасности" (Windows).

SPCRP_UPPERFILTERS

(Windows Vista и более поздние версии) Функция возвращает REG_MULTI_SZ список имен служб верхних драйверов фильтров, установленных для класса установки устройства.

[out, optional] PropertyRegDataType

Указатель на переменную типа DWORD, которая получает тип данных свойства в качестве одного из типов данных реестра с префиксом REG_. Этот параметр является необязательным и может быть null. Если этот параметр NULL, SetupDiGetClassRegistryProperty не возвращает тип данных.

[out] PropertyBuffer

Указатель на буфер, получающий запрошенное свойство.

[in] PropertyBufferSize

Размер в байтах буфера PropertyBuffer .

[out, optional] RequiredSize

Указатель на переменную типа DWORD, которая получает требуемый размер в байтах буфера PropertyBuffer . Если буфер свойства PropertyBuffer слишком мал, а RequiredSize не NULL, то наборы функций RequiredSize минимальному размеру буфера, который требуется для получения запрошенного свойства.

[in, optional] MachineName

Указатель на строку, завершающую значение NULL, содержащую имя удаленной системы, из которой требуется получить указанное свойство класса устройства. Этот параметр является необязательным и может быть null. Если этот параметр значение NULL, свойство извлекается из локальной системы.

Осторожность

Эта функция для доступа к удаленным компьютерам не поддерживается начиная с Windows 8 и Windows Server 2012, так как эта функция была удалена.

Reserved

Зарезервировано, должно быть null.

Возвращаемое значение

Функция возвращает TRUE, если она выполнена успешно. В противном случае возвращается FALSE, а ошибка журнала может быть получена с помощью вызова GetLastError.

Замечания

Заметка

Заголовок setupapi.h определяет SetupDiGetClassRegistryProperty в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Доступно в Windows XP и более поздних версиях Windows.
целевая платформа	DesktopFor universal, вызов CM_Get_Class_Registry_Property
заголовка	setupapi.h (include Setupapi.h)
библиотеки	Setupapi.lib

См. также

SetupDiGetDeviceRegistryProperty

SetupDiSetClassRegistryProperty

SetupDiSetDeviceRegistryProperty

Поделиться через