CM_Get_Class_Registry_PropertyW function (cfgmgr32.h)

Article
02/09/2023

The CM_Get_Class_Registry_Property function retrieves a device setup class property.

Syntax

CMAPI CONFIGRET CM_Get_Class_Registry_PropertyW(
  [in]            LPGUID   ClassGuid,
  [in]            ULONG    ulProperty,
  [out, optional] PULONG   pulRegDataType,
  [out]           PVOID    Buffer,
  [in, out]       PULONG   pulLength,
  [in]            ULONG    ulFlags,
  [in, optional]  HMACHINE hMachine
);

Parameters

[in] ClassGuid

A pointer to the GUID that represents the device setup class for which to retrieve a property.

[in] ulProperty

A value of type ULONG that identifies the property to be retrieved. This value must be one of the following CM_CRP_Xxx values that are defined in Cfgmgr32.h:

CM_CRP_UPPERFILTERS

Represents a REG_MULTI_SZ-type list of strings, where each string contains the name of an upper-level filter driver that is registered for the class.

CM_CRP_LOWERFILTERS

Represents a REG_MULTI_SZ-typed list of strings, where each string contains the name of a lower-level filter drivers that is registered for the class.

CM_CRP_SECURITY

Represents a value of type REG_BINARY that contains a variable-length, self-relative, SECURITY_DESCRIPTOR structure.

CM_CRP_SECURITY_SDS

Represents a string of type REG_SZ that contains a security descriptor in the Security Descriptor Definition Language (SDDL) format.

CM_CRP_DEVTYPE

Represents a value of type REG_DWORD that indicates the device type for the class. For more information, see Specifying Device Types.

CM_CRP_EXCLUSIVE

Represents a value of type REG_DWORD that indicates whether users can obtain exclusive access to devices for this class. The returned value is 1 if exclusive access is allowed, or zero otherwise.

CM_CRP_CHARACTERISTICS

Represents a value of type DWORD that indicates the device characteristics for the class. For a list of characteristics flags, see the DeviceCharacteristics parameter of the IoCreateDevice routine.

[out, optional] pulRegDataType

A pointer to a variable of type ULONG that receives the REG_Xxx constant that represents the data type of the requested property. The REG_Xxx constants are defined in Winnt.h and are described in the Type member of the KEY_VALUE_BASIC_INFORMATION structure. This parameter is optional and can be set to NULL.

[out] Buffer

A pointer to a buffer that receives the requested property data. For more information about this parameter and the buffer-size parameter pulLength, see the following Remarks section.

[in, out] pulLength

A pointer to variable of type ULONG whose value, on input, is the size, in bytes, of the buffer that is supplied by Buffer. On return, CM_Get_Class_Registry_Property sets this variable to the size, in bytes, of the requested property.

[in] ulFlags

Reserved for internal use only. Must be set to zero.

[in, optional] hMachine

A handle to a remote machine from which to retrieve the specified device class property. This parameter is optional, and, if it is set to NULL, the property is retrieved from the local machine.

Return value

If the operation succeeds, CM_Get_Class_Registry_Property returns CR_SUCCESS. Otherwise, the function returns one of the other CR_Xxx status codes that are defined in Cfgmgr32.h.

Remarks

To determine the size, in bytes, of a property before attempting to retrieve the property, first call CM_Get_Class_Registry_Property, supplying a NULLBuffer pointer and a pulLength value of zero. In response to such a call, the function does not retrieve the property, but sets pulLength to the size of the requested property and returns CR_BUFFER_SMALL. After obtaining the property size, call CM_Get_Class_Registry_Property again, supplying a Buffer pointer to the buffer to receive the property data and supplying the property size in *pulLength.

Requirements

Requirement	Value
Minimum supported client	Available in Microsoft Windows 2000 and later versions of Windows.
Target Platform	Universal
Header	cfgmgr32.h (include Cfgmgr32.h)
Library	Cfgmgr32.lib