CIM_ControlledBy class (CIMWin32 WMI Providers)

Article
01/06/2021

The CIM_ControlledBy relationship indicates which devices are commanded by, or accessed through, the controller logical device.

Important

The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

[Abstract, UUID("{8502C53D-5FBB-11D2-AAC1-006008C78BC7}"), AMENDMENT]
class CIM_ControlledBy : CIM_DeviceConnection
{
  uint32                NegotiatedDataWidth;
  uint64                NegotiatedSpeed;
  CIM_LogicalDevice REF Dependent;
  CIM_Controller    REF Antecedent;
  uint16                AccessState;
  uint32                NumberOfHardResets;
  uint32                NumberOfSoftResets;
};

Members

The CIM_ControlledBy class has these types of members:

Properties

Properties

The CIM_ControlledBy class has these properties.

AccessState

Data type: uint16
Access type: Read-only

Indicates whether the controller is actively commanding or accessing the device. This information is necessary when a logical device can be commanded by, or accessed through, multiple controllers.

Unknown (0)

Active (1)

Inactive (2)

Antecedent

Data type: CIM_Controller
Access type: Read-only
Qualifiers: Override ("Antecedent")

A CIM_Controller that represents the controller.

Dependent

Data type: CIM_LogicalDevice
Access type: Read-only
Qualifiers: Override ("Dependent")

A CIM_LogicalDevice that represents the controlled device.

NegotiatedDataWidth

Data type: uint32
Access type: Read-only
Qualifiers: Units ("bits")

When several bus or connection-data widths are possible, this property defines the one in use between the devices. Data width is specified in bits. If data width is not negotiated, or if this information is not available or important to device management, the property should be set to 0 (zero).

This property is inherited from CIM_DeviceConnection.

NegotiatedSpeed

Data type: uint64
Access type: Read-only
Qualifiers: Units ("bits per second")

When several bus or connection speeds are possible, this property defines the one being used between the devices. Speed is specified in bits-per-second. If connection or bus speeds are not negotiated, or if this information is not available or important to device management, the property should be set to 0 (zero).

For more information about using uint64 values in scripts, see Scripting in WMI.

This property is inherited from CIM_DeviceConnection.

NumberOfHardResets

Data type: uint32
Access type: Read-only

Number of hard resets issued by the controller. A hard reset returns the device to its initialization or boot-up state. All internal device state information and data are lost.

NumberOfSoftResets

Data type: uint32
Access type: Read-only

Number of soft resets issued by the controller. A soft reset does not completely clear current device state and data. Exact semantics are dependent on the device and on the protocols and mechanisms used to communicate to it.

Remarks

The CIM_ControlledBy class is derived from CIM_DeviceConnection.

WMI does not implement this class. For more information about classes derived from CIM_ControlledBy, see Win32 Classes.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Namespace	Root\CIMV2
MOF	CIMWin32.mof
DLL	CIMWin32.dll