CLACom Windows Functions by Category


Port Initialization

DisplayPortError * Displays a Window describing why a Port can't be Opened.
InitializePort

Template Procedure for Initializing the Port and the Modem.

InitPort *

Initializes the Communications Port to the correct Baud Rate, Parity, Data Bits, and Stop Bits.

ResetPort *

Shuts Down the Communications Port.

ResetPortHaveID

Restores the Communications port when opened with SetPortHaveID().

SetFlowControl *

Sets Hardware and Software Flow Control Options.

SetPort *

Sets up the Communications Port for use.

SetPortEx *

Sets up the Communications Port for use, with more options.

SetPortHaveID

Used when the Communications Port is already open.

SetPortDebug

Debug version of SetPort(). Writes everything Received and/or Sent to a file.

SetPortExDebug

Debug version of SetPortEx(). Writes everything Received and/or Sent to a file.

* = Available in Lite Version

 

Input Routines

ComGetb *

Retrieves all of the characters from the Communications Port.

ComGetBlock *

Retrieves a Block of characters from the Communications Port.

ComGetBlockCRC

Retrieves a Block of characters from the Communications Port with CRC. Used to verify data integrity.

ComGetc *

Retrieves a Single character from the Communications Port.

ComGetd *

Retrieves a Single character from the Communications Port with time-out.

ComGets *

Retrieves a String of characters up to a specified terminator.

ComGetsTimeOut

Retrieves a String of characters up to a specified terminator, with Time-Out and Carrier Monitoring.

RecvCount *

Returns the Number of Characters in the Receive Buffer.

Rxempty

Checks if any characters are in the Receive Buffer.

WaitForString *

Template Procedure that waits for a specified String to arrive at the Serial Port.

WaitForQueString

Template Procedure that waits for Multiple Strings to arrive at the Serial Port.

WaitForStringCapture

Template Procedure that waits for a specified String to arrive at the Serial Port. Writes all received characters to the Capture File.

* = Available in Lite Version

 

Output Routines

ComPutb *

Sends a buffer of data to the Communications Port.

ComPutbCRC

Sends a buffer of data to the Communications Port with CRC. Used to verify data integrity.

ComPutc *

Sends a single character to the Communications Port.

ComPuts *

Sends a NULL Terminated String to the Communications Port.

ModemPuts *

Sends a NULL Terminated String to the Modem. Interprets embedded Carriage Returns and Delays.

TxFree

Returns the Number of Free Bytes in the Communications Transmit Buffer.

TxUsed

Returns the Number of Bytes in the Communications Transmit Buffer, waiting to be sent.

* = Available in Lite Version

 

Windows Comm Buffer Routines

ClrBuf *

Clears the Communications Receive Buffer and Transmit Buffer.

ClrRecvBuf *

Clears the Communications Receive Buffer.

ClrTransBuf *

Clears the Communications Transmit Buffer.

RecvCount *

Returns the Number of Characters in the Receive Buffer.

Rxempty

Checks if any characters are in the Receive Buffer.

TxFree

Returns the Number of Free Bytes in the Communications Transmit Buffer.

TxUsed

Returns the Number of Bytes in the Communications Transmit Buffer, waiting to be sent.

* = Available in Lite Version

 

File Transfer Routines

DownLoad

Download files using ASCII, Xmodem, and Ymodem.

DownLoadEx

Download files using ASCII, Xmodem, and Ymodem with more options.

GetProtoNum

Translates Protocol as a string to a Number.

GetZmodem

Download files using Zmodem.

GetZmodemEx

Download files using Zmodem with more options.

SendFileWild

Sends files using Ymodem and Zmodem, with Wild Cards.

SendZmodem

Sends files using Zmodem.

SendZmodemEx

Sends files using Zmodem with more options.

SetFileXferOptions

Sets options for the File Transfer Protocols.

SetZmodemXferOptions

Similar to SetFileXferOptions and actually duplicates some of those options. Used to set extra parameters for Zmodem.

UpLoad

Sends Files using ASCII, Xmodem, and Ymodem.

UploadEx

Sends Files using ASCII, Xmodem, and Ymodem with more options.

Not Available in Lite Version

 

Terminal Emulation Routines

CheckIfTermActive

Checks if Terminal Emulator is in use for a specified Port.

CLATermClearScreen

Clears Programmer supplied Terminal Emulator Window.

CLATermClientProc

Handles Client Window Messages for Programmer supplied Terminal Emulator Window.

CLATermDoorWay

Toggles DoorWay Mode On or Off for Programmer supplied Terminal Emulator Window.

CLATermEcho

Toggles KeyBoard Echo On or Off for Programmer supplied Terminal Emulator Window.

CLATermGetMessage

Translates Messages sent to Filter Function for Programmer supplied Terminal Emulator Window.

CLATermHookMsg

Installs a Message Filter Function for 16 Bit Applications.

CLATermPrepareTransfer

Prepares File Transfer Protocols when using Programmer supplied Terminal Emulator Window.

CLATermSetBackColor

Changes the Background color of a Programmer supplied Terminal Emulator Window to Black.

CLATermWndProc

Handles Frame Window Messages for Programmer supplied Terminal Emulator Window.

CreateClaTerm

Invokes the built in Terminal Emulator.

CreateClaTermEx

Invokes the built in Terminal Emulator with more options.

CreateClaTermNoWin

Prepares Terminal Emulation functions to use Programmer Defined Window.

DisplayTermError

Displays a Window describing why a Terminal can't be Created.

SetTermOptions

Configures the Terminal Emulator.

SetTermType

Changes Terminal Emulation Type.

Not Available in Lite Version

 

Modem and UART Control Routines

DialNumber *

Template Procedure for Dialing a Phone Number.

Dtr *

Toggles the DTR line On or Off.

InitializePort

Automatically initializes the Serial Port to the correct Baud Rate, Parity, Data Bits and Stop Bits. In addition, it initializes the attached Modem.

Iscd *

Checks if there is a Carrier.

ModemHangUp *

Disconnects the Modem by turning DTR Off and delaying ½ a second.

ModemInstalled Checks if a Modem or other Device is Attached and Powered On.

ModemPuts *

Sends a NULL Terminated String to the Modem. Interprets embedded Carriage Returns and Delays.

ModemStat *

Retrieves the current Modem Status.

PhoneMonitor

Monitors the Serial Port and Answers the Phone when it Rings.

Rts *

Toggles the RTS line On or Off.

SendBreak

Sends a Break Signal to the Modem.

* = Available in Lite Version

 

Miscellaneous Routines

CenterNonMDIWindow *

Centers a non-MDI or Popup Window within the Client Area of the Application Window.

CheckIfSmallFonts *

Used to determine if a user is using Large or Small Fonts. This allows you to provide Dialog Boxes that display correctly on the user’s computer.

CheckForPrevInstance *

Checks if a Previous Instance of the Program is running. Allows you to restrict your program to a single instance and will make your program the Foreground Window if it is already running.

ComDelay *

Delays for X Number of Clock Ticks.

DelPathFiles

Deletes all the Files in the Specified Path.

EncryptBuf

Encrypts and Decrypts a String Buffer.

GetCRC16

Returns a 16 bit CRC of a Buffer.

GetCRC32

Returns a 32 bit CRC of a Buffer.

GetEnvironmentVar

Returns the value of an Environment Variable.

GetOpenSaveFile

Gets a File to Open or Save As.

GetParentWindow *

Returns the Handle to a Window's top most Parent.

MakeDir

Creates all the Directories in a Directory Tree, not just the last Directory in a Directory that must already exist.

StartAProcess

Runs another CFW Program and returns its Main Window Handle.

StartAProcessWait

Runs another Program and waits for it to complete.

StrHex

Translates a Hex String to a Number.

StrWord *

Finds a sub-string in a string.

* = Available in Lite Version

Thanks for visiting CLACom Communications Software
code development in Dana Point, California