wmi Win32_SerialPort reference for Network Programming in .NET with C# & Visual Basic .NET (VB.NET)

WMI class ' Win32_SerialPort ' reference for C# and VB.NET

MOF Reference

[Description("The Win32_SerialPort class represents a serial port on a Win32 system."): ToSubClass, AMENDMENT, LOCALE(1033)]
class Win32_SerialPort : CIM_SerialController
{
	[Description("The DeviceID property contains a string uniquely identifying the serial port with other devices on the system."): ToSubClass, key] string DeviceID = NULL;
	[Description("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."): ToSubClass] boolean Binary;
	[Description("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."): ToSubClass] uint32 MaximumInputBufferSize;
	[Description("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."): ToSubClass] uint32 MaximumOutputBufferSize;
	[Description("The ProviderType property specifies the communications provider type."): ToSubClass, Values{"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"}: ToSubClass] string ProviderType;
	[Description("The SettableBaudRate property indicates whether the baud rate can be changed for this serial port.\nValues: TRUE or FALSE. A value of TRUE indicates the baud rate can be changed."): ToSubClass] boolean SettableBaudRate;
	[Description("The SettableDataBits property indicates whether data bits can be set for this serial port.\nValues: TRUE or FALSE. A value of  TRUE indicates the data bits can be set."): ToSubClass] boolean SettableDataBits;
	[Description("The SettableFlowControl property indicates whether flow control can be set for this serial port.\nValues: TRUE or FALSE. A value of TRUE indicates the flow control can be set."): ToSubClass] boolean SettableFlowControl;
	[Description("The SettableParity property indicates whether parity can be set for this serial port.\nValues: TRUE or FALSE. A value of TRUE indicates the parity can be set."): ToSubClass] boolean SettableParity;
	[Description("The SettableParityCheck property indicates whether parity checking can be set for this serial port (if parity checking is supported). \nValues: TRUE or FALSE. A value of TRUE indicates parity checking can be set."): ToSubClass] boolean SettableParityCheck;
	[Description("The SettableRLSD property indicates whether RLSD can be set for this serial port (if Received Line Signal Detect (RLSD) is supported). \nValues: TRUE or FALSE.  A value of TRUE indicates the RLSD can be set."): ToSubClass] boolean SettableRLSD;
	[Description("The SettableStopBits property indicates whether stop bits can be set for this serial port.\nValues: TRUE or FALSE. A value of TRUE indicates the stop bits can be set."): ToSubClass] boolean SettableStopBits;
	[Description("The Supports16BitMode property indicates whether 16-bit mode is supported on this serial port.\nValues: TRUE or FALSE. A value of TRUE indicates 16-bit mode is supported."): ToSubClass] boolean Supports16BitMode;
	[Description("The SupportsDTRDSR property indicates whether Data Terminal Ready (DTR) and Data Set Ready (DSR) signals are supported on this serial port.\nValues: TRUE or FALSE. A value of TRUE indicates DTR and DSR signals are supported."): ToSubClass] boolean SupportsDTRDSR;
	[Description("The SupportsElapsedTimeouts property indicates whether elapsed timeouts are supported on this serial port. Elapsed timeouts track the total amount of time between data transmissions.\nValues: TRUE or FALSE.  A value of TRUE indicates elapsed timeouts are supported."): ToSubClass] boolean SupportsElapsedTimeouts;
	[Description("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.\nValues: TRUE or FALSE. A value of TRUE indicates interval timeouts are supported."): ToSubClass] boolean SupportsIntTimeouts;
	[Description("The SupportsParityCheck property indicates whether parity checking is supported on this serial port.\nValues: TRUE or FALSE. A value of TRUE indicates parity checking is supported."): ToSubClass] boolean SupportsParityCheck;
	[Description("The SupportsRLSD property indicates whether Received Line Signal Detect (RLSD) is supported on this serial port.\nValues: TRUE or FALSE. A value of TRUE indicates RLSD is supported."): ToSubClass] boolean SupportsRLSD;
	[Description("The SupportsRTSCTS property indicates whether Ready To Send (RTS) and Clear To Send (CTS) signals are supported on this serial port.\nValues: TRUE or FALSE. A value of TRUE indicates RTS and CTS signals are supported."): ToSubClass] boolean SupportsRTSCTS;
	[Description("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.\nValues: TRUE or FALSE. A value of TRUE indicates special characters are supported."): ToSubClass] boolean SupportsSpecialCharacters;
	[Description("The SupportsXOnXOff property indicates whether XON/XOFF flow control is supported on this serial port.\nValues: TRUE or FALSE. A value of TRUE indicates XON/XOFF is supported."): ToSubClass] boolean SupportsXOnXOff;
	[Description("The SupportsXOnXOffSet property indicates whether the communications provider supports configuration of the XON/XOFF flow control setting.\nValues: TRUE or FALSE. A value of TRUE indicates  XON/XOFF flow control setting is supported."): ToSubClass] boolean SupportsXOnXOffSet;
	[Description("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."): ToSubClass] boolean OSAutoDiscovered;
};

