CLACom Windows Function Descriptions

Please see Functions By Category to determine which of these functions are available in the Lite version of CLACom.

Template Procedures
CheckForPrevInstance Checks if Application is already running, and if so, activates it and brings it to the foreground.
DialNumber Dials a Phone Number and Connects to a Remote System.
ComGetsTimeOut Similar to ComGets in that it allows you to retrieve a string of characters up a specified Terminator. However it differs in that it stores the Terminator in the string, returns after a specified period of time, and optionally monitors Carrier Detect.
EncryptBuf Encrypts or Decrypts a String Buffer.
GetOpenSaveFile Prompts the user for a file to Open or Save As. In 32 bit Windows, it uses the Enhanced File Open and File Save As Dialog Boxes, which allows for using Long File Names in older versions of Clarion.
InitializePort Automatically initializes the Serial Port to the correct Baud Rate, Parity, Data Bits and Stop Bits. In addition, it initializes the attached Modem.
ModemInstalled Checks the Clear To Send (CTS) signal to determine if a Modem or other Device is attached and powered on.
PhoneMonitor Monitors the Serial Port and Answers the Phone when it Rings.
WaitForString Monitors the Serial Port for a specified String of Characters. Can be used to automate access to remote systems.
WaitForQueString Monitors the Serial Port for Multiple Strings.
WaitForStringCapture Monitors the Serial Port for a specified String of Characters. Writes all received characters to the Capture File.
 
Library Function Descriptions
CapPutc Writes a single character to the Capture File.
CapPuts Writes a NULL Terminated String to the Capture File.
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 and prevents more than one Instance from running at the same time.
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.
ClrBuf Clears the Communications Receive Buffer and Transmit Buffer.
ClrRecvBuf Clears the Communications Receive Buffer.
ClrTransBuf Clears the Communications Transmit Buffer.
ComDelay Delays for X Number of Clock Ticks.
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.
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.
ComPutb Sends a buffer of data to the Communications Port.
ComPutbCRC Sends a buffer of data to the Communications Port with CRC.
ComPutc Sends a single character to the Communications Port.
ComPuts Sends a NULL Terminated String to the Communications Port.
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.
DebugFileOpen Allows you to track down File Open Errors when Sending or Receiving Files.
DelPathFiles Deletes all the Files in the Specified Path
DialNumber Template Procedure for Dialing a Phone Number.
DisplayErrors Displays a Window showing Serial Port Errors, if any.
DisplayPortError Displays a Window describing why a Port can't be Opened.
DisplayTermError Displays a Window describing why a Terminal can't be Created.
DownLoad Download files using ASCII, Xmodem, and Ymodem.
DownLoadEx Download files using ASCII, Xmodem, and Ymodem with more options.
Dtr Toggles the DTR line On or Off.
EncryptBuf Encrypts and Decrypts a String Buffer.
GetCommParams Returns current Baud Rate, Parity, Data Bits, and Stop Bits
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.
GetProtoNum Translates Protocol as a string to a Number.
GetWindowsPort Returns the Handle to the Communications Port.
GetZmodem Download files using Zmodem.
GetZmodemEx Download files using Zmodem with more options.
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.
Iscd Checks if there is a Carrier.
IsRing Checks if the Phone is Ringing.
MakeDir Creates all the Directories in a Directory Tree.
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.
ModemStat Retrieves the current Modem Status.
PhoneMonitor Monitors the Serial Port and Answers the Phone when it Rings.
RecvCount Returns the Number of Characters in the Receive Buffer.
ResetPort Shuts Down the Communications Port.
ResetPortHaveID Restores the Communications port when opened with SetPortHaveID()
Rts Toggles the RTS line On or Off.
Rxempty Checks if any characters are in the Receive Buffer.
SendBreak Sends a Break Signal to the Modem.
SendFileWild Sends files using Ymodem and Zmodem, with Wild Cards.
SendZmodem Sends files using Zmodem.
SendZmodemEx Sends files using Zmodem with more options.
SetCaptureBuf Turns the Capture Buffer On or Off.
SetCaptureFile Sets the name of the Capture File.
SetFileXferOptions Sets options for the File Transfer Protocols.
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().
SetPortExDebug Debug version of SetPortEx().
SetReceiveNotify Causes WM_COMMNOTIFY Messages to be sent to the specified Window when characters are received.
SetTermOptions Configures the Terminal Emulator.
SetTermType Changes Terminal Emulation Type.
SetZmodemXferOptions Similar to SetFileXferOptions and actually duplicates some of those options. Used to set extra parameters for Zmodem.
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.
SuspendReceiveNotify Suspends Receive Notification to a Window.
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.
UpLoad Sends Files using ASCII, Xmodem, and Ymodem.
UploadEx Sends Files using ASCII, Xmodem, and Ymodem with more options.
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.

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