beautypg.com

Appendix a. api functions – Comtrol API (6508) for the MS-DOS User Manual

Page 21

background image

21

Troubleshooting

This appendix contains reference pages for the RocketPort

API

. Table A-4 lists

all of the

API

functions.

Table A-4. API Function Reference

Function

Description

aaChangeModemState

Changes the state of modem
output lines.

aaClose

Closes a device.

aaEnPeriodicEvent

Enables or disables dispatching of
the periodic event function.

aaExit

Performs cleanup when exiting
from an application program.

aaFlush

Flushes the transmit or receive
buffer, or both for a device.

aaGetCtlStatus

Gets controller status.

aaGetModemStatus

Gets a device’s modem status.

aaGetRxCount

Gets the count of data bytes
available in the receive buffer.

aaGetRxStatus

Gets the status of the device’s
receive buffer.

aaGetTxCount

Gets the count of data bytes in the
transmit buffer waiting to be
transmitted.

aaInit

Executes controller and

API

initialization.

aaInstallCtrlCHandler

Installs a handler for the

CTRL+C

key interrupt.

aaInstallMdmChgEvent

Installs an application level event
function to handle modem change
events.

aaInstallPeriodicEvent

Installs a periodic application
level event function.

aaInstallRxEvent

Installs an application level event
function to handle receive data
available events.

aaOpen

Open a device for reading or
writing, or both.

aaRead

Reads serial data from a device.

aaReadWithStatus

Reads serial data and status from
a device.

aaReconfigure

Reconfigures a device’s
communications parameters.

aaSendBreak

Sends a break signal.

aaSetCloseDelay

Sets the maximum time aaClose()
waits for a device’s transmit buffer
to drain before flushing the
transmit buffer and completing
the close.

aaWrite

Writes serial data out to a device.

EvModemChange*

Modem control input change event
function.

EvPeriodic*

Periodic event function.

EvRxData*

Receive data available event
function.

* These are not part of the

API

, but are part of the

application.

Table A-4. API Function Reference

Function

Description

Appendix A. API Functions