Export (0) Print
Expand All
Expand Minimize

Win32_SerialPort class

The Win32_SerialPort WMI class represents a serial port on a computer system running Windows.

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

[Provider("CIMWin32")]class Win32_SerialPort : CIM_SerialController
{
  uint16   Availability;
  boolean  Binary;
  uint16   Capabilities[];
  string   CapabilityDescriptions[];
  string   Caption;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  string   Description;
  string   DeviceID;
  boolean  ErrorCleared;
  string   ErrorDescription;
  datetime InstallDate;
  uint32   LastErrorCode;
  uint32   MaxBaudRate;
  uint32   MaximumInputBufferSize;
  uint32   MaximumOutputBufferSize;
  uint32   MaxNumberControlled;
  string   Name;
  boolean  OSAutoDiscovered;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  uint16   ProtocolSupported;
  string   ProviderType;
  boolean  SettableBaudRate;
  boolean  SettableDataBits;
  boolean  SettableFlowControl;
  boolean  SettableParity;
  boolean  SettableParityCheck;
  boolean  SettableRLSD;
  boolean  SettableStopBits;
  string   Status;
  uint16   StatusInfo;
  boolean  Supports16BitMode;
  boolean  SupportsDTRDSR;
  boolean  SupportsElapsedTimeouts;
  boolean  SupportsIntTimeouts;
  boolean  SupportsParityCheck;
  boolean  SupportsRLSD;
  boolean  SupportsRTSCTS;
  boolean  SupportsSpecialCharacters;
  boolean  SupportsXOnXOff;
  boolean  SupportsXOnXOffSet;
  string   SystemCreationClassName;
  string   SystemName;
  datetime TimeOfLastReset;
};

Members

The Win32_SerialPort class has these types of members:

Methods

The Win32_SerialPort class has these methods.

MethodDescription
Reset

Not implemented. To implement this method, see the Reset method in CIM_SerialController.

SetPowerState

Not implemented. To implement this method, see the SetPowerState method in CIM_SerialController.

 

Properties

The Win32_SerialPort class has these properties.

Availability
Data type: uint16
Access type: Read-only

Availability and status of the device. Inherited from CIM_LogicalDevice.

ValueMeaning
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.

 

Binary
Data type: boolean
Access type: Read-only

If TRUE, the serial port is configured for binary data transfer. Because the Windows API does not support nonbinary mode transfers, this property must be TRUE.

Capabilities
Data type: uint16 array
Access type: Read-only

Array of chip-level compatibility for the serial controller. This property describes the buffering and other capabilities of the serial controller that may be inherent in the chip hardware. The property is an enumerated integer. This property is inherited from CIM_SerialController.

ValueMeaning
1

Other

2

Unknown

3

XT/AT Compatible

4

16450 Compatible

5

16550 Compatible

6

16550A Compatible

160

8251 Compatible

161

8251FIFO Compatible

 

CapabilityDescriptions
Data type: string array
Access type: Read-only

Array of free-form strings providing more detailed explanations for any of the serial controller features indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index. This property is inherited from CIM_SerialController.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

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

ConfigManagerErrorCode
Data type: uint32
Access type: Read-only

Win32 Configuration Manager error code.

ValueMeaning
0 (0x0)

Device is working properly.

1 (0x1)

Device is not configured correctly.

2 (0x2)

Windows cannot load the driver for this device.

3 (0x3)

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

4 (0x4)

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

5 (0x5)

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

6 (0x6)

Boot configuration for the device conflicts with other devices.

7 (0x7)

Cannot filter.

8 (0x8)

Driver loader for the device is missing.

9 (0x9)

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

10 (0xA)

Device cannot start.

11 (0xB)

Device failed.

12 (0xC)

Device cannot find enough free resources to use.

13 (0xD)

Windows cannot verify the device's resources.

14 (0xE)

Device cannot work properly until the computer is restarted.

15 (0xF)

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

16 (0x10)

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

17 (0x11)

Device is requesting an unknown resource type.

