Export (0) Print
Expand All
Expand Minimize

SetupDiSetClassPropertyEx function

The SetupDiSetClassPropertyEx function sets a device property for a device setup class or a device interface class on a local or remote computer.

Syntax


BOOL SetupDiSetClassPropertyEx(
  _In_        const GUID *ClassGuid,
  _In_        const DEVPROPKEY *PropertyKey,
  _In_        DEVPROPTYPE PropertyType,
  _In_opt_    const PBYTE PropertyBuffer,
  _In_        DWORD PropertyBufferSize,
  _In_        DWORD Flags,
  _In_opt_    PCTSTR MachineName,
  _Reserved_  PVOID Reserved
);

Parameters

ClassGuid [in]

A pointer to a GUID that identifies the device setup class or device interface class for which to set a device property. For information about how to specify the class type, see the Flags parameter.

PropertyKey [in]

A pointer to a DEVPROPKEY structure that represents the device property key of the device class property to set.

PropertyType [in]

A DEVPROPTYPE-typed value that represents the property-data-type identifier for the class property. For more information about the property-data-type identifier, see the Remarks section later in this topic.

PropertyBuffer [in, optional]

A pointer to a buffer that contains the class property value. If either the property or the property value is being deleted, this pointer must be set to NULL, and PropertyBufferSize must be set to zero. For more information about property value requirements, see the Remarks section later in this topic.

PropertyBufferSize [in]

The size, in bytes, of the PropertyBuffer buffer. The property buffer size must be consistent with the property-data-type identifier that is supplied by PropertyType. If PropertyBuffer is set to NULL, PropertyBufferSize must be set to zero.

Flags [in]

One of the following values, which specifies whether the class is a device setup class or a device interface class:

DICLASSPROP_INSTALLER

ClassGuid specifies a device setup class. This flag cannot be used with DICLASSPROP_INTERFACE.

DICLASSPROP_INTERFACE

ClassGuid specifies a device interface class. This flag cannot be used with DICLASSPROP_INSTALLER.

MachineName [in, optional]

A pointer to a NULL-terminated Unicode string that contains the UNC name, including the "\\" prefix, of a computer. This pointer can be set to NULL. If the pointer is NULL, SetupDiSetClassPropertyEx sets the class property for a class that is installed on the local computer.

Reserved

This parameter must be set to NULL.

Return value

SetupDiSetClassPropertyEx returns TRUE if it is successful. Otherwise, it returns FALSE, and the logged error can be retrieved by calling GetLastError.

The following table includes some of the more common error codes that this function might log.

Return codeDescription
ERROR_INVALID_FLAGS

The value of Flags is invalid.

ERROR_INVALID_CLASS

The device setup class that is specified by ClassGuid is not valid. This error can occur only if the DICLASSPROP_INSTALLER flag is specified.

ERROR_INVALID_REFERENCE_STRING

The device interface reference string is not valid. This error can occur only if the DICLASSPROP_INTERFACE flag is specified.

ERROR_INVALID_REG_PROPERTY

The property key that is supplied by PropertyKey is not valid.

ERROR_INVALID_DATA

An unspecified internal data value was not valid. This error could be logged if either the ClassGuid value is not a valid GUID or the property value does not match the property type specified by PropertyType.

ERROR_INVALID_USER_BUFFER

A user buffer is not valid. One possibility is that PropertyBuffer is NULL, and PropertyBufferSize is not zero.

ERROR_INVALID_MACHINENAME

The computer name that is specified by MachineName is not valid.

ERROR_NO_SUCH_INTERFACE_CLASS

The device interface class that is specified by ClassGuid does not exist. This error can occur only if the DICLASSPROP_INTERFACE flag is specified.

ERROR_INSUFFICIENT_BUFFER

An internal data buffer that was passed to a system call was too small.

ERROR_NOT_ENOUGH_MEMORY

There was not enough system memory available to complete the operation.

ERROR_NOT_FOUND

An unspecified item was not found. One possibility is that the property to be deleted does not exist.

ERROR_ACCESS_DENIED

The caller does not have Administrator privileges.

 

Remarks

SetupDiSetClassPropertyEx is part of the unified device property model.

SetupAPI supports only a Unicode version of SetupDiSetClassPropertyEx.

A caller of SetupDiSetClassPropertyEx must be a member of the Administrators group to set a device interface property.

SetupDiSetClassPropertyEx enforces requirements on the property-data-type identifier and the property value.

To obtain the device property keys that represent the device properties that are set for a device class on a remote computer, call SetupDiGetClassPropertyKeysEx.

To retrieve a device class property on a local computer, call SetupDiGetClassProperty, and to retrieve a device class property on a remote computer, call SetupDiGetClassPropertyEx.

To set a device class property on a local computer, call SetupDiSetClassProperty.

Requirements

Version

Available in Windows Vista and later versions of Windows.

Header

Setupapi.h (include Setupapi.h)

Library

Setupapi.lib

See also

SetupDiGetClassProperty
SetupDiGetClassPropertyEx
SetupDiGetClassPropertyKeysEx
SetupDiSetClassProperty

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft