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

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

MOF Reference

[Description("The Win32_SerialPortConfiguration class represents the default settings for data transmission on a Win32 serial port. this may include the default configuration for establishing a connection and error checking."): ToSubClass, AMENDMENT, LOCALE(1033)]
class Win32_SerialPortConfiguration : CIM_Setting
{
	[Description("The AbortReadWriteOnError property indicates whether read and write operations are terminated if an error occurs.\nValues: TRUE or FALSE. If TRUE, the driver terminates all read and write operations with an error status if an error occurs. The driver will not accept any further communications operations until the application acknowledges the error."): ToSubClass] boolean AbortReadWriteOnError;
	[Description("The BaudRate property indicates the baud (bits per second) rate at which the communications device operates. \nExample: 9600"): ToSubClass] uint32 BaudRate;
	[Description("The BinaryModeEnabled property indicates whether binary-mode data transfers are enabled for the serial port. Win32 systems only allow binary transfers through serial ports, so this value will always be TRUE."): ToSubClass] boolean BinaryModeEnabled;
	[Description("The BitsPerByte property indicates the number of bits transmitted and received for each byte of data for the Win32 serial port. The number may vary with control and error correction bits, such as parity bits.\nExample: 8"): ToSubClass] uint32 BitsPerByte;
	[Description("The ContinueXMitOnXOff property specifies whether data transmissions continue when the receiving buffer is close to full and an XoffChar character has been sent to the transmitter.\nValues: TRUE or FALSE. If TRUE, transmission continues after the input buffer has come within XoffLim bytes of being full and the driver has transmitted the XoffChar character to stop receiving bytes. If FALSE, transmission does not continue until the input buffer is within XonLim bytes of being empty and the driver has transmitted the XonChar character to resume reception."): ToSubClass] boolean ContinueXMitOnXOff;
	[Description("The CTSOutflowControl property determines whether the Clear To Send (CTS) is checked before transmitting data. CTS signals that both devices on the serial connection are ready to transfer data. \nValues: TRUE or FALSE. If TRUE, data transmission is suspended until CTS signal is given."): ToSubClass] boolean CTSOutflowControl;
	[Description("The DiscardNULLBytes property determines whether to discard NULL bytes (characters) when they are received.\nValues: TRUE or FALSE. If TRUE, NULL bytes are discarded."): ToSubClass] boolean DiscardNULLBytes;
	[Description("The DSROutflowControl property determines whether data outflow control is enabled when there is a Data Set Ready (DSR) condition. DSR signals that the connection has been established by the devices on the serial connection.\nValues: TRUE or FALSE. If TRUE, DSR data transmission is suspended until DSR signal is given."): ToSubClass] boolean DSROutflowControl;
	[Description("The DSRSensitivity property specifies whether the communications driver is sensitive to the state of the DSR signal. \nValues: TRUE or FALSE. If TRUE, the driver ignores any bytes received, unless the DSR modem input line is high."): ToSubClass] boolean DSRSensitivity;
	[Description("The DTRFlowControlType property specifies the use of the data-terminal-ready (DTR) flow control after a connection has been established. After a communication line has been established the DTR can be left in the following states: enabled, to show that the connection is still active; disabled, to ignore the DTR once received; or it can be used as a data flow control flag."): ToSubClass, Values{"Enable", "Disable", "Handshake"}: ToSubClass] string DTRFlowControlType;
	[Description("The EOFCharacter property specifies the value of the character used to signal the end of data. .\nExample: ^Z"): ToSubClass] uint32 EOFCharacter;
	[Description("The ErrorReplaceCharacter property specifies the value of the character used to replace bytes received with a parity error. \nExample: ^C"): ToSubClass] uint32 ErrorReplaceCharacter;
	[Description("The ErrorReplacementEnabled specifies whether bytes received with parity errors are replaced with the ErrorReplaceCharacter value. Characters with parity errors are only replaced if this member is TRUE and the parity is enabled."): ToSubClass] boolean ErrorReplacementEnabled;
	[Description("The EventCharacter specifies the value of the control character that is used to signal an event, such as end of file.\nExample: ^e"): ToSubClass] uint32 EventCharacter;
	[Description("The IsBusy property determines whether the serial port is busy.\nValues: TRUE or FALSE. If TRUE, the serial port is busy."): ToSubClass] boolean IsBusy;
	[key, Description("The Name property indicates the name of the Win32 serial port.\nExample: COM1"): ToSubClass] string Name;
	[Description("The Parity property specifies the method of parity checking to be used. Parity is used as an error checking technique where an extra parity bit is included with every unit of data. If even parity is used, the parity bit is used to make the total count of bits set an even number. The receiver can then verify the validity of the data by counting the bits that are set. Odd parity, sets the parity bit so that the count of bits set is an odd number. Mark parity always leaves the parity bit set to 1, while space parity always leaves the parity bit set to 0.\nExample: Even"): ToSubClass, Values{"None", "Odd", "Even", "Mark", "Space"}: ToSubClass] string Parity;
	[Description("The ParityCheckEnabled property determines whether parity checking is enabled.\nValues: TRUE or FALSE. If TRUE, parity checking is enabled."): ToSubClass] boolean ParityCheckEnabled;
	[Description("The RTSFlowControlType property specifies the  request-to-send (RTS) flow control. RTS is used to signal that data is available for transmission. Uses of this member include:\nDisable - RTS is ignored after the first RTS signal is received.\nEnable - RTS is left on for the data transfer session.\nHandshake - RTS is turned off if the transmission buffer is more than three-quarters full, and RTS is turned on when the buffer is less than one-half full.\nToggle - RTS is turned on if there is any data buffered for transmission.\n"): ToSubClass, Values{"Enable", "Disable", "Handshake", "Toggle"}: ToSubClass] string RTSFlowControlType;
	[Description("The StopBits specifies the number of stop bits to be used. StopBits separate each unit of data on an asynchronous serial connection. They are also sent continuously when no data is available for transmission.\nExample: 1"): ToSubClass, Values{"1", "1.5", "2"}: ToSubClass] string StopBits;
	[Description("The XOffCharacter property specifies the value of the XOFF character for both transmission and reception. XOFF is a software control to stop the transmission of data (whereas RTS and CTS are hardware controls). XON resumes the transmission."): ToSubClass] uint32 XOffCharacter;
	[Description("The XOffXMitThreshold property specifies the maximum number of bytes allowed in the input buffer before the XOFF character is sent."): ToSubClass] uint32 XOffXMitThreshold;
	[Description("The XOnCharacter property specifies the value of the XON character for both transmission and reception. XON is a software control to resume the transmission of data (whereas RTS and CTS are hardware controls). XOFF stops the transmission."): ToSubClass] uint32 XOnCharacter;
	[Description("The XOnXMitThreshold property specifies the minimum number of bytes allowed in the input buffer before the XON character is sent. This member works in conjunction with XOffXMitThreshold to regulate the rate at which data is transferred."): ToSubClass] uint32 XOnXMitThreshold;
	[Description("The XOnXOffInFlowControl property specifies whether XON/XOFF flow control is used during reception.\nValues TRUE or FALSE. If TRUE the XOffCharacter is sent when the input buffer comes within XOffXMitThreshold bytes of being full, and the XOnCharacter is sent when the input buffer comes within XOnXMitThreshold bytes of being empty."): ToSubClass] uint32 XOnXOffInFlowControl;
	[Description("The XOnXOffOutFlowControl specifies whether XON/XOFF flow control is used during transmission.\nValues TRUE or FALSE. If TRUE, transmission stops when the XOffCharacter is received and starts again when the XonCharacter is received."): ToSubClass] uint32 XOnXOffOutFlowControl;
};