18 (0x12)

Device drivers must be reinstalled.

19 (0x13)

Failure using the VxD loader.

20 (0x14)

Registry might be corrupted.

21 (0x15)

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

22 (0x16)

Device is disabled.

23 (0x17)

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

24 (0x18)

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

25 (0x19)

Windows is still setting up the device.

26 (0x1A)

Windows is still setting up the device.

27 (0x1B)

Device does not have valid log configuration.

28 (0x1C)

Device drivers are not installed.

29 (0x1D)

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

30 (0x1E)

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

31 (0x1F)

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 first concrete class to appear in the inheritance chain used in the creation of an instance. When used with the other key properties of the class, the property allows all instances of this class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice.

Description
Data type: string
Access type: Read-only

Description of the object. This property is inherited from CIM_ManagedSystemElement.

DeviceID
Data type: string
Access type: Read-only
Qualifiers: Key

Unique identifier of the serial port with other devices on the system. This property is inherited from CIM_LogicalDevice.

ErrorCleared
Data type: boolean
Access type: Read-only

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

ErrorDescription
Data type: string
Access type: Read-only

Free-form string supplying more information about the error recorded in LastErrorCode, and information about any corrective actions that may be taken. This property is inherited from CIM_LogicalDevice.

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.

MaxBaudRate
Data type: uint32
Access type: Read-only
Qualifiers: Units (Bits per second)

Maximum baud rate (in bits per second) supported by the serial controller. This property is inherited from CIM_SerialController.

MaximumInputBufferSize
Data type: uint32
Access type: Read-only
Qualifiers: Units (Bytes)

Maximum size of the serial port driver's internal input buffer. A value of 0 (zero) indicates that no maximum value is imposed by the serial provider.

MaximumOutputBufferSize
Data type: uint32
Access type: Read-only
Qualifiers: Units (Bytes)

Maximum size of the serial port driver's internal output buffer. A value of 0 (zero) indicates that no maximum value is imposed by the serial provider.

MaxNumberControlled
Data type: uint32
Access type: Read-only

Maximum number of directly addressable entities supportable by this controller. A value of 0 (zero) should be used if the number is unknown. This property is inherited from CIM_Controller.

Name
Data type: string
Access type: Read-only

Label by which the object is known. When subclassed, the property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

OSAutoDiscovered
Data type: boolean
Access type: Read-only

If TRUE, the instances of this class were automatically discovered by the operating system. If, for example, hardware was added through Control Panel, the operating system finds instances of this class by querying hardware from the instances of this class.

PNPDeviceID
Data type: string
Access type: Read-only

Windows Plug and Play device identifier of the logical device. This property is inherited from CIM_LogicalDevice.

Example: "*PNP030b"

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.

ValueMeaning
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 (can be put into suspend mode, and so on). The property does not indicate that power management features are currently enabled, only that the logical device is capable of power management.

ProtocolSupported
Data type: uint16
Access type: Read-only

Protocol used by the controller to access "controlled" devices. This property is inherited from CIM_Controller. The following table shows the possible values.

ValueMeaning
1 (0x1)

Other

2 (0x2)

Unknown

3 (0x3)

EISA

4 (0x4)

ISA

5 (0x5)

PCI

6 (0x6)

ATA or ATAPI

7 (0x7)

Flexible Diskette

8 (0x8)

1496

9 (0x9)

SCSI Parallel Interface

10 (0xA)

SCSI Fibre Channel Protocol

11 (0xB)

SCSI Serial Bus Protocol

12 (0xC)

SCSI Serial Bus Protocol-2 (1394)

13 (0xD)

SCSI Serial Storage Architecture

14 (0xE)

VESA

15 (0xF)

PCMCIA

16 (0x10)

Universal Serial Bus

17 (0x11)

Parallel Protocol

18 (0x12)

ESCON

19 (0x13)

Diagnostic

20 (0x14)

I2C

21 (0x15)

Power

22 (0x16)

HIPPI

23 (0x17)

MultiBus

24 (0x18)

VME

25 (0x19)

IPI

26 (0x1A)

IEEE-488

27 (0x1B)

RS232

28 (0x1C)

IEEE 802.3 10BASE5

29 (0x1D)

IEEE 802.3 10BASE2

30 (0x1E)

IEEE 802.3 1BASE5

31 (0x1F)

IEEE 802.3 10BROAD36

32 (0x20)

IEEE 802.3 100BASEVG

33 (0x21)

IEEE 802.5 Token-Ring

34 (0x22)

ANSI X3T9.5 FDDI

35 (0x23)

MCA

36 (0x24)

ESDI

37 (0x25)

IDE

38 (0x26)

CMD

39 (0x27)

ST506

40 (0x28)

DSSI

41 (0x29)

QIC2

42 (0x2A)

Enhanced ATA/IDE

43 (0x2B)

AGP

44 (0x2C)

TWIRP (two-way infrared)

45 (0x2D)

FIR (fast infrared)

46 (0x2E)

SIR (serial infrared)

47 (0x2F)

IrBus

 

ProviderType
Data type: string
Access type: Read-only

Communications provider type.

The values are:

"FAX Device"
"LAT Protocol"
"Modem Device"
"Network Bridge"
"Parallel Port"
"RS232 Serial Port"
"RS422 Port"
"RS423 Port"
"RS449 Port"
"Scanner Device"
"TCP/IP TelNet"
"X.25"
"Unspecified"
SettableBaudRate
Data type: boolean
Access type: Read-only

If TRUE, the baud rate can be changed for this serial port.

SettableDataBits
Data type: boolean
Access type: Read-only

If TRUE, data bits can be set for this serial port.

SettableFlowControl
Data type: boolean
Access type: Read-only

If TRUE, flow control can be set for this serial port.

SettableParity
Data type: boolean
Access type: Read-only

If TRUE, parity can be set for this serial port.

SettableParityCheck
Data type: boolean
Access type: Read-only

If TRUE, parity checking can be set for this serial port (if parity checking is supported).

SettableRLSD
Data type: boolean
Access type: Read-only

If TRUE, Received Line Signal Detect (RLSD) can be set for this serial port (if RLSD is supported).

SettableStopBits
Data type: boolean
Access type: Read-only

If TRUE, stop bits can be set for this serial port.

Status
Data type: string
Access type: Read-only
Qualifiers: MaxLen (10)

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is online, yet the managed element is neither "OK" nor in one of the other states. This property is inherited from CIM_ManagedSystemElement.

Values are:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"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.

ValueMeaning
1

Other

2

Unknown

3

Enabled

4

Disabled

5

Not Applicable

 

Supports16BitMode
Data type: boolean
Access type: Read-only

If TRUE, 16-bit mode is supported on this serial port.

SupportsDTRDSR
Data type: boolean
Access type: Read-only

If TRUE, data terminal ready (DTR) and data set ready (DSR) signals are supported on this serial port.

SupportsElapsedTimeouts
Data type: boolean
Access type: Read-only

If TRUE, elapsed time-outs are supported on this serial port. Elapsed timeouts track the total amount of time between data transmissions.

SupportsIntTimeouts
Data type: boolean
Access type: Read-only

If TRUE, interval time-outs are supported. An interval timeout is the amount of time allowed to elapse between the arrival of each piece of data.

SupportsParityCheck
Data type: boolean
Access type: Read-only

If TRUE, parity checking is supported on this serial port.

SupportsRLSD
Data type: boolean
Access type: Read-only

If TRUE, Received Line Signal Detect (RLSD) is supported on this serial port.

SupportsRTSCTS
Data type: boolean
Access type: Read-only

If TRUE, ready to send (RTS) and clear to send (CTS) signals are supported on this serial port.

SupportsSpecialCharacters
Data type: boolean
Access type: Read-only

If TRUE, serial port control characters are supported. These characters signal events rather than data. These characters are not displayable and are set by the driver. They include EofChar, ErrorChar, BreakChar, EventChar, XonChar, and XoffChar.

