Win32_USBHub class

Article
05/31/2018

The Win32_USBHub WMI class represents the management characteristics of a universal serial bus (USB) hub.

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

Syntax

[Dynamic, Provider("CIMWin32a"), UUID("{52E56374-B17E-41DC-00EC-FC3E6E8D8783}"), AMENDMENT]
class Win32_USBHub : CIM_USBHub
{
  uint16   Availability;
  string   Caption;
  uint8    ClassCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  uint8    CurrentAlternateSettings[];
  uint8    CurrentConfigValue;
  string   Description;
  boolean  ErrorCleared;
  string   ErrorDescription;
  boolean  GangSwitched;
  datetime InstallDate;
  uint32   LastErrorCode;
  uint8    NumberOfConfigs;
  uint8    NumberOfPorts;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  uint8    ProtocolCode;
  string   Status;
  uint16   StatusInfo;
  uint8    SubclassCode;
  string   SystemCreationClassName;
  string   SystemName;
  uint16   USBVersion;
  uint32   ConfigManagerErrorCode;
  string   DeviceID;
  string   Name;
};

Members

The Win32_USBHub class has these types of members:

Methods
Properties

Methods

The Win32_USBHub class has these methods.

Method	Description
GetDescriptor	Returns the USB device descriptor. Not implemented by WMI. This method is inherited from CIM_USBHub.
Reset	Requests a reset of the logical device. Not implemented by WMI. This method is inherited from CIM_USBHub.
SetPowerState	Defines the desired power state for a logical device and when a device should be put into that state. Not implemented by WMI. This method is inherited from CIM_USBHub.

Properties

The Win32_USBHub class has these properties.

Availability

Data type: uint16
Access type: Read-only

Availability and status of the device.

This property is inherited from CIM_USBHub.

1 (0x1)

Other

2 (0x2)

Unknown

3 (0x3)

Running or Full Power

4 (0x4)

Warning

5 (0x5)

In Test

6 (0x6)

Not Applicable

7 (0x7)

Power Off

8 (0x8)

Off Line

9 (0x9)

Off Duty

10 (0xA)

Degraded

11 (0xB)

Not Installed

12 (0xC)

Install Error

13 (0xD)

Power Save - Unknown

The device is known to be in a power save mode, but its exact status is unknown.

14 (0xE)

Power Save - Low Power Mode

The device is in a power save state but still functioning, and may exhibit degraded performance.

15 (0xF)

Power Save - Standby

The device is not functioning, but could be brought to full power quickly.

16 (0x10)

Power Cycle

17 (0x11)

Power Save - Warning

The device is in a warning state, though also in a power save mode.

Caption

Data type: string
Access type: Read-only

Short textual description of the object. This property is inherited from CIM_ManagedSystemElement.

ClassCode

Data type: uint8
Access type: Read-only

USB class code. This property is inherited from CIM_USBDevice.

ConfigManagerErrorCode

Data type: uint32
Access type: Read-only
Qualifiers: Schema ("Win32")

Win32 Configuration Manager error code.

This property is inherited from CIM_LogicalDevice

This device is working properly. (0)

Device is working properly.

This device is not configured correctly. (1)

Device is not configured correctly.

Windows cannot load the driver for this device. (2)

The driver for this device might be corrupted, or your system may be running low on memory or other resources. (3)

Driver for this device might be corrupted, or the system may be low on memory or other resources.

This device is not working properly. One of its drivers or your registry might be corrupted. (4)

Device is not working properly. One of its drivers or the registry might be corrupted.

The driver for this device needs a resource that Windows cannot manage. (5)

Driver for the device requires a resource that Windows cannot manage.

The boot configuration for this device conflicts with other devices. (6)

Boot configuration for the device conflicts with other devices.

Cannot filter. (7)

The driver loader for the device is missing. (8)

Driver loader for the device is missing.

This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly. (9)

Device is not working properly. The controlling firmware is incorrectly reporting the resources for the device.

This device cannot start. (10)

Device cannot start.

This device failed. (11)

Device failed.

This device cannot find enough free resources that it can use. (12)

Device cannot find enough free resources to use.

Windows cannot verify this device's resources. (13)

Windows cannot verify the device's resources.

This device cannot work properly until you restart your computer. (14)

Device cannot work properly until the computer is restarted.

This device is not working properly because there is probably a re-enumeration problem. (15)

Device is not working properly due to a possible re-enumeration problem.

Windows cannot identify all the resources this device uses. (16)

Windows cannot identify all of the resources that the device uses.

This device is asking for an unknown resource type. (17)

Device is requesting an unknown resource type.

Reinstall the drivers for this device. (18)

Device drivers must be reinstalled.

Failure using the VxD loader. (19)

Your registry might be corrupted. (20)

Registry might be corrupted.

System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device. (21)

System failure. If changing the device driver is ineffective, see the hardware documentation. Windows is removing the device.

This device is disabled. (22)

Device is disabled.

System failure: Try changing the driver for this device. If that doesn't work, see your hardware documentation. (23)

System failure. If changing the device driver is ineffective, see the hardware documentation.

This device is not present, is not working properly, or does not have all its drivers installed. (24)

Device is not present, not working properly, or does not have all of its drivers installed.

Windows is still setting up this device. (25)

Windows is still setting up the device.

Windows is still setting up this device. (26)

Windows is still setting up the device.

This device does not have valid log configuration. (27)

Device does not have valid log configuration.

The drivers for this device are not installed. (28)

Device drivers are not installed.

This device is disabled because the firmware of the device did not give it the required resources. (29)

Device is disabled. The device firmware did not provide the required resources.

This device is using an Interrupt Request (IRQ) resource that another device is using. (30)

Device is using an IRQ resource that another device is using.

This device is not working properly because Windows cannot load the drivers required for this device. (31)

Device is not working properly. Windows cannot load the required device drivers.

ConfigManagerUserConfig

Data type: boolean
Access type: Read-only

If TRUE, the device is using a user-defined configuration. This property is inherited from CIM_LogicalDevice.

CreationClassName

Data type: string
Access type: Read-only

Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice.

CurrentAlternateSettings

Data type: uint8 array
Access type: Read-only

USB alternate settings for each interface in the currently selected configuration (indicated by the CurrentConfigValue property). This array has one entry for each interface in the configuration. If the CurrentConfigValue property has a value of 0 (zero), which indicates that the device is not configured, the array is undefined. For more information about parsing this octet string, see the USB specification. This property is inherited from CIM_USBDevice.

CurrentConfigValue

Data type: uint8
Access type: Read-only

Configuration currently selected for the device. If this value is 0 (zero), the device is unconfigured. This property is inherited from CIM_USBDevice.

Description

Data type: string
Access type: Read-only

Textual description of the object. This property is inherited from CIM_ManagedSystemElement.

DeviceID

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256), Override ("DeviceID"), MappingStrings ("")

An address or other identifying information which uniquely identifies the USBHub.

ErrorCleared

Data type: boolean
Access type: Read-only

If TRUE, the error reported in the LastErrorCode property is now cleared. This property is inherited from CIM_LogicalDevice.

ErrorDescription

Data type: string
Access type: Read-only

Free-form string that supplies information about the error recorded in the LastErrorCode property and corrective actions to perform. This property is inherited from CIM_LogicalDevice.

GangSwitched

Data type: boolean
Access type: Read-only

If TRUE, power is switched to all ports on the hub simultaneously. If FALSE, power is switched individually for each port.

This property is inherited from CIM_USBHub.

InstallDate

Data type: datetime
Access type: Read-only

Date and time the object was installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

LastErrorCode

Data type: uint32
Access type: Read-only

Last error code reported by the logical device.

This property is inherited from CIM_LogicalDevice.

Name

Data type: string
Access type: Read-only
Qualifiers: Override ("Name"), MappingStrings ("")

Indicates the name of the USB Hub.

NumberOfConfigs

Data type: uint8
Access type: Read-only

Number of device configurations that are defined for the device.

This property is inherited from CIM_USBDevice.

NumberOfPorts

Data type: uint8
Access type: Read-only

Number of downstream ports on the hub, including those embedded in the hub's silicon.

This property is inherited from CIM_USBHub.

PNPDeviceID

Data type: string
Access type: Read-only

Win32 Plug and Play device identifier of the logical device.

Example: "*PNP030b"

This property is inherited from CIM_LogicalDevice.

PowerManagementCapabilities

Data type: uint16 array
Access type: Read-only

Array of the specific power-related capabilities of a logical device.

This property is inherited from CIM_LogicalDevice.

0 (0x0)

Unknown

1 (0x1)

Not Supported

2 (0x2)

Disabled

3 (0x3)

Enabled

The power management features are currently enabled but the exact feature set is unknown or the information is unavailable.

4 (0x4)

Power Saving Modes Entered Automatically

The device can change its power state based on usage or other criteria.

5 (0x5)

Power State Settable

The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.

6 (0x6)

Power Cycling Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle).

7 (0x7)

Timed Power On Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle) and Time set to a specific date and time, or interval, for power-on.

PowerManagementSupported

Data type: boolean
Access type: Read-only

If TRUE, the device can be power managed, that is, put into a power-save state. If FALSE, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array.

This property does not indicate whether power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities array. This property is inherited from CIM_LogicalDevice.

ProtocolCode

Data type: uint8
Access type: Read-only

USB protocol code. This property is inherited from CIM_USBDevice.

Status

Data type: string
Access type: Read-only

Current status of the object. This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

StatusInfo

Data type: uint16
Access type: Read-only

State of the logical device. If this property does not apply to the logical device, the value 5 (Not Applicable) should be used. This property is inherited from CIM_LogicalDevice.

1 (0x1)

Other

2 (0x2)

Unknown

3 (0x3)

Enabled

4 (0x4)

Disabled

5 (0x5)

Not Applicable

SubclassCode

Data type: uint8
Access type: Read-only

USB subclass code. This property is inherited from CIM_USBDevice.

SystemCreationClassName

Data type: string
Access type: Read-only

Scoping system's creation class name. This property is inherited from CIM_LogicalDevice.

SystemName

Data type: string
Access type: Read-only

Scoping system's name. This property is inherited from CIM_LogicalDevice.

USBVersion

Data type: uint16
Access type: Read-only

Latest USB version supported by the USB device. This property is expressed as a binary-coded decimal (BCD) where a decimal point is implied between the second and third digits. For example, a value of 0x201 indicates that version 2.01 is supported. This property is inherited from CIM_USBDevice.

Requirements


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

Win32_USBHub class

Syntax

Members

Methods

Properties

Requirements

See also

Additional resources