Win32_SerialPortConfiguration, ROOT\CIMV2

Class | Methods | Properties (29) | Qualifiers (5) | Instances (1) | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

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.

Win32_SerialPortConfiguration properties

Win32_SerialPortConfiguration has 29 properties (26 Local, 3 Derived)

NameOriginCIMType
AbortReadWriteOnErrorWin32_SerialPortConfiguration11 [boolean]
BaudRateWin32_SerialPortConfiguration19 [uint32]
BinaryModeEnabledWin32_SerialPortConfiguration11 [boolean]
BitsPerByteWin32_SerialPortConfiguration19 [uint32]
CaptionCIM_Setting8 [string]
ContinueXMitOnXOffWin32_SerialPortConfiguration11 [boolean]
CTSOutflowControlWin32_SerialPortConfiguration11 [boolean]
DescriptionCIM_Setting8 [string]
DiscardNULLBytesWin32_SerialPortConfiguration11 [boolean]
DSROutflowControlWin32_SerialPortConfiguration11 [boolean]
DSRSensitivityWin32_SerialPortConfiguration11 [boolean]
DTRFlowControlTypeWin32_SerialPortConfiguration8 [string]
EOFCharacterWin32_SerialPortConfiguration19 [uint32]
ErrorReplaceCharacterWin32_SerialPortConfiguration19 [uint32]
ErrorReplacementEnabledWin32_SerialPortConfiguration11 [boolean]
EventCharacterWin32_SerialPortConfiguration19 [uint32]
IsBusyWin32_SerialPortConfiguration11 [boolean]
key
Name
Win32_SerialPortConfiguration8 [string]
ParityWin32_SerialPortConfiguration8 [string]
ParityCheckEnabledWin32_SerialPortConfiguration11 [boolean]
RTSFlowControlTypeWin32_SerialPortConfiguration8 [string]
SettingIDCIM_Setting8 [string]
StopBitsWin32_SerialPortConfiguration8 [string]
XOffCharacterWin32_SerialPortConfiguration19 [uint32]
XOffXMitThresholdWin32_SerialPortConfiguration19 [uint32]
XOnCharacterWin32_SerialPortConfiguration19 [uint32]
XOnXMitThresholdWin32_SerialPortConfiguration19 [uint32]
XOnXOffInFlowControlWin32_SerialPortConfiguration19 [uint32]
XOnXOffOutFlowControlWin32_SerialPortConfiguration19 [uint32]

Detailed description of Win32_SerialPortConfiguration properties

Local properties (26) of Win32_SerialPortConfiguration class