SupportsXOnXOff
Data type: boolean
Access type: Read-only

If TRUE, XON or XOFF flow-control is supported on this serial port.

SupportsXOnXOffSet
Data type: boolean
Access type: Read-only

If TRUE, the communications provider supports configuration of the XONor XOFF flow-control setting.

SystemCreationClassName
Data type: string
Access type: Read-only

Value of the scoping computer's CreationClassName property. This property is inherited from CIM_LogicalDevice.

SystemName
Data type: string
Access type: Read-only

Name of the scoping system. This property is inherited from CIM_LogicalDevice.

TimeOfLastReset
Data type: datetime
Access type: Read-only

Date and time this controller was last reset. This could mean the controller was powered down, or reinitialized. This property is inherited from CIM_Controller.

Remarks

The Win32_SerialPort class is derived from CIM_SerialController.

Examples

For an alternate method of retrieving serial port information (from the registry), see the Enumerate Ports Visual Basic sample.

The List Serial Port Properties PowerShell example returns information about the serial ports installed on a computer.

The following VBScript sample returns information about the serial ports installed on a computer.

On Error Resume Next 
 
strComputer = "." 
Set objWMIService = GetObject("winmgmts:" _ 
    & "{impersonationLevel=impersonate}!\\" & strComputer & "\root\cimv2") 
 
Set colItems = objWMIService.ExecQuery("Select * from Win32_SerialPort") 
 
For Each objItem in colItems 
    Wscript.Echo "Binary: " & objItem.Binary 
    Wscript.Echo "Description: " & objItem.Description 
    Wscript.Echo "Device ID: " & objItem.DeviceID 
    Wscript.Echo "Maximum Baud Rate: " & objItem.MaxBaudRate 
    Wscript.Echo "Maximum Input Buffer Size: " & objItem.MaximumInputBufferSize 
    Wscript.Echo "Maximum Output Buffer Size: " & _ 
        objItem.MaximumOutputBufferSize 
    Wscript.Echo "Name: " & objItem.Name 
    Wscript.Echo "OS Auto Discovered: " & objItem.OSAutoDiscovered 
    Wscript.Echo "PNP Device ID: " & objItem.PNPDeviceID 
    Wscript.Echo "Provider Type: " & objItem.ProviderType 
    Wscript.Echo "Settable Baud Rate: " & objItem.SettableBaudRate 
    Wscript.Echo "Settable Data Bits: " & objItem.SettableDataBits 
    Wscript.Echo "Settable Flow Control: " & objItem.SettableFlowControl 
    Wscript.Echo "Settable Parity: " & objItem.SettableParity 
    Wscript.Echo "Settable Parity Check: " & objItem.SettableParityCheck 
    Wscript.Echo "Settable RLSD: " & objItem.SettableRLSD 
    Wscript.Echo "Settable Stop Bits: " & objItem.SettableStopBits 
    Wscript.Echo "Supports 16-Bit Mode: " & objItem.Supports16BitMode 
    Wscript.Echo "Supports DTRDSR: " & objItem.SupportsDTRDSR 
    Wscript.Echo "Supports Elapsed Timeouts: " & _ 
        objItem.SupportsElapsedTimeouts 
    Wscript.Echo "Supports Int Timeouts: " & objItem.SupportsIntTimeouts 
    Wscript.Echo "Supports Parity Check: " & objItem.SupportsParityCheck 
    Wscript.Echo "Supports RLSD: " & objItem.SupportsRLSD 
    Wscript.Echo "Supports RTSCTS: " & objItem.SupportsRTSCTS 
    Wscript.Echo "Supports Special Characters: " & _ 
        objItem.SupportsSpecialCharacters 
    Wscript.Echo "Supports XOn XOff: " & objItem.SupportsXOnXOff 
    Wscript.Echo "Supports XOn XOff Setting: " & objItem.SupportsXOnXOffSet 
Next

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

See also

Computer System Hardware Classes

 

 

Show:
© 2014 Microsoft