Class properties:

Win32_SerialPortConfiguration.AbortReadWriteOnError
Win32_SerialPortConfiguration.BaudRate
Win32_SerialPortConfiguration.BinaryModeEnabled
Win32_SerialPortConfiguration.BitsPerByte
Win32_SerialPortConfiguration.Caption
Win32_SerialPortConfiguration.ContinueXMitOnXOff
Win32_SerialPortConfiguration.CTSOutflowControl
Win32_SerialPortConfiguration.Description
Win32_SerialPortConfiguration.DiscardNULLBytes
Win32_SerialPortConfiguration.DSROutflowControl
Win32_SerialPortConfiguration.DSRSensitivity
Win32_SerialPortConfiguration.DTRFlowControlType
Win32_SerialPortConfiguration.EOFCharacter
Win32_SerialPortConfiguration.ErrorReplaceCharacter
Win32_SerialPortConfiguration.ErrorReplacementEnabled
Win32_SerialPortConfiguration.EventCharacter
Win32_SerialPortConfiguration.IsBusy
Win32_SerialPortConfiguration.Name
Win32_SerialPortConfiguration.Parity
Win32_SerialPortConfiguration.ParityCheckEnabled
Win32_SerialPortConfiguration.RTSFlowControlType
Win32_SerialPortConfiguration.SettingID
Win32_SerialPortConfiguration.StopBits
Win32_SerialPortConfiguration.XOffCharacter
Win32_SerialPortConfiguration.XOffXMitThreshold
Win32_SerialPortConfiguration.XOnCharacter
Win32_SerialPortConfiguration.XOnXMitThreshold
Win32_SerialPortConfiguration.XOnXOffInFlowControl
Win32_SerialPortConfiguration.XOnXOffOutFlowControl

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_SerialPortConfiguration ' reference for C# and VB.NET

MOF Reference

Class properties: