SDK Home Glossary Index Left Right Up

SerialInfo class


Section contents


Overview

Defined in

ccomms.oxh

See Also

CommServerGetPortInfo, CommServerGetPortInfo2


Construction / destruction


NewSerialInfo - Constructor

Usage

this& = NewSerialInfo&:

Description

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

Return Value
this& An value which represents the created 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& = NewSerialInfo&:
  DeleteSerialInfo:(this&) 

DeleteSerialInfo - Destructor

Usage

DeleteSerialInfo:(BYREF this&)

Description

Destroys the serial information object.

Arguments
BYREF this& A handle to a serial information object
Example
  LOCAL this&

  this& = NewSerialInfo&:
  DeleteSerialInfo:(this&) 

Methods provided


SerialInfoDescription

Usage

desc$ = SerialInfoDescription$:(this&)

Description

Get the port description.

Arguments
this& A handle to a serial information object
Return Value
desc$ The full name of the port (KMaxPortDescription% in length). This is used only for user interaction

SerialInfoHighUnit

Usage

unit& = SerialInfoHighUnit&:(this&)

Description

Get the highest unit number supported by the serial module.

Arguments
this& A handle to a serial information object
Return Value
unit& The highest unit number supported by the serial module

SerialInfoLowUnit

Usage

unit& = SerialInfoLowUnit&:(this&)

Description

Get the lowest unit number supported by the serial module.

Arguments
this& A handle to a serial information object
Return Value
unit& The lowest unit number supported by the serial module
Note

The lowest port need not necessarily be numbered zero.


SerialInfoName

Usage

name$ = SerialInfoName$:(this&)

Description

Get the short name of the port.

Arguments
this& A handle to a serial information object
Return Value
name$ The short name of the port (KMaxPortName% in length). This is used in calls to CommOpen
Note

The full name of the serial port (used when opening it) consists of the name returned by SerialInfoName, followed by a double colon separator, followed by the unit number as an ASCII number (for instance COMM::0).


  SDK Home Glossary Index Left Right Up