AbortReadWriteOnError property
CIMTYPE'boolean'
Description'The AbortReadWriteOnError property indicates whether read and write operations are terminated if an error occurs.
Values: 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.'
MappingStrings['Win32API|Communication Structures|DCB|fAbortOnError']
readTrue
AbortReadWriteOnError property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
BaudRate property
CIMTYPE'uint32'
Description'The BaudRate property indicates the baud (bits per second) rate at which the communications device operates.
Example: 9600'
MappingStrings['Win32API|Communication Structures|DCB|BaudRate']
readTrue
BaudRate property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 4 namespaces
BinaryModeEnabled property
CIMTYPE'boolean'
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.'
MappingStrings['Win32API|Communication Structures|DCB|fBinary']
readTrue
BinaryModeEnabled property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
BitsPerByte property
CIMTYPE'uint32'
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.
Example: 8'
MappingStrings['Win32API|Communication Structures|DCB|ByteSize']
readTrue
BitsPerByte property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 4 namespaces
ContinueXMitOnXOff property
CIMTYPE'boolean'
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.
Values: 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.'
MappingStrings['Win32API|Communication Structures|DCB|fTXContinueOnXoff']
readTrue
ContinueXMitOnXOff property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
CTSOutflowControl property
CIMTYPE'boolean'
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.
Values: TRUE or FALSE. If TRUE, data transmission is suspended until CTS signal is given.'
MappingStrings['Win32API|Communication Structures|DCB|fOutxCtsFlow']
readTrue
CTSOutflowControl property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
DiscardNULLBytes property
CIMTYPE'boolean'
Description'The DiscardNULLBytes property determines whether to discard NULL bytes (characters) when they are received.
Values: TRUE or FALSE. If TRUE, NULL bytes are discarded.'
MappingStrings['Win32API|Communication Structures|DCB|fNull']
readTrue
DiscardNULLBytes property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
DSROutflowControl property
CIMTYPE'boolean'
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.
Values: TRUE or FALSE. If TRUE, DSR data transmission is suspended until DSR signal is given.'
MappingStrings['Win32API|Communication Structures|DCB|fOutxDsrFlow']
readTrue
DSROutflowControl property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
DSRSensitivity property
CIMTYPE'boolean'
Description'The DSRSensitivity property specifies whether the communications driver is sensitive to the state of the DSR signal.
Values: TRUE or FALSE. If TRUE, the driver ignores any bytes received, unless the DSR modem input line is high.'
MappingStrings['Win32API|Communication Structures|DCB|fDsrSensitivity']
readTrue
DSRSensitivity property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
DTRFlowControlType property
CIMTYPE'string'
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.'
MappingStrings['Win32API|Communication Structures|DCB|fDtrControl']
readTrue
ValueMap['Enable', 'Disable', 'Handshake']
Values['Enable', 'Disable', 'Handshake']
DTRFlowControlType property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
EOFCharacter property
CIMTYPE'uint32'
Description'The EOFCharacter property specifies the value of the character used to signal the end of data. .
Example: ^Z'
MappingStrings['Win32API|Communication Structures|DCB|EofChar']
readTrue
EOFCharacter property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
ErrorReplaceCharacter property
CIMTYPE'uint32'
Description'The ErrorReplaceCharacter property specifies the value of the character used to replace bytes received with a parity error.
Example: ^C'
MappingStrings['Win32API|Communication Structures|DCB|ErrorChar']
readTrue
ErrorReplaceCharacter property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
ErrorReplacementEnabled property
CIMTYPE'boolean'
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.'
MappingStrings['Win32API|Communication Structures|DCB|fErrorChar']
readTrue
ErrorReplacementEnabled property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
EventCharacter property
CIMTYPE'uint32'
Description'The EventCharacter specifies the value of the control character that is used to signal an event, such as end of file.
Example: ^e'
MappingStrings['Win32API|Communication Structures|DCB|EvtChar']
readTrue
EventCharacter property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
IsBusy property
CIMTYPE'boolean'
Description'The IsBusy property determines whether the serial port is busy.
Values: TRUE or FALSE. If TRUE, the serial port is busy.'
MappingStrings['Win32API|File Functions|CreateFile']
readTrue
IsBusy property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 4 namespaces
Name property
CIMTYPE'string'
Description'The Name property indicates the name of the Win32 serial port.
Example: COM1'
keyTrue
MappingStrings['Win32Registry|Hardware\DeviceMap\SerialComm']
MaxLen256
readTrue
Name property is in 1046 classes of ROOT\cimv2 and in 142 namespaces
Parity property
CIMTYPE'string'
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.
Example: Even'
MappingStrings['Win32API|Communication Structures|DCB|Parity']
readTrue
ValueMap['None', 'Odd', 'Even', 'Mark', 'Space']
Values['None', 'Odd', 'Even', 'Mark', 'Space']
Parity property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 4 namespaces
ParityCheckEnabled property
CIMTYPE'boolean'
Description'The ParityCheckEnabled property determines whether parity checking is enabled.
Values: TRUE or FALSE. If TRUE, parity checking is enabled.'
MappingStrings['Win32API|Communication Structures|DCB|fParity']
readTrue
ParityCheckEnabled property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
RTSFlowControlType property
CIMTYPE'string'
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:
Disable - RTS is ignored after the first RTS signal is received.
Enable - RTS is left on for the data transfer session.
Handshake - 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.
Toggle - RTS is turned on if there is any data buffered for transmission.
'
readTrue
ValueMap['Enable', 'Disable', 'Handshake', 'Toggle']
Values['Enable', 'Disable', 'Handshake', 'Toggle']
RTSFlowControlType property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
StopBits property
CIMTYPE'string'
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.
Example: 1'
MappingStrings['Win32API|Communication Structures|DCB|StopBits']
readTrue
ValueMap['1', '1.5', '2']
Values['1', '1.5', '2']
StopBits property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 4 namespaces
XOffCharacter property
CIMTYPE'uint32'
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.'
MappingStrings['Win32API|Communication Structures|DCB|XoffChar']
readTrue
XOffCharacter property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 4 namespaces
XOffXMitThreshold property
CIMTYPE'uint32'
Description'The XOffXMitThreshold property specifies the maximum number of bytes allowed in the input buffer before the XOFF character is sent.'
MappingStrings['Win32API|Communication Structures|DCB|XoffLim']
readTrue
XOffXMitThreshold property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 4 namespaces
XOnCharacter property
CIMTYPE'uint32'
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.'
MappingStrings['Win32API|Communication Structures|DCB|XonChar']
readTrue
XOnCharacter property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 4 namespaces
XOnXMitThreshold property
CIMTYPE'uint32'
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.'
MappingStrings['Win32API|Communication Structures|DCB|XonLim']
readTrue
XOnXMitThreshold property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 4 namespaces
XOnXOffInFlowControl property
CIMTYPE'uint32'
Description'The XOnXOffInFlowControl property specifies whether XON/XOFF flow control is used during reception.
Values 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.'
MappingStrings['Win32API|Communication Structures|DCB|fInX']
readTrue
XOnXOffInFlowControl property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces
XOnXOffOutFlowControl property
CIMTYPE'uint32'
Description'The XOnXOffOutFlowControl specifies whether XON/XOFF flow control is used during transmission.
Values TRUE or FALSE. If TRUE, transmission stops when the XOffCharacter is received and starts again when the XonCharacter is received.'
MappingStrings['Win32API|Communication Structures|DCB|fOutX']
readTrue
XOnXOffOutFlowControl property is in 1 class (Win32_SerialPortConfiguration) of ROOT\cimv2 and in 2 namespaces

Derived properties (3) of Win32_SerialPortConfiguration class

Caption property
CIMTYPE'string'
Description'A short textual description (one-line string) of the CIM_Setting object.'
MaxLen64
readTrue
Caption property is in 1050 classes of ROOT\cimv2 and in 37 namespaces
Description property
CIMTYPE'string'
Description'A textual description of the CIM_Setting object.'
readTrue
Description property is in 1061 classes of ROOT\cimv2 and in 142 namespaces
SettingID property
CIMTYPE'string'
Description'The identifier by which the CIM_Setting object is known.'
MaxLen256
readTrue
SettingID property is in 37 classes of ROOT\cimv2 and in 10 namespaces

Win32_SerialPortConfiguration Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
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.'
dynamicTrue
Locale1033
provider'CIMWin32'
UUID'{8502C4EB-5FBB-11D2-AAC1-006008C78BC7}'

Win32_SerialPortConfiguration System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\cimv2:Win32_SerialPortConfiguration'___SYSTEM8
__NAMESPACE'ROOT\cimv2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_Setting']___SYSTEM8
__PROPERTY_COUNT29___SYSTEM3
__RELPATH'Win32_SerialPortConfiguration'___SYSTEM8
__DYNASTY'CIM_Setting'___SYSTEM8
__SUPERCLASS'CIM_Setting'___SYSTEM8
__CLASS'Win32_SerialPortConfiguration'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to Win32_SerialPortConfiguration

Number of classes:19
comments powered by Disqus
online utility - toplist
WUtils.com