Class properties:

Win32_SerialPort.Availability
Win32_SerialPort.Binary
Win32_SerialPort.Capabilities
Win32_SerialPort.CapabilityDescriptions
Win32_SerialPort.Caption
Win32_SerialPort.ConfigManagerErrorCode
Win32_SerialPort.ConfigManagerUserConfig
Win32_SerialPort.CreationClassName
Win32_SerialPort.Description
Win32_SerialPort.DeviceID
Win32_SerialPort.ErrorCleared
Win32_SerialPort.ErrorDescription
Win32_SerialPort.InstallDate
Win32_SerialPort.LastErrorCode
Win32_SerialPort.MaxBaudRate
Win32_SerialPort.MaximumInputBufferSize
Win32_SerialPort.MaximumOutputBufferSize
Win32_SerialPort.MaxNumberControlled
Win32_SerialPort.Name
Win32_SerialPort.OSAutoDiscovered
Win32_SerialPort.PNPDeviceID
Win32_SerialPort.PowerManagementCapabilities
Win32_SerialPort.PowerManagementSupported
Win32_SerialPort.ProtocolSupported
Win32_SerialPort.ProviderType
Win32_SerialPort.SettableBaudRate
Win32_SerialPort.SettableDataBits
Win32_SerialPort.SettableFlowControl
Win32_SerialPort.SettableParity
Win32_SerialPort.SettableParityCheck
Win32_SerialPort.SettableRLSD
Win32_SerialPort.SettableStopBits
Win32_SerialPort.Status
Win32_SerialPort.StatusInfo
Win32_SerialPort.Supports16BitMode
Win32_SerialPort.SupportsDTRDSR
Win32_SerialPort.SupportsElapsedTimeouts
Win32_SerialPort.SupportsIntTimeouts
Win32_SerialPort.SupportsParityCheck
Win32_SerialPort.SupportsRLSD
Win32_SerialPort.SupportsRTSCTS
Win32_SerialPort.SupportsSpecialCharacters
Win32_SerialPort.SupportsXOnXOff
Win32_SerialPort.SupportsXOnXOffSet
Win32_SerialPort.SystemCreationClassName
Win32_SerialPort.SystemName
Win32_SerialPort.TimeOfLastReset

WMI is a huge subject, so therefore it is practically impossible to provide a comprehensive example program that covers anything. However, the book �Network programming in .NET� (Buy at Amazon UK) (Buy at Amazon US) covers a much wider scope of WMI, and explains how to leverage it to access the bounty of information held within this vast, yet simple object model.

Articles

Contact us

Please use FireFox to view this page

WMI class ' Win32_SerialPort ' reference for C# and VB.NET

MOF Reference

Class properties: