SDK Home Glossary Index Left Right Up

CommConfig Class

Section contents

Overview

Defined in

ccomms.oxh

Description

CommConfig represents the confifuration details of a serial port.

Construction / destruction

NewServConfigV01 - Constructor

Usage

this& = NewCommConfig&:

Description

Creates a comm object and returns a handle which allows the object to be manipulated.

Return Value
this& An value which represents the created CommConfig object
Error Handling

If the object could not be created then an error is generated which should be trapped by an ONERR handler.

Example
  LOCAL this&

  this& = NewCommConfig&:
  DeleteCommConfig:(this&)

DeleteCommConfig - Destructor

Usage

DeleteCommConfig:(BYREF this&)

Description

Destroys the CommConfig object.

Arguments
BYREF this& A handle to a CommConfig object
Example
  LOCAL this&

  this& = NewCommConfig&:()
  DeleteCommConfig:(this&)

Methods provided

CommConfigDataBits - Get number of Data Bits

Usage

bits% = CommConfigDataBits%:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
bits% The number of data bits
See Also

CommConfigSetDataBits

CommConfigFIFO - Get FIFO Status

Usage

status% = CommConfigFIFO%:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
status% The FIFO status
See Also

CommConfigSetFIFO

CommConfigHandshake - Get Handshaking Control

Usage

handshake& = CommConfigHandshake&:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
handshake& The handshaking control
See Also

CommConfigSetHandshake

CommConfigParity - Get Parity Type

Usage

parity% = CommConfigParity%:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
parity% The parity type
See Also

CommConfigParity, CommConfigParityError, CommConfigParityErrorChar, CommConfigSetParity

CommConfigParityError - Get Parity Error

Usage

error& = CommConfigParityError&:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
error& The parity error
See Also

CommConfigParity, CommConfigParityError, CommConfigParityErrorChar, CommConfigSetParityError

CommConfigParityErrorChar - Get Parity Error Character

Usage

char% = CommConfigParityErrorChar%:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
char% Character used to replace those received with a parity error with when iParityError is set to KConfigParityErrorReplaceChar
See Also

CommConfigParity, CommConfigParityError, CommConfigParityErrorChar, CommConfigSetParityErrorChar

CommConfigRate - Get Data Rate

Usage

rate% = CommConfigRate%:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
rate% The data rate
See Also

CommConfigSetRate

CommConfigSetDataBits - Set Data Bits

Usage

CommConfigSetDataBits:(this&,bits%)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
bits% <TBS>
See Also

CommConfigDataBits

CommConfigSetFIFO - Set FIFO Status

Usage

CommConfigSetFIFO:(this&,status%)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
status% <TBS>
See Also

CommConfigFIFO

CommConfigSetHandshake - Set Handshaking Control

Usage

CommConfigSetHandshake:(this&,handshake&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
handshake& A bitmask of the handshaking control
See Also

CommConfigHandshake

CommConfigSetParity - Set Parity Type

Usage

CommConfigSetParity:(this&,parity%)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
parity% The parity type to set
See Also

CommConfigParity, CommConfigParityError, CommConfigParityErrorChar

CommConfigSetParityError - Set Parity Error

Usage

CommConfigSetParityError:(this&,error&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
error& The parity error to set
See Also

CommConfigParity, CommConfigParityError, CommConfigParityErrorChar

CommConfigSetParityErrorChar - Set Parity Error Character

Usage

CommConfigSetParityErrorChar:(this&,char%)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
char% Character used to replace those received with a parity error with when iParityError is set to KConfigParityErrorReplaceChar
See Also

CommConfigParity, CommConfigParityError, CommConfigParityErrorChar

CommConfigSetRate - Set Data Rate

Usage

CommConfigSetRate:(this&,rate%)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
rate% The data rate
See Also

CommConfigRate

CommConfigSetSIREnable - Set SIR Encoding

Usage

CommConfigSetSIREnable:(this&,bool%)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
bool% Switch the SIR encoding hardware on and off
See Also

CommConfigSIREnable

CommConfigSetSIRSettings - Set SIR Settings

Usage

CommConfigSetSIRSettings:(this&,setting&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
setting& The SIR settings
See Also

CommConfigSIRSettings

CommConfigSetSpecialRate - Set Special rate

Usage

CommConfigSetSpecialRate:(this&,rate&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
rate& Pass though data rate used when iRate is set to EBpsSpecial. The representation used in driver dependent.
See Also

CommConfigSpecialRate

CommConfigSetStopBits - Set StopBits

Usage

CommConfigSetStopBits:(this&,bits%)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
bits% The number of stop bits
See Also

CommConfigStopBits

CommConfigSetTerminator - Set Terminator Character

Usage

CommConfigSetTerminator:(this&,index%,char%)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
index% <TBS>
char% <TBS>
See Also

CommConfigSetTerminatorCount, CommConfigTerminator, CommConfigTerminatorCount

CommConfigSetTerminatorCount - Set number of terminator characters

Usage

CommConfigSetTerminatorCount:(this&,count%)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
count% The number of significant terminators (<= KConfigMaxTerminators%)
See Also

CommConfigSetTerminator, CommConfigTerminator, CommConfigTerminatorCount

CommConfigSetXoffChar - Set XOFF Character

Usage

CommConfigSetXoffChar:(this&,char%)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
char% Character used to signal the transmitter to suspend sending when using XON/XOFF handshaking
See Also

CommConfigXoffChar, CommConfigXonChar, CommConfigSetXonChar

CommConfigSetXonChar - Set XON Character

Usage

CommConfigSetXonChar:(this&,char%)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
char% Character used to signal the transmitter to resume sending when using XON/XOFF handshaking
See Also

CommConfigXoffChar, CommConfigXonChar, CommConfigSetXoffChar

CommConfigSIREnable - Get SIR Encoding

Usage

bool% = CommConfigSIREnable%:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
bool% Switch the SIR encoding hardware on and off
See Also

CommConfigSetSIREnable, CommConfigSetSIRSettings, CommConfigSIREnable

CommConfigSIRSettings - Get SIR Settings

Usage

settings& = CommConfigSIRSettings&:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
settings& The SIR settings
See Also

CommConfigSIREnable, CommConfigSetSIREnable, CommConfigSetSIRSettings

CommConfigSpecialRate - Get special rate

Usage

rate& = CommConfigSpecialRate&:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
rate& Pass though data rate used when iRate is set to EBpsSpecial. The representation used in driver dependent.
See Also

CommConfigSetSpecialRate

CommConfigStopBits - Get number of stop bits

Usage

bits% = CommConfigStopBits%:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
bits% The number of stop bits
See Also

CommConfigSetStopBits

CommConfigTerminator - Get terminator character

Usage

char% = CommConfigTerminator%:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
char% <TBS>
See Also

CommConfigSetTerminator, CommConfigSetTermiantorCount, CommConfigTerminator, CommConfigTerminatorCount

CommConfigTerminatorCount - Get number terminator characters

Usage

count% = CommConfigTerminatorCount%:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
count% The number of significant terminators (<= KConfigMaxTerminators%)
See Also

CommConfigSetTerminator, CommConfigSetTerminatorCount, CommConfigTerminator, CommConfigTerminatorCount

CommConfigXoffChar - Get XOFF character

Usage

char% = CommConfigXoffChar%:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
char% Character used to signal the transmitter to suspend sending when using XON/XOFF handshaking
See Also

CommConfigSetXoffChar, CommConfigSetXonChar, CommConfigXonChar

CommConfigXonChar - Get XON character

Usage

char% = CommConfigXonChar%:(this&)

Description

<TBS>

Arguments
this& A handle to a CommConfig object
Return value
char% Character used to signal the transmitter to resume sending when using XON/XOFF handshaking
See Also

CommConfigSetXoffChar, CommConfigSetXonChar, CommConfigXoffChar

  SDK Home Glossary Index Left Right Up