- WMI Library -
WMI Libraly > Win32_SerialPort Class

Win32_SerialPort Class

The Win32_SerialPort class represents a serial port on a Win32 system.
Namespace value is root/CIMV2.
WMI Provider value is CIMWin32.


Properties

  • Availability
  • The availability and status of the device. For example, the Availability property indicates that the device is running and has full power (value=3), or is in a warning (4), test (5), degraded (10) or power save state (values 13-15 and 17). Regarding the power saving states, these are defined as follows: Value 13 ("Power Save - Unknown") indicates that the device is known to be in a power save mode, but its exact status in this mode is unknown; 14 ("Power Save - Low Power Mode") indicates that the device is in a power save state but still functioning, and may exhibit degraded performance; 15 ("Power Save - Standby") describes that the device is not functioning but could be brought to full power 'quickly'; and value 17 ("Power Save - Warning") indicates that the device is in a warning state, though also in a power save mode.

  • Binary
  • The Binary property indicates whether the serial port is configured for binary data transfer. Since the Win32 API does not support non-binary mode transfers, this property must be TRUE. Specifying FALSE will not work. Values: TRUE or FALSE. A value of TRUE indicates the serial port is configured for binary data transfer.

  • Capabilities
  • The Capabilities property defines chip level compatibility for the serial controller. Therefore, 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.

  • CapabilityDescriptions
  • An 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.

  • Caption
  • The Caption property is a short textual description (one-line string) of the object.

  • ConfigManagerErrorCode
  • Indicates the Win32 Configuration Manager error code. The following values may be returned:
    0 This device is working properly.
    1 This device is not configured correctly.
    2 Windows cannot load the driver for this device.
    3 The driver for this device might be corrupted, or your system may be running low on memory or other resources.
    4 This device is not working properly. One of its drivers or your registry might be corrupted.
    5 The driver for this device needs a resource that Windows cannot manage.
    6 The boot configuration for this device conflicts with other devices.
    7 Cannot filter.
    8 The driver loader for the device is missing.
    9 This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.
    10 This device cannot start.
    11 This device failed.
    12 This device cannot find enough free resources that it can use.
    13 Windows cannot verify this device's resources.
    14 This device cannot work properly until you restart your computer.
    15 This device is not working properly because there is probably a re-enumeration problem.
    16 Windows cannot identify all the resources this device uses.
    17 This device is asking for an unknown resource type.
    18 Reinstall the drivers for this device.
    19 Your registry might be corrupted.
    20 Failure using the VxD loader.
    21 System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device.
    22 This device is disabled.
    23 System failure: Try changing the driver for this device. If that doesn't work, see your hardware documentation.
    24 This device is not present, is not working properly, or does not have all its drivers installed.
    25 Windows is still setting up this device.
    26 Windows is still setting up this device.
    27 This device does not have valid log configuration.
    28 The drivers for this device are not installed.
    29 This device is disabled because the firmware of the device did not give it the required resources.
    30 This device is using an Interrupt Request (IRQ) resource that another device is using.
    31 This device is not working properly because Windows cannot load the drivers required for this device.

  • ConfigManagerUserConfig
  • Indicates whether the device is using a user-defined configuration.

  • CreationClassName
  • CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

  • Description
  • The Description property provides a textual description of the object.

  • DeviceID
  • The DeviceID property contains a string uniquely identifying the serial port with other devices on the system.

  • ErrorCleared
  • ErrorCleared is a boolean property indicating that the error reported in LastErrorCode property is now cleared.

  • ErrorDescription
  • ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode property, and information on any corrective actions that may be taken.

  • InstallDate
  • The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

  • LastErrorCode
  • LastErrorCode captures the last error code reported by the logical device.

  • MaxBaudRate
  • Maximum baud rate in bits per second supported by the SerialController.

  • MaximumInputBufferSize
  • The MaximumInputBufferSize property specifies the maximum size of the serial port driver's internal input buffer. A value of zero indicates that no maximum value is imposed by the serial provider.

  • MaximumOutputBufferSize
  • The MaximumOutputBufferSize property specifies the maximum size of the serial port driver's internal output buffer. A value of zero indicates that no maximum value is imposed by the serial provider.

  • MaxNumberControlled
  • Maximum number of directly addressable entities supported by this Controller. A value of 0 should be used if the number is unknown or unlimited.

  • Name
  • The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

  • OSAutoDiscovered
  • The OSAutoDiscovered property distinguishes the instances of this class that were automatically discovered by the operating system. If, for example, hardware was added through the Control Panel, the operating system finds instances of this class by querying hardware from the instances of this class. A value of TRUE indicates that the instance was automatically discovered.

  • PNPDeviceID
  • Indicates the Win32 Plug and Play device ID of the logical device. Example: *PNP030b

  • PowerManagementCapabilities
  • Indicates the specific power-related capabilities of the logical device. The array values, 0="Unknown", 1="Not Supported" and 2="Disabled" are self-explanatory. The value, 3="Enabled" indicates that the power management features are currently enabled but the exact feature set is unknown or the information is unavailable. "Power Saving Modes Entered Automatically" (4) describes that a device can change its power state based on usage or other criteria. "Power State Settable" (5) indicates that the SetPowerState method is supported. "Power Cycling Supported" (6) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 ("Power Cycle"). "Timed Power On Supported" (7) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 ("Power Cycle") and the Time parameter set to a specific date and time, or interval, for power-on.

  • PowerManagementSupported
  • Boolean indicating that the Device can be power managed - ie, put into a power save state. This boolean does not indicate that power management features are currently enabled, or if enabled, what features are supported. Refer to the PowerManagementCapabilities array for this information. If this boolean is false, the integer value 1, for the string, "Not Supported", should be the only entry in the PowerManagementCapabilities array.

  • ProtocolSupported
  • The protocol used by the controller to access 'controlled' devices.

  • ProviderType
  • The ProviderType property specifies the communications provider type.

  • SettableBaudRate
  • The SettableBaudRate property indicates whether the baud rate can be changed for this serial port.
    Values: TRUE or FALSE. A value of TRUE indicates the baud rate can be changed.

  • SettableDataBits
  • The SettableDataBits property indicates whether data bits can be set for this serial port.
    Values: TRUE or FALSE. A value of TRUE indicates the data bits can be set.

  • SettableFlowControl
  • The SettableFlowControl property indicates whether flow control can be set for this serial port.
    Values: TRUE or FALSE. A value of TRUE indicates the flow control can be set.

  • SettableParity
  • The SettableParity property indicates whether parity can be set for this serial port.
    Values: TRUE or FALSE. A value of TRUE indicates the parity can be set.

  • SettableParityCheck
  • The SettableParityCheck property indicates whether parity checking can be set for this serial port (if parity checking is supported).
    Values: TRUE or FALSE. A value of TRUE indicates parity checking can be set.

  • SettableRLSD
  • The SettableRLSD property indicates whether RLSD can be set for this serial port (if Received Line Signal Detect (RLSD) is supported).
    Values: TRUE or FALSE. A value of TRUE indicates the RLSD can be set.

  • SettableStopBits
  • The SettableStopBits property indicates whether stop bits can be set for this serial port.
    Values: TRUE or FALSE. A value of TRUE indicates the stop bits can be set.

  • Status
  • The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are "OK", "Degraded" and "Pred Fail". "Pred Fail" indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are "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 on-line, yet the managed element is neither "OK" nor in one of the other states.

  • StatusInfo
  • StatusInfo is a string indicating whether the logical device is in an enabled (value = 3), disabled (value = 4) or some other (1) or unknown (2) state. If this property does not apply to the logical device, the value, 5 ("Not Applicable"), should be used.

  • Supports16BitMode
  • The Supports16BitMode property indicates whether 16-bit mode is supported on this serial port.
    Values: TRUE or FALSE. A value of TRUE indicates 16-bit mode is supported.

  • SupportsDTRDSR
  • The SupportsDTRDSR property indicates whether Data Terminal Ready (DTR) and Data Set Ready (DSR) signals are supported on this serial port.
    Values: TRUE or FALSE. A value of TRUE indicates DTR and DSR signals are supported.

  • SupportsElapsedTimeouts
  • The SupportsElapsedTimeouts property indicates whether elapsed timeouts are supported on this serial port. Elapsed timeouts track the total amount of time between data transmissions.
    Values: TRUE or FALSE. A value of TRUE indicates elapsed timeouts are supported.

  • SupportsIntTimeouts
  • The SupportsIntTimeouts property indicates whether interval time-outs are supported. An interval timeout is the amount of time allowed to elapse between the arrival of each piece of data.
    Values: TRUE or FALSE. A value of TRUE indicates interval timeouts are supported.

  • SupportsParityCheck
  • The SupportsParityCheck property indicates whether parity checking is supported on this serial port.
    Values: TRUE or FALSE. A value of TRUE indicates parity checking is supported.

  • SupportsRLSD
  • The SupportsRLSD property indicates whether Received Line Signal Detect (RLSD) is supported on this serial port.
    Values: TRUE or FALSE. A value of TRUE indicates RLSD is supported.

  • SupportsRTSCTS
  • The SupportsRTSCTS property indicates whether Ready To Send (RTS) and Clear To Send (CTS) signals are supported on this serial port.
    Values: TRUE or FALSE. A value of TRUE indicates RTS and CTS signals are supported.

  • SupportsSpecialCharacters
  • The SupportsSpecialCharacters property indicates whether 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.
    Values: TRUE or FALSE. A value of TRUE indicates special characters are supported.

  • SupportsXOnXOff
  • The SupportsXOnXOff property indicates whether XON/XOFF flow control is supported on this serial port.
    Values: TRUE or FALSE. A value of TRUE indicates XON/XOFF is supported.

  • SupportsXOnXOffSet
  • The SupportsXOnXOffSet property indicates whether the communications provider supports configuration of the XON/XOFF flow control setting.
    Values: TRUE or FALSE. A value of TRUE indicates XON/XOFF flow control setting is supported.

  • SystemCreationClassName
  • The scoping System's CreationClassName.

  • SystemName
  • The scoping System's Name.

  • TimeOfLastReset
  • The TimeOfLastReset property indicates the date and time this controller was last reset. This could mean the controller was powered down, or reinitialized.


    Methods

  • SetPowerState
  • SetPowerState defines the desired power state for a logical device and when a device should be put into that state. The desired power state is specified by setting the PowerState parameter to one of the following integer values: 1="Full Power", 2="Power Save - Low Power Mode", 3="Power Save - Standby", 4="Power Save - Other", 5="Power Cycle" or 6="Power Off". The Time parameter (for all state changes, except 5, "Power Cycle") indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received). When the PowerState parameter is equal to 5, "Power Cycle", the Time parameter indicates when the device should power on again. Power off is immediate. SetPowerState should return 0 if successful, 1 if the specified PowerState and Time request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.

  • Reset
  • Requests a reset of the logical device. The return value should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred.


    Example WQL

    SELECT * FROM Win32_SerialPort
    About this site information

    This contents is created by WMI having class information.
    WMI Environment is Windows Server 2008 R2 Enterprise Edition.

    This link is Microsoft documents for "Managing Windows with WMI".
    That is VB(Visual Basic) scripting sample.
    This link is Microsoft documents for "Advanced Programming Topics in WMI .NET".
    That is VB.net(Visual Basic .net) scripting sample.

    - WMI Library -
    http://library.wmifun.net/

    WMI useful by VB,VB.Net,VC,VC.Net,VC#.Net,VBS(WSH),PowerShell for PC asset management, system monitoring and collecting hardware and software inventory.

    This website is created by Toh.
    Copyright(C) 1997-2016 WMI Fun !!. All rights reserved.
    ^ Go to the top...