Copyright: Copyright MicroWerks 1994


 Contents

For Help on Help, Press F1


About MicroLink Command

Displays copyright notice, the release number and the serial number of your registered copy.  To view this information choose Help, then choose About.  Select OK to remove the dialog box.

Related topics:

Becoming a Registered User

License Agreement

Registration Form


Auto Answer Command

To configure MicroLink to automatically answer the phone choose Commands, then choose Auto Answer or select the Auto Answer button from the Tools Bar.

You may cancel at any time by pressing the Escape key or selecting the Cancel button.  Selecting the Background button will minimize MicroLink and enter background processing.


Batch Dial Command

To build a batch dialing list, perform the following steps:

1.	Choose Commands, then choose Batch Dial.

2.	Select the name of the directory records you wish to use by marking the appropriate entries.  When you have finished marking the selections select the Add button.

Alternatively you may drag listings from the Entries and drop them in  the Selected entries window

To remove a file you have added to the Selected list, mark the entries and select the Delete button.

3.	A particular set of listings can be saved for future use using the Save As button.  A dialog box prompting you for the name of the batch dial file will appear.  Enter the name and select OK.  A saved batch dial file can be retrieved using the Load option.

4.	Choose OK to begin the batch dialing process.

Options:

If the Stop on Connection option is selected, the batch dial sequence will terminate after the first successful connection is made.  Otherwise, the sequence will continue until all connections have been made.  The entry is dropped from the batch dial list after a successful connection has been made.

Related topics:

Dial Command


Clear Command

To clear the contents of the scrollback buffer choose Edit, then choose Clear, or select the Clear button from the Tools Bar if so defined.

Related topics:

Copy Command

Copy To Command

Paste Command

Windows Command


Close Command

To close an open capture log file choose Log, then choose Close, or select the Close button from the Tools Bar if defined.

Related topics:

Open Capture Command

Hold Command


Colors

To select the foreground and background colors used in the session window, perform the following steps:

1	Choose Settings, then choose Terminal.

2	After the terminal window is displayed, insure that the ANSI Color Attributes option is not checked.

3.	Choose Preferences Screen and then the OverRide button..

4	Select the colors you want for the foreground and background.

5.	Choose OK to accept the changes.

To save the window settings to MicroLink's initialization file, select the Save Changes checkbox when you exit MicroLink.

Note:

Default colors are only used when the ANSI Color Attributes option is not checked.

Related topic:

Terminal Command


Connect Port

To bypass any modem initialization and open the communications port choose Command then choose Connect Port or select the Connect Port button from the Tools Bar if defined.  Once MicroLink has opened the communications port you will be able to enter modem commands and control the modem directly.


Copy Command

To copy the contents of a marked block to the clipboard, perform the following steps:

1.	Scroll through session buffer to bring the text you want to copy into view.

2.	Using the mouse, move to the upper left hand corner of the block and press and hold the left mouse button down.

3.	Drag the mouse to the lower right hand corner of the block.  The text that appears within the block will become inverted.

4.	Choose Edit, then choose Copy  or select the Copy button from the Tools Bar if defined.

Related topics:

Copy To Command

Clear Command

Paste Command

Paste From Command

Windows Command


Copy to Command

To create a file and copy the contents of a marked block to it, perform the following steps:

1.	Scroll through session buffer to bring the text you want to copy into view.

2.	Using the mouse, move to the upper left hand corner of the block and press and hold the left mouse button down.

3.	Drag the mouse to the lower right hand corner of the block.  The text that appears within the block will become inverted.

4.	Choose Edit, then choose Copy To.

5.	Type or select the name of the file you want to copy to.  If the target directory is not the current directory, either type the directory name in front of the filename, or select the directory from the Directories box.

6.	Choose OK to begin copying to the file.

If the file already exists, MicroLink will display a dialog box giving you the option to cancel the operation or erase the contents of the file.  Selecting OK will instruct MicroLink to destroy the contents of the current file.

Related topics:

Copy Command

Clear Command

Paste Command

Paste From Command

Windows Command


Toolbar

MicroLink 2.0 uses a new custom toolbar.  The toolbar can display buttons with graphics, text or both text and graphics.  The toolbar is scrollable and can be placed on any of the four sides of the client area.  The application comes with a default set of buttons, but these can be modified, or new buttons added, to suit the user.  The graphics on the button, the text, and associated commands can all be defined by the user through the Preferences Tools Command menu option.


Desktop

The main screen of MicroLink 2.0 displays the client area, toolbar, light bar , status bar and the function key bar if so desired.  The appearance and arrangement of the different components can be altered via settings under the following headings:

Preferences Screens  .

Preferences Tools Command

Function Keys Command

Preferences Sound Command

Windows Command


Dial Command

To connect MicroLink to a remote computer choose Commands, then choose Dial or select the Dial button from the Tools Bar if defined.

If MicroLink is unable to properly initialize the modem, dialing will fail.  After the modem initialization completes, MicroLink will display a dialog box indicating the title of the remote computer it is dialing; its phone number; the number of seconds left until MicroLink receives a time-out; the remaining number of times MicroLink will attempt to connect to the remote computer; and the last error that has occurred.

You may cancel at any time by pressing the Escape key or selecting the Cancel button.  Selecting the Background button will minimize MicroLink and enter background processing.

The Skip button will terminate the current dial attempt and will restart the dial process if the remaining attempt count is greater than zero.

Notes:

Since proper initialization takes time, it is recommended that you set the Quick Initialization option, located in the Preferences dialog box.  Without this option the modem will be initialized on every call.

MicroLink does not automatically restore itself on the screen after background processing is complete unless Return From Iconic, located in the Preferences General  dialog box, is turned on.

When MicroLink is not connected to a remote computer the icon is the chain.  Once MicroLink has connected, the icon changes to a modem.

Related topics:

Auto Answer Command

Batch Dial Command

Connect Local Command

Directory Command

Hang Up Command

Preferences Command

Session Command

Windows Command


Directory Command
Phonebook Command

To build a listing of directory entries, perform the following steps:

1.	Choose File, then choose Phonebook.

To Add a record to the directory listing:

2.	Choose Database in the Phonebook and then choose Add.

You will be prompted for the entrys name and phone number.

3.	Choose OK to add the entry to your directory listing.

Note: The new entry will inherit the settings of the currently selected entry.

To Change an entry:

2.	Select the entry to be changed.

3.	Make any necessary changes to the entry, then press Enter.

To Delete an entry:

2.	Select the entry to be deleted.

3.	Select the Delete button.

Note: After selecting an entry, you may select the Dial button to immediately begin the dialing process.

Phonebook settings

The Phone book provides you with several options:

1.	Multiple phone numbers:  Up to four different phone numbers can be associated with an entry.  When Dial is selcted, Microlink will attempt to dial all existing numbers in sequence, unless the number is explicitly disabled by checking the Disabled box.

2.	Toolbar,Mouse Profile,Phone Profile,Modem Settings, Function Key Profile:  Specific Toolbar, Mouse Profile, Phone Profile, Modem Settings, and Function Key Profile can be selected for each individual Phonebook entry.  Selecting Default will maintain current global settings.

3.	Terminal Emulation, Keyboard Emulation, File Transfer Protocol:  Specific Terminal Emulation, Keyboard Emulation, File Transfer Protocol must be selected for each individual Phonebook entry.  Global settings will be overridden.

4.	Script Options: The fields displayed in the Scripts screen map into predefined script variables.  A specific Logon script can also be associated with the Phonebook entry.

5.	Statistical information and Notes:  Each Phonebook entry maintains a record of activity, including File Upload/Download, and Call statistics.  Also, personal notes can be stored as part of the Phonebook entry.

Related topics:

Batch Dial Command

Dial Command

Phonebook Short Cut Keys


Disconnect Port Command

To close the communications port choose Commands, then choose Disconnect Port.

Related topics:

Connect Local Command


Exit Command

To close MicroLink and optionally save the current settings and window position to the initialization file choose File, then choose Exit or select the Exit button from the Tools Bar if so defined.

If the Save Changes option has been set, MicroLink will save the window coordinates and all user settings to the initialization file.  MicroLink uses this file to restore itself during startup.

Note:

MicroLink will automatically disconnect if you are connected to a remote computer.


Hang Up Command

To disconnect from the remote computer choose Commands, then choose Hang Up or select the Hang Up button from the Tools Bar if defined.

Note:

If Carrier Detect is enabled, MicroLink automatically performs a hang up once you have logged off from the remote computer and the carrier is lost .

Quick Hangup will drop DTR for 2 seconds and not send out a hang-up modem string.

Note:  some modems will not hang up with this option turned on.

Related topics:

Quick hangup


Hold Command

To temporarily stop/resume the echoing of characters to a capture log file choose Log, then choose Hold or select the Hold button from the Tools Bar if defined.

Related topics:

Open Capture Command


Modem Command

To Install a modem:

1.	Select Add to display the list of available modems.

2.	Highlight the appropriate modem.  If it is not listed, try the AutoSetup option.

3.	Select Install to add modem to the installed modem list.

4.	Select Configure modem if further customization is desired.

To remove a modem:

1.	Highlight the appropriate modem from the installed modem list.

2.	Select Remove.

To automatically configure COM port and modem, select the AutoSetup option.  This will search all COM ports looking for a modem and establish a generic modem string if a modem is detected.

Note: The list of available modems and their setup strings can be accessed in the MODEMS.DAT file.  USE CAUTION WHEN VIEWING!!!

To configure the Modem settings including Modem Type, Line Type, Modem Volume, Initialization String, Carrier Detect Options, COM Driver type, COM Port, Lock Baud Rate, Character Delay, Answer options and Connect message perform the following steps:

1.	Choose Settings, then choose Modem.

2.	Highlight the modem to be configured.

3.	Select Configure Modem.

4.	Modify the available options as required.

5.	Choose OK to accept these changes.

The Initialization String allows the user to modify the predefined init string.

Note:  Selecting the default option will restore the predefined init string based on the MODEMS.DAT file.

The Modem Volume option allows you to adjust the ringer volume or cancel it altogether.

Note:  The modem volume selection will not take effect until a modem init sequence is sent to the modem.

The Carrier Detect option can be turned off, like in the case of direct connects, set to detect signal presence, or set to detect changes in the signal.

The Port/Phone Line section determines the following:

•	The COM Driver option offers a choice of Serial, INT14, or NASI drivers.

Note:  The Serial driver will use the Windows COMM.DRV specified in the SYSTEM.INI.

For more information see ACS Reference

•	The COM Port option allows you to pick the COM port to associate with the modem.

•	The Phone Line option allows the choice between Rotary or Tone dialing.

•	The Lock Baud Rate locks the port speed between the modem and the computer.

Note:  Most modems require this to be selected.

•	The Character Delay option provides an inter character delay while in the modem command state.

Note:  This option is not usually required.  Some high speed modems may require this option when running at baud rates lower than 2400.

The Connect Message option allows you to define the message to be scanned when determining if a connection has been established.

The Answer section determines the following:

•	The number of rings before answering the phone.

•	The Ring Result Code allows the user to modify the ring result code presented by the modem upon an incoming ring.  This is used in conjunction with the Answer Type/Result Code.

Note:  This option can be used with modems supporting the distinctive ring option.

See also:

Common Problems


Open Capture Command

To open an existing or create a new capture log file, perform the following steps:

1.	Choose Log, then choose Open Capture.

2.	Type or select the name of the file you want to log to.  If the target directory is not the current directory, either type the directory name in front of the log name or select the directory in the Directories box.

3.	Select the format option to be used in removing screen format sequences and maintain the display format.

4.	Choose OK to open the capture log file.

If the file already exists MicroLink will display a dialog box giving you the option of canceling the operation, appending the file,  or erasing the contents of the file.  Selecting No when asked to truncate the file will instruct MicroLink to preserve the contents of the selected log file.  Selecting Yes will instruct MicroLink to destroy the contents of the current file.  MicroLink will begin echoing every character received to the selected file.  The Status Bar will be updated to indicate that MicroLink is logging characters to the file.

At any time during capture you may temporarily stop the capture of characters by selecting Hold.  To resume logging select Hold again.  To close the log file permanently, select Close.


Paste Command

To copy the contents of the clipboard to the remote computer choose Edit, then choose Paste or select the Paste button from the Tools Bar if defined.  MicroLink will then begin transmitting the contents of the file to the remote computer.  You may cancel the paste command at any time by pressing the Escape key.

Related topics:

Copy Command

Copy To Command

Clear Command

Paste From Command

Windows Command


Paste from Command

To open a file and copy its contents to the remote computer, perform the following steps:

1.	Choose Edit, then choose Paste From.

2.	Type or select the name of the file you want to paste from.  If the document is not listed in the current directory, either type the directory name in front of the document name, or select the directory in the Directories box.

3.	Choose OK to begin pasting the file.

MicroLink will then begin transmitting the contents of the file to the remote computer.  You may cancel the paste command at any time by pressing the Escape key.

Related topics:

Copy Command

Copy To Command

Clear Command

Paste From Command

Windows Command


Paths Command

To set the default file path and directory used by MicroLink for transferring files, directory files, script files,  log files, and sound events perform the following steps:

1.	Choose Preferences, then choose Paths.

2.	Type the complete pathname including the drive letter, such as "C:\MYSUBDIR", for each pathname option.

3.	Choose OK to accept changes.

To save the path settings to MicroLink's initialization file, select the Save Changes checkbox when you exit MicroLink.

Note:

If necessary MicroLink will automatically attempt to create a subdirectory when verifying the path entered.

Related topics:

Exit Command

Open Log Command

Preferences Command

Receive File Command

Scripts Command

Send File Command


Pause Command

To temporarily stop/resume the recording of commands to a script file, choose Scripts, then choose Pause .  The Status Bar will be updated to indicate that MicroLink is either recording or temporarily paused from recording commands to a script file.

Related topics:

Record Script Command

Stop Command


Port Settings Command

To set the a ports baud rate, data bits, stop bits, flow control and parity, perform the following steps:

1.	Choose Settings, then choose Port Settings.

2.	Select the appropriate baud rate, data bits, stop bits, flow control and parity.

3.	Choose OK to accept changes.

Note: The Port Settings command does not permanently alter the currently selected directory entry.  Permanent changes must be made through the Phonebook..

The Baud Rate group specifies how fast information is transferred through the port.  The maximum port speed that can be selected is a function of the modem and the UART.  High speed modems (>2400) should select at least a baud rate of 19200.

Note:  Do not choose a speed over 19200 unless you have at least a 16550UART,  a DSP modem, or a parallel modem.

Note:  14400 modems do not work with a port speed of 14400!!  Choose 19200 or greater.

Data Bits specifies the number of data bits in each packet of information.

Parity specifies the error-checking method used.

Stop Bits specifies the number of stop bits in each packet of information.

Note:  The most common setting for data bits, parity, and stop bits is 8,N,1.

Flow Control specifies the method used to control the transmission, or flow,  of data.

Note:  Flow control is required for data communication greater than 2400.  Most high speed modems use hardware flow control.

The Lock Baud Rate option indicates whether MicroLink should modify the connection speed between the computer and the modem.  This option should be enabled when using modems that can connect at baud rates that are not supported by Windows.  For example, several US Robotics modems can connect at baud rates of 14,400.  To support a modem at this speed, set the baud rate to 19,200 and enable the Lock Baud Rate option.

The Carrier Detect option indicates whether MicroLink should automatically delete the loss of carrier to automatically perform a hang up.

Note:

It is important that these settings are correct.  It is recommended that you refer to the manual of your modem to find its maximum baud rate and that you verify the settings of the remote computer.  If these settings are incorrect, a Receiving Framing error may occur.

Related topics:

Exit Command

Directory Command

Windows Command


Print Command

To print the current screen or the entire scrollback buffer, perform the following steps:

1.	Choose File, then choose Print or select the Print button from the Tools Bar if defined.

2.	Select either All, Current Screen.

3.	Choose OK to begin printing.

If header and/or footer customization is desired, the following map sequences are supported:

Sequence	Meaning

%c	Center anything following this sequence

%n	Replace sequence with current selected Phonebook entry name.

%d	Replace sequence with the current date.

%t	Replace sequence with the current time.

%p	Replace sequence with the current page number.

To print a selected block of text, perform the following steps:

1.	Scroll through the session buffer to bring the text you want to copy into view.

2.	Using the mouse, move to the upper left hand corner of the block and press and hold the left mouse button down.

3.	Drag the mouse to the lower right hand corner of the block.  The text that appears within the block will become inverted.

4.	Choose File, then choose Print or select the Print button from the Tools Bar.  The Selected Text option will be selected by default.

5.	Choose OK to begin printing.

Note:

You may cancel the print command at any time by pressing the Escape key.

Related topics:

Printer Setup Command


Printer Setup Commad
Printer Setup Command

To select the default printer used by MicroLink and configure the printer's settings, perform the following steps:

1.	Choose File, then choose Printer Setup.

2.	Select the printer MicroLink will use.

3.	Push the Setup button if the printer's settings need to be altered.

4.	Choose OK to accept changes.

Related topic:

Print Command


Receive File Command

To receive a file from the remote computer, perform the following steps:

1.	Choose Commands, then choose Receive File or  select the Receive button from the Tools Bar if defined.

2.	If  the Prompts option under Preferences General is selected you will be prompted for the protocol you want to use.  Otherwise the File Selection dialog will appear.

3.	For ASCII, X-Modem, Y-Modem :  a single file can be selected for transfer.

4.	For all others, the file names are transferred in the packets by the sending party.

5.	Choose OK to begin receiving the file(s).

You may cancel sending the file at any time by pressing the Escape key or selecting the Cancel button.  Selecting the Background button will minimize MicroLink and enter background processing.

Notes:

Z-Modem and CIS-B support Auto downloading.  If this option is selected, the receive process will start automatically when the sender initiates the file transfer.

Related topics:

Paths Command

Preferences General

Receive File Command

Transfer Protocols

ZModem


Record Script Command

To open a file or creates a new file and logs all commands to it, perform the following steps:

1.	Choose Scripts, then choose Record.

2.	Type or select the name of the file you want to open or create.

3.	Choose OK to begin creating the script file.

If the file already exists, MicroLink will display a dialog box giving you the option to cancel the operation or erase the contents of the file.  Selecting OK will instruct MicroLink to destroy the contents of the current file.  MicroLink will begin to echo commands into the script file.

At any time during recording you may temporarily pause the recording of commands by selecting Pause.  To resume recording select Pause again.  To close the script file permanently, select Stop.

Note:  The Script Recorder should be started before the dial command is selected when creating a Logon script.


Save Configuration Command

To save the current settings and window position to the initialization file choose File, then choose Save Configuration.

Related topics:

Exit Command


Scripts Command

To set the Script buttons that appear on the Tool Bar, perform the following steps:

1.	Enter the Script filename or select the Script button to display a listing of available scripts.

Script files must reside in the default script directory.

2.	Choose OK to accept changes.

Buttons that are not enabled will appear dimmed.

To save the scripts settings to MicroLink's initialization file, select the Save Changes checkbox when you exit MicroLink.

Note:

The Tool Bar is designed to automatically wrap the buttons and expand the height of the Tool Bar to ensure that every button is visible on the screen.  As a result, the session window may become reduced in size.  If this is undesirable, either expand the size of the application window or reduce the number of buttons that appear on the Tool Bar.

Related topics:

Exit Command

Record Script Command

Paths Command

Windows Command


Script Editor Command

To open a Script Editor Window choose Scripts, then choose Script Editor.  The Script Editor allows you to create script files or edit scripts files that were automatically created by the Record Script command.

Note:

Currently this command invokes the Windows Notepad.  This could be changed to a different editor by modifying the EDITOR parameter in the MLINK.INI file.

Related topics:

Record Script Command

Pause Command

Stop Command

Scripts Command


Send File Command

To send a file to the remote computer, perform the following steps:

1.	Choose Commands, then choose Send File .

2.	If  the Prompts option uder Preferences General is selected you will be prompted for the protocol you want to use.  Otherwise the File Selection dialog will appear.

3.	For ASCII, X-Modem, Y-Modem :  a single file can be selected for transfer.

4.	For all others, multiple files can be selected by highlighting the file name and pressing Add.  This will add the name to the Selected File List.

5.	Choose OK to begin sending the file(s).

You may cancel sending the file at any time by pressing the Escape key or selecting the Cancel button.  Selecting the Background button will minimize MicroLink and enter background processing.

Related topics:

Paths Command

Receive File Command

ZModem

Transfer Protocols


Session Command

To set the Session settings including the Session Title, Phone Number and Logon Script, and current Logon variables perform the following steps:

1.	Choose Settings, then choose Session.

2.	Enter the Session Title and Phone Number.

3.	Enter the Logon Script filename or select the Browse button to display a listing of available scripts.

4.	Choose OK to accept these changes.

The maximum number of characters for the Title is 25.

The maximum number of characters for the Phone Number is 49.  Special dialing codes such as "*70" for call waiting or "9," for business PBXs, should be entered in the Preferences Calling Profile Command .

The Script Variables VAR1 through VAR3 map into the script variables SESSIONVAR1 through SESSIONVAR3.

The Signon Information fields have corresponding script variables as follows:

•	First Name	SESSIONFIRSTNAME

•	Last Name	SESSIONLASTNAME

•	Password	SESSIONPASSWORD

The Logon Script is the script that is automatically invoked once a connection has been made.  This script file must reside in the default scripts directory.

To save the Session settings to MicroLink's initialization file, select the Save Changes checkbox when you exit MicroLink.

Notes:

None of the text fields allow the tilde character "~", as it is reserved.

These variables do not permanently affect the currently selected Phonebook entry settings.

Related topics:

PhoneBook Menu


Stop Command

To stop the recording of a script file choose Scripts, then choose Stop or select the Stop button from the Tools Bar.  The Status Bar will be updated to indicate that MicroLink has terminated the recording of a script file.

Related topics:

Record Script Command

Pause Command


Terminal Command

To set the Terminal settings including Terminal Type, dimensions, outbound/inbound Carriage Return/Line Feed options, Line Wrap, Destructive Backspace, Fix Screenand Local Echo perform the following steps:

1.	Choose Settings, then choose Terminal.

2.	Select the Terminal Type, Font Name, Font Size and Caret Type.

3.	Enter the scrollback Buffer size in lines, the number of Rows per page, and the Column width.

4.	Select CR->CR+LF options, Local Echo and ANSI Color Attributes.

5.	Choose OK to accept these changes.

The minimum number of lines in the scrollback Buffer is 50 and the maximum is 2000.  The minimum number of Rows per page is 25, the maximum is 50 and the default setting is 25.  The minimum number of Columns per page is 40, the maximum is 240 and the default setting is 80.

If ANSI Color Attributes is set on, MicroLink will translate the colors the remote computer sends through escape sequences.  Disabling ANSI Color Attributes allows you to set the colors for the session window, thereby overriding the remote color sequences.  You can change the default  colors by selecting the Colors button, which will display the colors dialog box.  For more information on setting colors, see the related topic Colors below.

To save the terminal settings to MicroLink's initialization file, select the Save Changes checkbox when you exit MicroLink.

Note:

MicroLink will display every font that resides in your system.   However, the list of available font sizes is a standard one and may not represent the actual font sizes you have in your system.  It is designed to accommodate Adobe Type Manager, Bitstreams FaceLift and True Type, which create fonts on the fly.  As a result, fonts such as terminal may display the same font for various sizes.

Related topics:

Colors Command

Exit Command


Windows Command

To toggle the display of the Status Bar, Tool Bar, and Lights Bar, perform the following steps:

1.	Choose Preferences, then choose Windows.

2.	Check the child windows that you desire to be visible.

3.	Choose OK to accept changes.

The Tools Bar contains a set of push buttons designed to provide mouse accelerators for various commands.  The push buttons that appear are definable via the Tools command.

The Function Key Bar contains a set of push buttons that represent the function keys on your keyboard.  These keys may be programmed via the Function Keys command.

The Lights Bar is a set of indicators about the active port.  IM indicates modem initialization; HS indicates high speed; AA indicates auto answer mode; CD indicates carrier detected; OH indicates off hook; RD indicates receiving data; SD indicates sending data; TR indicates terminal ready; and MR indicates modem ready.

The Session Window displays all incoming characters and, optionally, all outgoing characters.  This window is scrollable, retrieving up to 2,000 lines of previously displayed text.  The choice of typeface, font size and fore- and background colors may be customized via the Terminal command.

To save the window display settings to MicroLink's initialization file, select the Save Changes checkbox when you exit MicroLink.

Related topics:

Exit Command


Zmodem

The Send Options are:

•	Append if File Exists, tells the remote system to append if the file already exists at the remote location.

•	Overwrite if File Exists, tells the remote system to overwrite the file if it already exists at the remote location.

•	Skip if File Exists, tells the remote system to go to the next file if it already exists at the remote location.

The Receive Options are:

•	None, tells the software to use the remote system send options.

•	Append if File Exists, tells the local system to append if the file already exists locally.

•	Overwrite if File Exists, tells the local system to overwrite the file if it already exists locally.

•	Skip if File Exists, tells the local system to go to the next file if it already exists locally.

The File Dates Options are:

•	Maintain Senders, will maintain the update date of the transferred file.

•	Skip if Older, will skip processing the requested file if a more recent local copy exists.

The CRC options are:

•	16 Bit, uses 16 Bit Cyclic Redundancy Check, which reduces the probability of an error going undetected.  It has less overhead and is adequate for most file transfers.

•	32 Bit, uses 32 Bit Cyclic Redundancy Check. which further reduces the probability of an error going undetected, but has more overhead per packet and slows down the transfer process.

The Data Streaming Option improves performance by eliminating the acknowledgement for each data packet.  This option should be turned off when the communication line has a high number of errors.

The Escape CTL Option tells Zmodem to mask all control characters ( 00 - 1F), this is necessary on some UNIX shells.


MicroLink Keys

Key(s)	Function

Alt+1 - 10	Invokes scripts 1 through 10.

Alt+F1	Displays the help index.

Alt+F4	Exits MicroLink and optionally saves changes to the INI file.

Alt+A	Pauses/Continues the recording of commands to a script file.

Alt+B	Invokes the Batch Dialing dialog box.

Alt+C	Closes the open log file.

Alt+D	Connects MicroLink to the remote computer.

Alt+E	Begins the recording of commands to a script file.

Alt+H	Terminates the current session.

Alt+I	Displays the current directory listing dialog box.

Alt+L	Holds or resumes the logging of current session to a file.

Alt+N	Opens the communications port and allow the direct entering of modem commands.

Alt+O	Echoes the current session to a file.

Alt+P	Prints the contents of the screen buffer.

Alt+R	Receives a file from the remote computer.

Alt+S	Sends a file to the remote computer.

Alt+T	Stops the recording of commands to a script file.

Alt+U	Enter Auto Answer Mode.

Alt+X	Exits MicroLink and optionally saves changes to the initialization file..

Ctrl+Ins	Copies selected text onto the clipboard.

Shift+Ins	Pastes text from the clipboard.

Delete	Clears the screen buffer.

Home	Scrolls the session window to the top of the scrollback buffer.

Up Arrow	Scrolls the session window back one line.

Down Arrow	Scrolls the session window forward one line.

Left Arrow	Scrolls the session window left one character.

Right Arrow	Scrolls the session window right one character.

Page Up	Scrolls the session window back one screen.

Page Down	Scrolls the session window forward one screen.

End	Scrolls the session window to the bottom of the scrollback buffer.


Script Reference

Scripts are a set of instructions you can create for MicroLink to follow.  Ranging from very simple to extremely complex, scripts are a short-cut which will save you considerable effort over time.  These mini-programs can be created for most anything, including the automation of a logon process.  Examples of several scripts are provided throughout this chapter.

Script File Name

A script file name can be any valid filename.  The default file extension for a script file is MSL, which stands for MicroWerks Script Language.  An example of a valid script file name is "MYSCRIPT.MSL".

Contents of a Script File

A MSL script, regardless of size, consists of statements, functions and variables.  A statement is a command that specifies the operations which should be performed.  Functions manipulate variables, which store values used during the execution of the script.  It is suggested that you end every script you create with the END statement.

Constants

A constant is a value which will be interpreted literally by MicroLink.  Constants specify actual information, as opposed to information that is contained within a variable and identified by a name.  In the following example, "Hello World" is a string constant.

RPRINT "Hello World"

Character (string) constants can contain any alphanumeric characters and special symbols.  Character constants are enclosed in double quotes.

Numeric constants identify numeric values and can be used in arithmetic operations.  Numeric constants should not be delimited.  If delimiters are used, the numbers will be interpreted as a string.  In the following example, "9" is a numeric constant.

x = 9

Variables

Variables are temporary storage bins for information.  The variables and their contents are released when a script is terminated by a syntax error, a runtime error, or when a script reaches an END statement.  The name you assign to a variable may contain numerics, letters, or the underscore character ("_"), however the first character must a a letter.  The name can be up to 10 characters in length.  Variables can be assigned with either a constant or another variable by using the equal sign "=".   Several statements can also assign data to a variable.  The following examples demonstrate different methods  used to assign a value to a variable.

intro$ = "Hello World"	' Assigned by a constant

first$ = last$	' Assigned by a variable

INPUT "Enter Password:", pw$	' Assigned by a statement

The variable type is determined by its name.  A string variable must end with a dollar sign ($).  In the following example, "Hello World" is stored in a string variable named "intro$".

intro$ = "Hello World"

Strings variables can be concatenated (combined) together using the plus sign (+), as demonstrated in the following example.

hello$ = "Hello "

intro$ = hello$ + "World"

Numeric expressions can be used in mathematical expressions or whenever a numeric value is needed by a statement.  The following examples demonstrate the use of numeric variables.

FOR i = 1 to 10

j = i % 2

IF j = 1	' If so, print "it odd"

RPRINT "Its odd...^M"

ELSE	' otherwise, print "it even"

RPRINT "Its even...^M"

ENDIF

NEXT

The following list shows the symbol used and the calculation performed by each supported mathematical operator

Symbol	Calculation Performed

+	Addition.

-	Subtraction.

*	Multiplication.

/	Division.

%	Modulus.  The modulus operator returns only the 	remainder of the integer division operator.

( )	Used to set the order of operations.

Related topics:

Script Language Glossary


Becoming a registered user

We want to thank you for giving MicroLink a test drive.  Registration is easy and it ensures that we at MicroWerks can continue to develop this and other Windows applications where high performance and ease of use is a top priority.  Accompanying MicroLink is the registration form and license agreement containing all the information you need to make your purchasing decision.

If the License Agreement is unavailable Click Here  to display it.  If the Registration Form is unavailable Click Here .  Next choose File, then choose Print Topic from the help system to print it or choose Edit, then choose Copy to copy it to the clipboard.

Related topics:

About MicroLink Command

License Agreement

Registration Form


Scratchpad

The Scratchpad is used to stack and store information that can be used for uploads, downloads and general cut and paste of text functions in the Microlink work area.  Any information displayed in the list window can be  stored to an internal file and retrieved on demand.

The Send option sends the text displayed in the Current entries area to the modem.

The Add option will bring up a box that will prompt you for the text.

The Browse option brings up a File Open dialog box where the user can select a text file previously built.

The Delete option removes the selected text in the Current entries list.

The Hide option sends the Scratchpad into the background.

The Append CR and Append space options modify the text as it is sent to the modem.

The Flush on send option clears the Current entries list upon sending the stack to the modem.

The Files option brings up File Manager and allows files to be dragged and dropped into the Current entries area.

The Save, Restore and Load buttons apply to Current entries listings.  The text in the list box can be saved to an internal file and later retrieved.

Files can be dragged and dropped into the scratchpad from File Manager.


Manual Dial Command

This option allows you to manually enter the phone number to dial.  After entering the desired number press the Dial button to start dialing.


Chat Mode Command

Puts Microlink in Chat mode.  The screen is split in order to see incoming and outgoing messages simultaneously.  The bottom half corresponds to the sender and the top to the recipient.


Initialize Modem Command

This command sends the initialization strings as defined in the Settings Modem Configure Modem dialog box.

If MicroLink is unable to properly initialize the modem, dialing will fail.  After the modem initialization completes, MicroLink will display a dialog box indicating the title of the remote computer it is dialing; its phone number; the number of seconds left until MicroLink issues a time-out; the remaining number of times MicroLink will attempt to connect to the remote computer; and the last error that has occurred.

You can use the Auto Setup Option under the Settings Modem to have Microlink find the modem and select the port speed.

You may cancel at any time by pressing the Escape key or selecting the Cancel button.  Selecting the Background button will minimize MicroLink and enter background processing.

Related topics:

Dial Command


Transmit Break Command

Forces the transmission line to a logical 0 and holds it there for longer than the time needed to transmit a single character.  It is used to wake up certain types of application specific events.


Exit Host Mode Command

Causes MicroLink to leave Host Mode.  The application reverts to the default screen.  All host connections are terminated.


Enter Host Mode Command

MicroLink starts operating in Host Mode.  All the settings used in the Host Options screen are enabled and calls are received and processed according to the users access level definition.

Note: If a script not found error occurs with this command, make sure the file HOST.MSL is located in the script path directory specified in the Preferences Paths dialog box.

See also:

Paths Command


Host Options Command

The Host Options selection allows you to define the name of the Host, its default access level and the sysop password.  It also determines if the host will act as an open system or if only predefined users can access it.  In the case of an open system, all new callers will be awarded the default access level.  You can also tell Microlink to save a record of Host transactions in the activity log.

The Board Name maps into a script variable called HOSTBOARDNAME.  This is currently specified in the HOST.MSL file.

See also:

Open  Activity Log Command


Host Access Levels Command

The Host Access Levels option defines different access privileges for different types of users.

The Name field displays the user defined name of the access level profile.

The Minutes field allows you to control the maximum duration for a call of this access level.

The Home Dir field determines what directory the caller will be placed in upon connection.

The Upload Dir field displays the directory to which a caller at this level will upload files.

The File Spec field determines what types of files the caller can see.

The Flags options turn different access privileges on or off.  The following are available:

•	Upload files : caller can upload files to the Upload Dir.

•	Download files: caller can download files from the current directory.

•	Page sysop: caller can page the sysop.

•	Sysop functions: caller has sysop privileges and can access Remote Dos Mode..

•	Change directory: caller can change directories.

•	Chat: caller can activate the host computers Chat window.

Note:  This does not activate Chat Mode on the callers computer.

To Add a new level:

1.	Enter the name for the new access level.

2.	Update the Minutes,Home Dir, Upload Dir, File Spec and Flags fields as needed.

3.	Select Add.

To Change an access level:

1.	Highlight the name of the level to be changed in the Access levels list box.

2.	Update the Minutes,Home Dir, Upload Dir, File Spec and Flags fields as needed.

3.	Select Change.

To Delete a level definition:

1.	Highlight the name of the level to be changed in the Access levels list box.

2.	Select Delete.


Host Browse Users Command

The Host Browse Users option will display all the users currently registered in your system. Users can be defined, changed or deleted by selecting the appropriate options.

To add a user:

1.	Select the Add option.

2.	Enter the name information, password, access level, location and phone number.

Note: Location and Phone number are informational.

3.	Select OK.

To change a user:

1.	Highlight the user and select change, or double click the entry.

2.	Modify the information as needed.  If the user has called in before, the User statistics area will show the upload/download ratio, the number of messages left, the number of times the user has called, and the last call date.  Choose the Reset option if you want to zero out the statistical data.

3.	Select OK.

To delete a user:

1.	Highlight the user in the list.

2.	Select the delete option.


Keyboard Command

The MicroLink Keyboard command allows you to remap or redefine most of the keys for each terminal emulation.  To redefine the characters sent by a key ,click on the key and enter the characters you wish to be sent when the key is pressed. If the key is not applicable to the chosen emulation a beep is heard.  Sequences can be entered as ASCII characters, decimal or hex ASCII values.  Each terminal type uses its own key mappings.


Function Keys Command

Used to define the attributes of the function keys F1 through F12 while used in Microlink.  You can define the name of the function key and state if the key will invoke a script, an executable, or if the key will represent text.  Parameters can be established when appropriate.


Transfer Protocols Command

To change the file transfer protocol just before sending and receiving files, select the appropriate protocol, then select OK.  Selecting Cancel will terminate the file transfer.

The individual protocols can be configured by selecting the Configure button.

To save this and other session settings to MicroLink's initialization file, select the Save Changes checkbox when you exit MicroLink.

Note:

This dialog box will be displayed only if prompts is enabled.  To enable prompts check Prompts, located in the Preferences dialog box.

Related topics:

Paths Command

Preferences Command

Receive File Command

Send File Command

Session Command

ZModem Command


Preferences General Command

The Elapsed Time Clock option displays the duration of a successful modem connection.

The Old Style LEDs option will use the LEDs from the previous version of Microlink.

The Return From Iconic option enables MicroLink to automatically restore itself on the screen after background processing is complete.

The Prompts option enables dialog boxes to appear during different operations to provide help and prompt required inputs.

The Toolbar Orientation option determines where the button toolbar will be placed in the application screen.

The Scrollbar option determines whether the  vertical or horizontal scroll bars should be visible

The Initialization options allow you to:

•	Display the Phonebook upon startup.

•	Enable the Persistent Modem Init option, that reinitializes the modem every time a call is made.

•	Display modem commands on the screen as they occur.

•	Scroll Lock On will turn the scroll lock on at startup.  This disables the scrollback buffer until the scroll lock key is toggled off.

The Termination options allow you to:

•	Quick Hangup will drop DTR for 2 seconds and not send out a hang-up modem string.

Note:  some modems will not hang up with this option turned on.

•	Drop DTR CTS on close will drop DTR and CTS when the COM port is closed..

•	Quick Exit will bypass the prompt asking if you want to save any changes that have occurred.

•	Port Closed on Disconnect closes the COM port when there is no phone connection.

The File Transfer Options allow you to:

•	Automatically rename duplicate files.

•	Delete files that were not completely and successfully transmitted.

•	Auto download allows unsolicited Z-Modem and CISB requests to be started.

The Termination Options allow you to:

•	Enable the Quick Hangup option, that terminates calls and releases the line immediately.

•	Enable the Quick Exit option.

•	Close the COM port upon disconnection.

The Redial value indicates the number of times MicroLink will attempt to retry to connect to the remote computer.  The range is from 0 to 99.

The Time-out  value determines the number of seconds MicroLink will wait before aborting a dialing attempt due to an unsuccessful connection.

The Pause  value determines how long MicroLink will wait between dialing attempts.

The Scroll Buffer option allows you to specify the number of lines to be maintained in the scrollback buffer.  Values can range from 50 to 6500.


Preferences Screens Command

To set the  default Font Name and Size and  Caret type perform the following steps:

1.	Choose Preferences, then choose Screen.

2.	Select the Terminal Type, Font Name, Font Size and Caret Type.

5.	Choose OK to accept these changes.

If ANSI Color Attributes is set on, MicroLink will translate the colors the remote computer sends through escape sequences.  Disabling ANSI Color Attributes allows you to set the colors for the session window, thereby overriding the remote color sequences.  You can change the default  colors by selecting the User button, which will display the colors dialog box.  You can also pick the Reverse option to invert the ANSI Color Attributes.For more information on setting colors, see the related topic Colors below.

Note:

MicroLink will display only fixed space fonts.  Proportional fonts are not supported for performance reasons.  Currently the only font shipped with Windows that supports the ANSI draw  characters is the Terminal font.

Related topics:

Colors Command


Preferences Tools Command

This option allows configuration of the button toolbar.

The Current Toolbar window displays the buttons that make up the currently selected toolbar.  These buttons can be reordered by dragging and dropping them within this window, or deleted.

To delete a button in the current toolbar:

1)	Select the button you want to delete.

2)	Select the delete button.

To create a new toolbar:

1)	Select the New option.  The Current Toolbar window will be cleared.

2)	Select a button defined in the Button List window and either drag it into the Current Toolbar window or select the Add option.  The new button is now displayed in the Current Toolbar window.  Repeat the process for as many as 50 buttons.

3)	Choose the Save As option to save the new toolbar configuration.  A Save As dialog box will appear.  Enter the 8 character name that will define the new configuration.  You can have as many different toolbar definitions as you wish.

To load a defined toolbar:

1)	Select the Load option.  A File Open dialog box will appear displaying all the toolbar files in the path.  Select the toolbar you want to load and hit OK.

2)	The selected toolbar member buttons will appear in the Current Toolbar window.  Select OK to exit the configuration dialog and load the toolbar in the MicroLink desktop.

To select icon buttons, text buttons or text & icon buttons:

1)	To select icon only buttons, select the Icons checkbox and deselect the Labels checkbox.

2)	To select text only buttons, deselect the Icons checkbox and select the Labels checkbox.

3)	To select text and icon buttons, select both the Icons checkbox and  the Labels checkbox.

Defining, modifying or deleting a button

To define a button:

1)	The Command list box displays all the available commands that can be associated with a button.  Select the command that you wish.

2)	If the command chosen in 1) requires a parameter, the Parameters edit box will become enabled.

3)	If you want the button to have a caption, enter the desired text in the Display Text box.

4)	To assign an icon to the button, press the Assign Icon button.  This will display the Icon Selection dialog.

4.1)	Type the filename of the icon you want to use or select the Browse option to find the .ICO, .DLL or .EXE file from which you want to extract the icon.  Select OK.

4.2)	The icons in the selected file will appear in the viewer or an error box will be displayed if no icons are available.

4.3)	Select the desired icon.  A highlight box will surround your selection.  Select OK.

5)	The selected icon will appear on the sample button.  Select Done to save the button or select new to save the current one and define another.

6)	The new button will appear in the Button List and can be added to any toolbar.

To modify a button:

1)	Select the button to be modified.  The Modify button will become enabled.  Press it to start the modify process.

2)	Follow the same steps to define a button.

To delete a button:

1)	Select the button to be deleted.  The Delete button will become enabled.  Press it to delete the definition.

Note:  Deleting the button removes its definition from the button database.  It does not remove the reference to it in any toolbars that might contain it.  The toolbars that contain a reference to a deleted button will display a blank button and should be modified to reflect the change.


Preferences Windows Command

To toggle the display of the Status Bar, Tool Bar, Function Bar and Lights Bar, perform the following steps:

1.	Choose Preferences, then choose Windows.

2.	Check the child windows that you desire to be visible.

3.	Choose OK to accept changes.

The Tools Bar contains a set of push buttons designed to provide mouse accelerators for various commands.  The push buttons that appear are definable via the Tools command.

The Function Key Bar contains a set of push buttons that represent the function keys on your keyboard.  These keys may be programmed via the Function Keys command.

The Lights Bar is a set of indicators about the active port.  IM indicates modem initialization; HS indicates high speed; AA indicates auto answer mode; CD indicates carrier detected; OH indicates off hook; RD indicates receiving data; SD indicates sending data; TR indicates terminal ready; and MR indicates modem ready.

The Status Bar displays system time, port settings, script state and log state.  It also displays some help messages.


Preferences Mouse Command

Use the Mouse Preferences option to define and store profiles for mouse operation.  The profile can be assigned a name that represents a particular association of mouse clicks and supported events.

To define a mouse profile:

1.	Select the Add option.  A dialog prompting you for the profile name will appear.  Enter the name of your choice and select OK.

2.	Select either Right or Left mouse button and then select the event that the double click will trigger.  If you want a CR to be appended, select the check box.  Do the same thing for the other button, if needed.

To modify a profile:

1.	Doubleclick on the profile you want to modify.

2.	Follow the procedure under number 2 above.

To delete a profile:

1.	Highlight the profile you want to delete.

2.	Select the Delete option..


Preferences Sound Command

Use the Sound Preferences option to assign sounds to system and application events. You can assign sounds only if you have a sound card installed in your computer. If you don't have a sound card installed, the lists of sounds and events appear dimmed.

Related topic:

Event


Preferences Calling Profile Command

Use this command to define different calling environments that might require different settings such as Area Codes, Dial Prefixes (i.e. disable call waiting), and calling card prefixes and suffixes.

To Add a calling profile:

1.	Select New.

2.	Enter the Profile name.

3.	Complete the information relevant to the profile.

4.	Press OK.

To Modify a profile:

1.	Highlight the Profile you wish to modify.

2.	Select Change.

3.	Follow steps 3 & 4 above.

To Delete a profile:

1.	Highlight the Profile you wish to modify.

2.	Select Delete.


Status Bar

The Status bar displays information about the different menu commands when selected in the menu bar, the current system time, basic communication settings, transfer process and COM port status and, when selected, the duration of an active session.

Related topics:

Preferences Windows Command


Light Bar

The Light Bar is a set of indicators about the active port.  IM indicates modem initialization; HS indicates high speed; AA indicates auto answer mode; CD indicates carrier detected; OH indicates off hook; RD indicates receiving data; SD indicates sending data; TR indicates terminal ready; and MR indicates modem ready.

Related topics:

Preferences Windows Command


AUTOANSWER

Action:	Sets the modem to auto answer mode.

Syntax:	AUTOANSWER

Remarks:	The AUTOANSWER statement sets the modem to auto answer mode.

Example:	The following example uses AUTOANSWER to place the modem into auto answer mode:

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PROTOCOL YMODEMB

SET TITLE "Simple Host Mode"

AUTOANSWER	' Set AA mode

RPRINT "Welcome to my PC^M"

SLEEP 5

RPRINT "Send me the name of the file you want^M"

RINPUT "Enter filename:", file$

RPRINT "^M^M"	' Send 2 CRs

RPRINT "When your ready to receive the file "

RPRINT "using YMODEMB, send me 'OK'^M"

WAITFOR "OK"

RPRINT "Sending file " + file$ + " using YMODEMB^M"

SEND file$

RPRINT "Bye"

HANGUP

END


BEEP

Action:	Makes a sound through the speaker.

Syntax:	BEEP

Remarks:	The BEEP statement makes a sound through the speaker.

Example:	The following example uses BEEP to indicate a successful log on to a remote computer:

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

CLS	' Clear the screen

BEEP	' Log on complete

END


CLEAR

Action:	Clears the display and the contents of the scrollback buffer.

Syntax:	CLEAR

Remarks:	The CLEAR statement clears the display and the contents of the scrollback buffer.

Example:	The following example uses CLEAR to remove the contents of the scrollback buffer:

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

CLEAR	' Clears the buffer

BEEP	' Log on complete

END


CLOSELOG

Action:	Closes the open log file.

Syntax:	CLOSELOG

Remarks:	The CLOSELOG statement closes the open log file.

Example:	The following example uses CLOSELOG to close the log file:

LOG$ = "LOGFILE.LOG"	' Log File Name

OPENLOG LOG$	' Open a log File

HOLDLOG

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

RESUMELOG

REM Keep the script running in background until the BBS

REM ends the session and sends "Goodbye".

WAITFOR "Goodbye"

CLOSELOG

MPRINT "Log File Closed."

END


CLS

Action:	Clears the display.

Syntax:	CLS

Remarks:	The CLS statement clears the display and saves its contents to the scrollback buffer.

Example:	The following example uses CLS to indicate the successful log on to a remote computer:

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

CLS	' Clears the screen

BEEP	' Log on complete

END


DIAL

Action:	Starts the dialing connect process.

Syntax:	DIAL [phonenumber$]

Remarks:	The optional argument phonenumber$ is a string expression that specifies the phone number MicroLink will use when performing a dial command.  If this argument is not supplied, the DIAL statement will use the currently selected Phonebook entry.

Example:	The following example uses DIAL to connect to a remote computer:

ONERROR DialFailed

DIAL "9,123-4567"

SET ERROR OFF

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

MPRINT "Connection Complete!"

END

DialFailed:

MPRINT "Did not connect"

END


END

Action:	Stops a script.

Syntax:	END

Remarks:	The END statement stops script execution, closes all files and returns control to the user.  You can place an END statement anywhere in the script to terminate execution.

Example:	The following script uses the END statement to end script execution:

ONERROR DialFailed

DIAL "9,123-4567"

SET ERROR OFF

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

MPRINT "Connection Complete!"

END

DialFailed:

MPRINT "Did not connect"

END


FOR...NEXT

Action:	Repeats a group of instructions a specified number of times.

Syntax:	FOR counter=start TO end

[statementblock]

NEXT

Remarks:	The FOR statement utilizes the following arguments:

Argument	Description

counter	A numeric variable used as a loop counter.

start	The initial value of the counter.

end	The final value of the loop counter.

A FOR...NEXT loop executes only if start is less than end.  Within the FOR...NEXT loop, the program lines following the FOR statement are executed until the NEXT statement is encountered.  Then the counter is incremented and compared by the final value, end.

Avoid changing the value of counter within the loop.  Changing the value of counter is poor programming practice and can make the program difficult to read and debug.

Example:	The following example uses a FOR...NEXT loop in a script:

FIRST$ = "John"	' First Name

LAST$  = "Doe"	' Last Name

WAITFOR "First Name-> "

RPRINT FIRST$

RPRINT "^M"

WAITFOR "Last Name-> "

RPRINT LAST$

RPRINT "^M"

WAITFOR "Password-> "

INPUT "Enter Password:", PW$	' Get Password

RPRINT PW$

RPRINT "^M"

MPRINT "Log-on Complete!"

SLEEP 10

MPRINT "Finishing Up..."

FOR I = 1 TO 5

WAITFOR "Continue? "	' Wait for 5

RPRINT "^M"	' and send each a CR

NEXT

CLS

MPRINT "All Done..."

END


GOTO

Action:	Branches unconditionally to the specified label.

Syntax:	GOTO label

Remarks:	The GOTO statement provides a way to branch unconditionally to another label.

GOTO cannot branch into a nested level.

Example:	The following example uses the GOTO statement:

FIRST$ = "John"	' First Name

LAST$  = "Doe"	' Last Name

WAITFOR "First Name-> "

RPRINT FIRST$

RPRINT "^M"

WAITFOR "Last Name-> "

RPRINT LAST$

RPRINT "^M"

WAITFOR "Password-> "

INPUT "Enter Password:", PW$	' Get Password

RPRINT PW$

RPRINT "^M"

MPRINT "Log-on Complete!"

SLEEP 10

MPRINT "Finishing Up..."

X = 1

Again:

IF X = 5 THEN

GOTO Done

ENDIF

WAITFOR "Continue? "	' Wait for 5 Continues

MPRINT "^M"	' and send each a CR

X = X + 1

GOTO Again

Done:

CLS

MPRINT "All Done..."

END


HANGUP

Action:	Disconnects the modem and ends an active session.

Syntax:	HANGUP

Remarks:	The HANGUP statement disconnects the modem and ends an active session.

Example:	The following example uses HANGUP to end an active session:

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PROTOCOL YMODEMB

SET TITLE "Simple Host Mode"

AUTOANSWER	' Sets AA mode

RPRINT "Welcome to my PC^M"

SLEEP 5

RPRINT "Send me the name of the file you want^M"

RINPUT "Enter filename:", file$

RPRINT "^M^M"	' Sends 2 CRs

RPRINT "When you are ready to receive the file "

RPRINT "using YMODEMB, send me 'OK'^M"

WAITFOR "OK"

RPRINT "Sending file " + file$ + " using YMODEMB^M"

SEND file$

RPRINT "Bye"

HANGUP

END

Action:	Pauses the logging of text to a file.

Syntax:	HOLDLOG

Remarks:	The HOLDLOG statement pauses the logging of text to a file.

Example:	The following example uses HOLDLOG to pause the logging of text to a file:

LOG$ = "LOGFILE.LOG"	' Log File Name

OPENLOG LOG$	' Open a Log File

HOLDLOG

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

RESUMELOG

REM Keep the script running in background until the BBS

REM ends the session and sends "Goodbye".

WAITFOR "Goodbye"

CLOSELOG

MPRINT "Log File Closed."

END


IF...THEN...ELSE...ENDIF

Action:	Allows conditional execution, or branching, based on the evaluation of a Boolean (true or false) expression.

Syntax1:	IF booleanexpression THEN statement [ELSE statement]

Syntax2:	IF booleanexpression THEN

[statementblock]

[ELSE]

[statementblock]

ENDIF

Remarks:	The argument boolean expression is any expression that evaluates to true (no zero) or false (zero).  If the boolean expression is true the statements following the THEN are executed.  If the boolean expression is false and an ELSE statement exists, the statements that follow the ELSE statement are executed.  The program continues execution following the line after the ENDIF statement.

The single-line form of the statement is best used for short, straightforward tests where only one action is taken.  Otherwise it is recommended that the block form of the statement be used.  Programs that use the block form of the statement are usually easier to read, maintain and debug.

Example:	The following example uses the IF...THEN...ELSE...ENDIF statement:

FIRST$ = "John"	' First Name

LAST$  = "Doe"	' Last Name

WAITFOR "First Name-> "

RPRINT FIRST$

RPRINT "^M"

WAITFOR "Last Name-> "

RPRINT LAST$

RPRINT "^M"

WAITFOR "Password-> "

INPUT "Enter Password:", PW$	' Get Password

RPRINT PW$

RPRINT "^M"

MPRINT "Log-on Complete!"

SLEEP 10

MPRINT "Finishing Up..."

X = 1

Again:

IF X = 5 THEN

GOTO Done

ENDIF

WAITFOR "Continue? "	' Wait for 5 Continues

MPRINT "^M"	' and send each a CR

X = X + 1

GOTO Again

Done:

CLS

MPRINT "All Done..."

END


INPUT

Action:	Displays a dialog box with a given prompt to allow the user to enter an expression from the keyboard and place the results in a specified memory variable.

Syntax:	INPUT stringexpression$, stringID$ [USING SUPPRESS]

Remarks:	The argument stringexpression$ can be any string variable, string constant, or string expression.  It is the prompt message that appears before the input area.  The stringID$ is the name of the string variable where the result of the evaluation is placed.  The optional argument SUPPRESS allows the inputted information to be hidden, replaced only by asterisks (*).

Example:	The following example uses the INPUT statement to accept dynamic input:

FIRST$ = "John"	' First Name

LAST$  = "Doe"	' Last Name

INPUT "Enter Password:", PW$ USING SUPRESS

WAITFOR "First Name-> "

RPRINT FIRST$

RPRINT "^M"

WAITFOR "Last Name-> "

RPRINT LAST$

RPRINT "^M"

WAITFOR "Password-> "

RPRINT PW$

RPRINT "^M"

MPRINT "Log-on Complete!"

CLS

END


LOWER

Action:	Returns a string with all letters in lower case.

Syntax:	LOWER(stringexpression$)

Remarks:	The argument stringexpression$ can be any string variable, string constant, or string expression.  Both the LOWER and UPPER functions are useful when making string comparisons.

Example:	The following example uses the LOWER function to convert a string to lower case:

FIRST$ = "John"	' First Name

LAST$  = "Doe"	' Last Name

INPUT "Enter Password:", PW$ USING SUPRESS

PW$  = LOWER(PW$)

WAITFOR "First Name-> "

RPRINT FIRST$

RPRINT "^M"

WAITFOR "Last Name-> "

RPRINT LAST$

RPRINT "^M"

WAITFOR "Password-> "

RPRINT PW$

RPRINT "^M"

MPRINT "Log-on Complete!"

CLS

END


MPRINT

Action:	Prints text in the Status Bar.

Syntax:	MPRINT strnigexpression$

Remarks:	The argument stringexpression$ can be any string variable, string constant, or string expression.

Example:	The following example uses the MPRINT statement to print text in the Status Bar:

LOG$ = "LOGFILE.LOG"	' Log File Name

OPENLOG LOG$	' Open a log File

HOLDLOG

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

MPRINT "Log File Opened."

RESUMELOG

REM Keep the script running in background until the BBS

REM ends the session and sends "Goodbye".

WAITFOR "Goodbye"

CLOSELOG

MPRINT "Log File Closed."

END


ONERROR

Action:	Branches unconditionally to the specified label whenever a dial, autoanswer, connect, waitfor, waitlist, dosmode, chat, rinput, or openlog error occurs.

Syntax:	ONERROR label

Remarks:	If the SET ERROR statement  is set to OFF, the ONERROR statement will be ignored.

Example:	The following example uses the ONERROR statement to end a script due to a runtime error:

ONERROR DialFailed

DIAL "9,123-4567"

SET ERROR OFF

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

MPRINT "Connection Complete!"

END

DialFailed:

MPRINT "Did not connect"

END


OPENLOG

Action:	Opens a log file.

Syntax:	OPENLOG filename$ [USING OVERWRITE/ APPEND]

Remarks:	The argument filename$ can be any string variable, string constant, or string expression.  If the filename$ is the file name without a path, the opened log command will prefix it with the path specified in the log path setting.  Any opened log files will be closed.

OVERWRITE will destroy the contents of the currently selected log file whereas APPEND will continue adding from the end of the current file.  The default will present an error if the file already exists.

Example:	The following example uses OPENLOG to open a log file:

LOG$ = "LOGFILE.LOG"	' Log File Name

OPENLOG LOG$	' Open a log File

HOLDLOG

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

MPRINT "Log File Opened."

RESUMELOG

REM Keep the script running in background until the BBS

REM ends the session and sends "Goodbye".

WAITFOR "Goodbye"

CLOSELOG

MPRINT "Log File Closed."

END


REM

Action:	Allows explanatory remarks to be inserted in a script.

Syntax1:	REM remark

Syntax2:	' remark

Remarks:	Statements that exist after the REM statement are not executed.  A remark is terminated by a carriage return.

Example:	The following is an example of the use of the REM statement to make a script more readable:

LOG$ = "LOGFILE.LOG"	' Log File Name

OPENLOG LOG$	' Open a log File

HOLDLOG

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

MPRINT "Log File Opened."

RESUMELOG

REM Keep the script running in background until the BBS

REM ends the session and sends "Goodbye".

WAITFOR "Goodbye"

CLOSELOG

MPRINT "Log File Closed."

END


RECEIVE

Action:	Receives a file from the remote computer.

Syntax:	RECEIVE [filename$] [USING protocol]

Remarks:	The argument filename$ is optional when the default file transfer protocol is one which sends the name of the file to be received.  YMODEMB, YMODEMG and ZMODEM protocols are of this type.  The argument filename$ can be any string variable, string constant, or string expression.  If the filename$ is the file name without a path, the receive command will prefix it with the path specified in the receive path setting.

The optional argument protocol can be ASCII, XMODEM, XMODEMCRC, XMODEM1K,  YMODEM, YMODEMB, YMODEMG and ZMODEM.  This argument will modify the default file transfer protocol.  The RECEIVE statement is not case sensitive.

Example:	The following example uses the RECEIVE statement to receive a file from the remote computer:

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PROTOCOL YMODEMB

SET TITLE "Simple Host Mode"

AUTOANSWER	' Sets AA mode

RPRINT "Welcome to my PC^M"

SLEEP 5

RPRINT "Send me the name of the file I need.^M"

RINPUT "Enter filename:", file$

RPRINT "^M^M"	' Sends 2 CRs

RPRINT "When your ready to send the file "

RPRINT "using YMODEMB, send me 'OK'^M"

WAITFOR "OK"

RPRINT "Receiving file " + file$ + " using YMODEMB^M"

RECEIVE file$

RPRINT "Bye"

HANGUP

END

Action:	Resumes the logging of characters to a file.

Syntax:	RESUMELOG

Remarks:	The RESUMELOG statement resumes the logging of characters to a file.

Example:	The following example uses the RESUMELOG statement to resume the logging of characters to a file:

LOG$ = "LOGFILE.LOG"	' Log File Name

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

HOLDLOG

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

MPRINT "Log File Opened."

RESUMELOG

REM Keep the script running in background until the BBS

REM ends the session and sends "Goodbye".

WAITFOR "Goodbye"

CLOSELOG

MPRINT "Log File Closed."

END


RINPUT

Action:	Displays a given prompt to allow the remote user to enter an expression from the keyboard and place the results in a specified variable.

Syntax:	RINPUT stringexpression$, stringID$

Remarks:	The argument stringexpression$ can be any string variable, string constant, or string expression.  It is the prompt message that appears before the input area.  The stringID$ is the name of the string variable where the result of the evaluation is placed.

Example:	The following example uses the INPUT statement to accept dynamic input:

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PROTOCOL ZMODEM

SET TITLE "Simple Host Mode"

AUTOANSWER	' Sets AA mode

RPRINT "Welcome to my PC^M"

SLEEP 5

RPRINT "Send me the name of the file you want^M"

RINPUT "Enter filename:", file$

RPRINT "^M^M"	' Sends 2 CRs

RPRINT "When your ready to receive the file "

RPRINT "using ZMODEM, send me 'OK'^M"

WAITFOR "OK"

RPRINT "Sending file " + file$ + " using ZMODEM^M"

SEND file$

RPRINT "Bye"

HANGUP

END


RPRINT

Action:	Sends text to the remote computer

Syntax:	RPRINT stringexpression$

Remarks:	The argument stringexpression$ can be any string variable, string constant, or string expression.

Example:	The following example uses the RPRINT statement to send text to the remote computer:

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

CLS	' Clears the screen

BEEP	' Log on complete

END


SEND

Action:	Sends a file to the remote computer.

Syntax:	SEND filename$ [USING protocol]

Remarks:	The argument filename$ can be any string variable, string constant, or string expression.  If the filename$ is the file name without a path, the send command will prefix it with the path specified in the send path setting.

The optional argument protocol can be ASCII, XMODEM, XMODEMCRC, XMODEM1K,  YMODEM, YMODEMB, YMODEMG and ZMODEM.  This argument will modify the default file transfer protocol.  The SEND statement is not case sensitive.

Example:	The following example uses the SEND statement to send a file to the remote computer:

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PROTOCOL YMODEMB

SET TITLE "Simple Host Mode"

AUTOANSWER	' Sets AA mode

RPRINT "Welcome to my PC^M"

SLEEP 5

RPRINT "Send me the name of the file you want^M"

RINPUT "Enter filename:", file$

RPRINT "^M^M"	' Sends 2 CRs

RPRINT "When your ready to receive the file "

RPRINT "using YMODEMB, send me 'OK'^M"

WAITFOR "OK"

RPRINT "Sending file " + file$ + " using YMODEMB^M"

SEND file$

RPRINT "Bye"

HANGUP

END


SET BAUDRATE

Action:	Sets the Baud Rate option.

Syntax:	SET BAUDRATE baudrate

Remarks:	The argument baudrate can be 300, 600, 1200, 2400, 4800, 9600 or 19200.

Example:	The following example uses the SET BAUDRATE statement to change the baud rate:

CLS

SET COMPORT COM1

SET BAUDRATE 2400

SET PARITY EVEN

SET DATABITS 7

SET STOPBITS 1

SET FLOWCONTROL NONE

SET CARRIERDETECT ON	' Sets Carrier Detect

SET LOCKBAUDRATE OFF	' Sets Lock Baud Rate

SET PARITYCHECK OFF	' Sets Parity Check

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET CARRIERDETECT

Action:	Sets the Carrier Detect state.

Syntax:	SET CARRIERDETECT state

Remarks:	The argument state can be either ON or OFF.

Example:	The following example uses the SET CARRIERDETECT statement to change the carrier detect state:

CLS

SET COMPORT COM1

SET BAUDRATE 2400

SET PARITY EVEN

SET DATABITS 7

SET STOPBITS 1

SET FLOWCONTROL NONE

SET CARRIERDETECT ON	' Sets Carrier Detect

SET LOCKBAUDRATE OFF	' Sets Lock Baud Rate

SET PARITYCHECK OFF	' Sets Parity Check

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET COMPORT

Action:	Sets the Ports option.

Syntax:	SET COMPORT comport

Remarks:	The argument comport can be COM1, COM2, COM3 or COM4.

Example:	The following example uses the SET COMPORT statement to change the communications port:

CLS

SET COMPORT COM1

SET BAUDRATE 2400

SET PARITY EVEN

SET DATABITS 7

SET STOPBITS 1

SET FLOWCONTROL NONE

SET CARRIERDETECT ON	' Sets Carrier Detect

SET LOCKBAUDRATE OFF	' Sets Lock Baud Rate

SET PARITYCHECK OFF	' Sets Parity Check

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET DATABITS

Action:	Sets the Data Bits option.

Syntax:	SET DATABITS databits

Remarks:	The argument databits can be 6, 7 or 8.

Example:	This following example uses the SET DATABITS statement to change the data bits:

CLS

SET COMPORT COM1

SET BAUDRATE 2400

SET PARITY EVEN

SET DATABITS 7

SET STOPBITS 1

SET FLOWCONTROL NONE

SET CARRIERDETECT ON	' Sets Carrier Detect

SET LOCKBAUDRATE OFF	' Sets Lock Baud Rate

SET PARITYCHECK OFF	' Sets Parity Check

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET ECHO

Action:	Sets the Local Echo state.

Syntax:	SET ECHO state

Remarks:	The argument state can be either ON or OFF.

Example:	The following example uses the SET ECHO statement to change the local echo state:

CLS

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET ERROR

Action:	Sets the Error state.

Syntax:	SET ERROR state

Remarks:	The argument state can be either ON or OFF.

Example:	The following example uses the SET ERROR statement to change the local echo state:

CLS

SET ERROR OFF	' Sets On Error Flag

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

FOR i = 1 to 10

   	DIAL

NEXT

END


SET FLOWCONTROL

Action:	Sets the Flow Control option.

Syntax:	SET FLOWCONTROL flowcontrol

Remarks:	The argument flowcontrol can be NONE, RTS, CTS, XON.  The SET FLOWCONTROL statement is not case sensitive.

Example:	The following example uses the SET FLOWCONTROL statement to change the flow control:

CLS

SET COMPORT COM1

SET BAUDRATE 2400

SET PARITY EVEN

SET DATABITS 7

SET STOPBITS 1

SET FLOWCONTROL NONE

SET CARRIERDETECT ON	' Sets Carrier Detect

SET LOCKBAUDRATE OFF	' Sets Lock Baud Rate

SET PARITYCHECK OFF	' Sets Parity Check

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET INCRLF

Action:	Sets the Inbound CR->CRLF state.

Syntax:	SET INCRLF state

Remarks:	The argument state can be either ON or OFF.

Example:	The following example uses the SET INCRLF statement to change the inbound carriage expands to carriage return plus line feed state:

CLS

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

END


SET LOCKBAUDRATE

Action:	Sets the Lock Baud Rate state.

Syntax:	SET LOCKBAUDRATE state

Remarks:	The argument state can be either ON or OFF.

Example:	The following example uses the SET LOCKBAUDRATE statement to change the lock baud rate state:

CLS

SET COMPORT COM1

SET BAUDRATE 2400

SET PARITY EVEN

SET DATABITS 7

SET STOPBITS 1

SET FLOWCONTROL NONE

SET CARRIERDETECT ON	' Sets Carrier Detect

SET LOCKBAUDRATE OFF	' Sets Lock Baud Rate

SET PARITYCHECK OFF	' Sets Parity Check

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET OUTCRLF

Action:	Sets the Outbound CR->CRLF state.

Syntax:	SET OUTCRLF state

Remarks:	The argument state can be either ON or OFF.

Example:	The following example uses the SET OUTCRLF statement to change the outbound carriage expands to carriage return plus line feed state:

CLS

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

END


SET PARITY

Action:	Sets the Parity.

Syntax:	SET PARITY parity

Remarks:	The argument parity can be NONE, ODD, EVEN, MARK, or SPACE.  The SET PARITY statement is not case sensitive.  The parity setting must match the setting of the remote computer.  Improper parity settings will result in frame errors.

Example:	The following example uses the SET PARITY statement to change the parity:

CLS

SET COMPORT COM1

SET BAUDRATE 2400

SET PARITY EVEN

SET DATABITS 7

SET STOPBITS 1

SET FLOWCONTROL NONE

SET CARRIERDETECT ON	' Sets Carrier Detect

SET LOCKBAUDRATE OFF	' Sets Lock Baud Rate

SET PARITYCHECK OFF	' Sets Parity Check

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END

Action:	Sets the Parity Check state.

Syntax:	SET PARITYCHECK state

Remarks:	The argument state can be either ON or OFF.

Example:	The following example uses the SET PARITYCHECK statement to change the parity check state:

CLS

SET COMPORT COM1

SET BAUDRATE 2400

SET PARITY EVEN

SET DATABITS 7

SET STOPBITS 1

SET FLOWCONTROL NONE

SET CARRIERDETECT ON	' Sets Carrier Detect

SET LOCKBAUDRATE OFF	' Sets Lock Baud Rate

SET PARITYCHECK OFF	' Sets Parity Check

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET PHONENUMBER

Action:	Sets the Phone Number to the specified string.

Syntax:	SET PHONENUMBER phonenumber$

Remarks:	The argument phonenumber$ can be any string variable, string constant, or string expression that passes validation.  Valid strings cannot contain the alpha characters, the tilde "~" character or exceed 25 characters in length.

Example:	The following example uses the SET PHONENUMBER statement to change the phone number used when dialing:

CLS

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET PROTOCOL

Action:	Sets the default File Transfer Protocol.

Syntax:	SET PROTOCOL protocol

Remarks:	The argument protocol can be ASCII, XMODEM, XMODEMCRC, XMODEM1K,  YMODEM, YMODEMB, YMODEMG and ZMODEM.  The SET PROTCOL statement is not case sensitive.

Example:	The following example uses the SET PROTCOL statement to change the default file transfer protocol:

CLS

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET STOPBITS

Action:	Sets the Stop Bits option.

Syntax:	SET DATABITS stopbits

Remarks:	The argument stopbits can be 1 or 2.

Example:	The following example uses the SET STOPBITS statement to change the stop bits:

CLS

SET COMPORT COM1

SET BAUDRATE 2400

SET PARITY EVEN

SET DATABITS 7

SET STOPBITS 1

SET FLOWCONTROL NONE

SET CARRIERDETECT ON	' Sets Carrier Detect

SET LOCKBAUDRATE OFF	' Sets Lock Baud Rate

SET PARITYCHECK OFF	' Sets Parity Check

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET TERMINAL

Action:	Sets the Terminal Type.

Syntax:	SET TERMINAL terminaltype

Remarks:	The argument terminaltype can be ANSI, TTY and VT100.  The SET TERMINAL statement is not case sensitive.

Example:	The following example uses the SET TERMINAL statement to change the terminal type:

CLS

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET TEXTWRAP

Action:	Sets the Text Wrap state.

Syntax:	SET TEXTWRAP state

Remarks:	The argument state can be either ON or OFF.

Example:	The following example uses the SET TEXTWRAP statement to change the text wrap state:

CLS

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL

END


SET TITLE

Action:	Sets the optional Title to the specified string.

Syntax:	SET TITLE title$

Remarks:	The argument title$ can be any string variable, string constant, or string expression that passes validation.  Valid strings cannot contain the tilde "~" character or exceed 25 characters in length.

Example:	The following example uses the SET TITLE statement to change the caption bar:

CLS

SET OUTCRLF OFF	' Sets Outbound CR->LF

SET INCRLF OFF	' Sets Inbound CR->LF

SET ECHO OFF	' Sets Local Echo

SET TEXTWRAP ON	' Sets Text Wrap

SET TERMINAL ANSI

SET PHONENUMBER "9,123-4567"

SET PROTOCOL ZMODEM

SET TITLE "Bill's Computer"

DIAL	' Connects

END


SLEEP

Action:	Suspends the execution of the running script for a specified period of time.

Syntax:	SLEEP seconds

Remarks:	The argument seconds determines the number of seconds to suspend the script.

Example:	The following example uses the SLEEP statement to suspend execution for ten seconds.

CLS

RPRINT "Taking a ten second nap..."

SLEEP 10	' Pause 10 seconds.

RPRINT "Awake!"

END


STRING Function

Action:	Returns the string equivalent of a numeric value.

Syntax:	STRING(numericexpression)

Remarks:	The argument numericexpression can be any numeric variable, numeric constant, or numeric expression.

Example:	The following example uses the STRING function to convert a numeric value to a string:

' Prints the value of i

FOR i = 1 TO 10

output$ = STRING(i)

RPRINT output$ + "^M"

NEXT

END


UPPER Function

Action:	Returns a string with all letters in upper case.

Syntax:	UPPER(stringexpression$)

Remarks:	The argument stringexpression$ can be any string variable, string constant, or string expression.  Both the LOWER and UPPER functions are useful when making string comparisons.

Example:	The following example uses the UPPER function to convert a string to upper case:

FIRST$ = "John"	' First Name

LAST$  = "Doe"	' Last Name

INPUT "Enter Password:", PW$ USING SUPRESS

WAITFOR "First Name-> "

RPRINT FIRST$

RPRINT "^M"

WAITFOR "Last Name-> "

RPRINT LAST$

RPRINT "^M"

WAITFOR "Password-> "

INPUT "Enter Password:", PW$ USING SUPRESS

PW$  = UPPER(PW$)

RPRINT PW$

RPRINT "^M"

MPRINT "Log-on Complete!"

CLS

END


VAL Function

Action:	Returns the numeric value for a string expression.

Syntax:	VAL(stringexpression$)

Remarks:	The argument stringexpression$ can be any string variable, string constant, or string expression.

Example:	The following example uses the VAL function to convert a string to a numeric value

INPUT "Enter a number:", value$

val = VAL(value$)

val = val + 100

RPRINT STRING(VAL)

END


WAITFOR Statement

Action:	Suspends the execution of the running script until a specified string is received from the remote computer.

Syntax:	WAITFOR stringexpression$

Remarks:	The argument stringexpression$ can be any string variable, string constant, or string expression.

Example:	The following example is a log on script that uses the WAITFOR statement:

WAITFOR "Enter FIRST name: "

RPRINT "John^M"	' Send First Name

WAITFOR "Enter LAST name: "

RPRINT "Doe^M"	' Send Last Name

WAITFOR "Enter Password: "

RPRINT "PASSWORD^M"	' Send Password

CLS	' Clear the screen

MPRINT "Log-on Complete!"

BEEP	' Log on complete

END


License Agreement

Copyright © 1991 MicroWerks Co.

All rights reserved

License Agreement

INSTALLATION OF MICROLINK ON YOUR COMPUTER SYSTEM IMPLIES AGREEMENT WITH THE TERMS AND CONDITIONS BELOW.

DISTRIBUTION OF MICROLINK, ITS ACCOMPANY PROGRAMS AND DOCUMENTATION IS CONSIDERED AS IS.  MICROWERKS OFFERS NO WARRANTIES OF ANY KIND, EXPRESSED OR IMPLIED.  THIS INCLUDES, BUT IS IN NO WAY LIMITED TO, WARRANTIES OF MICROLINK'S MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  UNDER NO CIRCUMSTANCES WILL MICROWERKS BE LIABLE FOR ANY DAMAGES WHICH RESULT FROM THE USE OF THIS PROGRAM OR THE INABILITY TO USE IT.  EXCLUSION FROM LIABILITY INCLUDES, BUT IS NOT LIMITED TO, LOST PROFITS, LOST SAVINGS, OR ANY OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES.

MicroLink is distributed as Shareware.  It is not free, freeware, or in the public domain.  You may use MicroLink for a trial period of thirty days, at no cost to you, to determine if it fits your needs. If you decide to use MicroLink regularly, you are expected to register it and pay the applicable registration fee.  Individual copies of the unregistered version of MicroLink may be given to your friends and associates for the same thirty day free trial period.  You may also upload MicroLink to the public section of a public BBS.

You may not modify or dis-assemble MicroLink , nor distribute any modified or dis-assembled versions of MicroLink.  MicroLink may not be included with any other product without written permission from MicroWerks.

Registered copies of MicroLink can be used on more than one computer at a time as long as no more than one of these computers is running MicroLink at the same time. You may make backup copies of MicroLink as necessary for archival purposes only.

U.S. Government RESTRICTED RIGHTS: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subdivision (b)(3)(ii) of the Rights in Technical Data and Computer Software clause at 252.227-7013.


Registration Form

Quantity ________  x $ 35.00    =           $  ________

Shipping (U.S. $4.00, Canada and

  Mexico $6.00, foreign $8.00)              $  ________

Georgia Residents please add 6% sales tax   $  ________

Total                                       $  ________

Please include a Check or Money Order made payable to MicroWerks.

          Diskette size: [  ] 3.5"   [  ] 5.25"

 Name     _______________________________________________

 Company  _______________________________________________

 Address  _______________________________________________

          _______________________________________________

          _______________________________________________

 Phone    _______________________________________________

I have read and agree to abide by the license agreement:

 Signature  _____________________________________________

Where did you get MicroLink?  ___________________________

If you received MicroLink from a BBS, what is its complete name and phone number?___________________________________

_________________________________________________________

Please include any comments or suggestions on the lines which follow.  Use an additional page if necessary.

_________________________________________________________

_________________________________________________________

_________________________________________________________

_________________________________________________________

_________________________________________________________

_________________________________________________________

_________________________________________________________

_________________________________________________________

For information about volume discounts, site  licenses, and technical questions please contact MicroWerks.

Mail this form to:  MicroWerks

                  P.O. Box 768273

                  Roswell, GA 30076-8273


Event

You can assign sounds to different system and application events. For example, you can select a sound to play whenever you start MicroLink. You can also turn sounds and the warning beep on or off.

To assign sounds to events:

1)	In the Preferences menu choose the Sounds option.

2)	In the Action list, select the event that you want to assign a sound to.

3)	In the Files list, select the sound file you want to use. If you do not want to assign a sound to the event, select <None>.

4)	To hear the sound, choose the Test button or double-click the event or filename.

5)	When you are finished, choose the OK button.


Available Commands

This index lists the commands available on the menu bar.

File

Edit

Commands

Host

Settings

Preferences

Scripts

Log

About MicroLink Command


Keyboard and Desktop

Keyboard

MicroLink Keys

Desktop

Desktop

Toolbar

Status Bar

Light Bar

Preferences


Registration

Becoming a registered user

License Agreement

Registration Form


What's new for Microlink 2.0

There are many new features in MicroLink 2.0:

•	A new Directory

•	A new custom Toolbar

•	Customized mouse support.

•	CISV support

•	New keyboard and function mapping facilities

•	.WAV file support

•	An activity log

•	VT52 emulation

•	A chatmode

•	The Scratchpad


Communications

Auto Answer Command

Batch Dial Command

Chat Mode Command

Close Command

Connect Local Command

Dial Command

Disconnect Port Command

Enter Host Mode Command

Exit Command

Exit Host Mode Command

Hang Up Command

Hold Command

Host Options Command

Host Access Levels Command

Host Browse Users Command

Initialize Modem Command

Manual Dial Command

Modem Command

Pause Command

Port Command

Preferences Command

Preferences General Command

Preferences Dial Command

Preferences Calling Profile Command

Receive File Command

Record Script Command

Scripts Command

Script Editor Command

Send File Command

Session Command

Stop Command

Scratchpad

Transfer Protocols Command

Transmit Break Command


PUSH

The PUSH command stores all the environment variables at the time it is invoked.  This allows the script to restore the saved environment at the end of execution.

There is no corresponding Pop command.


EXITPROGRAM

Causes the script to terminate the MicroLink program after disconnecting the phone line.


PAUSE,SLEEP

Used to stop execution for a given number of seconds.

Example:

SLEEP 5


CHAT

Puts MicroLink in chat mode.  This comand locks the screen in chat mode and it stops further execution of the script until the chat mode is manually terminated.


ONDISCONNECT

Action:	Unconditionally branches to the specified label when a disconnect occurs during an online session.

Syntax:	ONDISCONNECT label.


ONUSERTIMEOUT

Action:	Unconditionally branches to the specified label when a user timeout occurs.

See the minutes per call option in the Host Access Levels dialog box.

Syntax:	ONUSERTIMEOUT label


SELECT

Action:	Selects a Phonebook entry.

Syntax:	SELECT string$

Remarks:	The selection process is case sensitive, so the Phonebook entry name must be exactly as it appears in the Phonebook.

Example:	SELECT Microwerks


SET TIMER1, TIMER2, TIMER3

Action:	Allows the start of one of three timers.

Syntax:	SET TIMER1 seconds

Example:	SET TIMER1 30


ONTIMEOUT1, ONTIMEOUT2, ONTIMEOUT3

Action:	Unconditionally branches to the specified label when the specified timer expires.

Syntax:	ONTIMEOUT(1,2,3) label

Example:	SET TIMER1 30	 set timer to 30 seconds

ONTIMEOUT1 AllDone	 go to AllDone label if timer goes for 30 sec+

[loop]

AllDone:

EXIT


WAITLIST, ENDWAITLIST

Action:	Suspends the execution of the running script until one of the specified strings has been received from the remote computer.

Syntax:	WAITLIST string$1,string$2,string$3,string$4,string$5

ENDWAITLIST

Remarks:	The argument string$ can be any string variable, string constant, or string expression.  Up to 5 string variables can be specified.

Use the WAITSELECTION script variable to determine which string was received.

Example:	WAITLIST Connected,No Carrier,Busy

ENDWAITLIST

IF WAITSELECTION = 1 THEN

GOTO Connected

ENDIF

Connected:

......


OPENHOST

Action :	Returns the operational status of host mode.

Remark:	A value of 1 means host mode is on.  A value of 0 means it is off.

Example:	IF OPENHOST = 1 THEN

RPRINT We are in host mode

ENDIF


Errors and Troubleshooting

If you encounter a problem in communications you have many things to consider:

•	Operating procedures

•	The computer, its display and disk drives

•	Modem setup

•	The modem itself

•	Cables to and from the modem

•	Power supplies

•	Phone line and connection quality

•	Problems at the other end of the communications loop

Modem is not working

One of the most common problems with modems is having more than one device on the same COM port (even if the other device is not in use).  This might cause the phone to hang-up as soon as a call is dialed or answered or other unpredictable behaviour.

For an external modem, disconnect the modem and use the DIAL command.  The message Modem initialization failed should be displayed if the modem was in the right COM port.

Modem is dialing too fast

Sometimes a modem will not be able to establish a connection because it is dialing too fast.

Make sure that the communications package is not using Touch Tone dialing on a Pulse system.  This is done by going to the Settings Modem - Configure Modem option and checking the correct option.

Another thing to consider is the possibility that the communications package is dialing the number before it should.  Pauses can be inserted between different sections of the phone number by inserting commas.  For example, the phone number 9,235-6789 causes the communications package to dial the digit 9 followed by a pause followed by the rest of the number.

The time spacing between touch tones can also be a problem in some systems.  Use the Settings Modem command and consider adding the S11=150 parameter to the initialization string.  This will incorporate a slight delay in the dialing of the phone number.

Modem needs resetting

Sometimes the modem will get into a state that prevents it from reacting to any new commands.

The first thing to try is the DIAL command.  This might uncover an incorrect COM port setting.  It also makes several attempts to reset the modem and usually succeeds.

If your modem has a reset button, try it.

If all of the above fail, power down your system and then turn it back on.

In other cases, you may get the modem to respond by issuing one of the reset commands.  First perform the DIRECT CONNECT command and then type one of the following commands:

ATZ[Enter]	Reset the modem and revert to switch settings.

AT&F[Enter]	Reset the modem and revert to factory defaults*.

*Not valid on some modems.

Modem is not connected to the phone line

As strange as it seems, this is a frequent problem.

Check all your connections.  Make sure that the the cable that comes from the wall is connected to the correct jack in the modem.  This jack is usually marked as Line.

Hearing touch tone sounds does not necessarily mean that the modem is connected.  You need to hear a dial tone first!!!

Try a regular phone on the line and listen for the dial tone.  Then, try listening to the dial tone through the modem speaker.  This can be done by issuing the DIAL command.  Make sure that the modem volume is turned on by using the Settings - Modem , Configure modem command.

Modem is not waiting long enough

You may have set your communications package to give up before the remote system has had a chance to answer.

You can determine the delay needed by calling the remote system on a voice line and timing how long it takes between the last digit called and the moment you first hear a whistling sound.

When your application dials, you will notice a countdown indicator in the dial box.  If your communication package quits the process before a connection is made, try increasing the timeout parameter via the Preferences - Dial command.

Wrong number

Make sure that the phone number you are using for the remote site is correct.  Check for special prefixes, specially if it is long distance.  Try dialing the number on a voice line and wait until you hear a whistle tone when the remote modem answers.

See also:

Common Problems


MicroLink 2.0 & Windows

Windows 3.1 and Serial Communications

COM port addresses and IRQs are configurable in the Control Panel: Windows 3.1 allows any prot address and IRQ.  Unlike Windows 3.0, COM3 and COM4 can now be used.

Baud rates:  Windows applications can set speeds higher than 19.2 Kbaud.

16550 UART support for Windows applications: the Windows 3.1 comm driver enables the UART buffer in order to reduce interrupt overhead and improve serial throughput.

Serial ports on the same IRQ can be used in rotation: This is available, although on most PCs serial ports that use the same IRQ cannot be used simultaneously.

How many serial ports does Windows 3.1 support?

The Windows 3.1 communications driver provides access to standard MS-DOS serial ports COM1, COM2, COM3 and COM4.

Base addresses and IRQs for serial ports

Windows must know the base I/O address and interrupt request lines(IRQs) of the serial ports on your PC.  It determines these as follows:

BIOS data area: Windows looks here first for port base addresses.  Most Pcs specify address values here for built in COM ports, but not for add-in adapters.  If Windows finds an address here, it will use it over any other defaults or settings.

Serial ports commonly use the following base I/O address and IRQ values:

Port	Address	IRQ

COM1*	03F8	4

COM2	02F8	3

COM3	03E8	4

COM3(PS2)	3220	3

COM4	02E8	3

*If the BIOS data area specifies COM1 address as 03F8, Windows uses IRQ3 instead.

Control Panel Ports Advanced Dialog

You can tell Windows the addresses and IRQs of ports which are not specified in the BIOS data area using the Control Panel Ports Advanced dialog.  This sets the COMxBase and COMxIRQ values in the [386Enh] section of the SYSTEM.INI file.  IRQ values from 8 to 15 are allowed.  Setting the port address in this mode will not override a BIOS data area value.

Note:  For more information on COMxBase and other SYSTEM.INI switches, see the SYSINI.WRI in your Windows directory.

Using the same IRQ for different serial ports

In general, two devices should not be used simultaneously with the same IRQ.  For example, if your COM1 and COM3 ports both use IRQ 4, then you will have problems if you have a serial mouse on COM1 and a modem on COM3.

Some PCs and serial port adapters support IRQ sharing, the ability to have multiple ports using the same IRQ.  This is common on MicroChannel (MCA) bus architecture Pcs such as the IBM PS2 and EISA bus Pcs.  Windows 3.1 supports IRQ sharing serial adapters.  To use them properly, be sure that you have set the IRQ values correctly using the Control Panel Ports Advanced dialog.  Also, if you do not have an MCA or EISA PC, you must set COMIrqSharing = TRUE in the [386Enh] section of the SYSTEM.INI file.

Using COM 4

Use the Control Panel Ports Advanced dialog to make sure that Windows knows the correct port address value and IRQ settings for your COM4 port.  The address for COM4 is not usually specified in the BIOS data area of most Pcs, since it is not a standard port.

Many serial adapters use a COM4 dafault base address of 02E8.  Unfortunately, this address value conflicts with some peripherals, including 8514/A video adapters and certain network cards.  To work around this problem, reconfigure one of the peripheral adapters to use a different address.  If you change your COM4 address, be sure to use the Control Panel Ports Advanced dialog to reset the address value of  COM4.

What is device contention?

As a multitasking operating system, Windows must handle simultaneous requests for devices, such as COM ports, from different applications.  Device contention refers to the rules that Windows uses to determine how applications receive control of a device.  The 386 Enhanced dialog of the Control Panel allows you to specify how COM ports are to be allocated to applications.

Never warn means that Windows will always provide COM port access to an MS-DOS application, even if it detects that this port may be currently in use by another application.  Some MS-DOS comm applications may leave a serial port in a state that prevents Windows from using its IRQ for other ports.  You can reset the stuck comm IRQ by opening and closing the original COM port with a Windows comm application.

Maximum baud rate for Windows applications

Windows 3.1 allows applications to select baud rates as high as 57.6 Kbaud.  However, how well you can transmit and receive data at high speeds depends on many variables.  With a Windows 3.1 in a minimally busy system, a 19.2 Kbaud Xmodem transfer can run on a 20Mhz 386.

Factors affecting top baud rate in Windows applications include:

♦	CPU speed: Faster CPUs will allow faster throughput with fewer errors.  This is because they allow the comm driver to service character interrupts faster(preventing UART overflow), and allow applications to handle transfer protocols better.

If you are experiencing slow serial performance or are losing characters, try the following to correct the problem:

◊	Reduce the number of MS-DOS drivers and TSRs

◊	Do not load MS-DOS 5+ into upper memory

◊	Add the following line to the SYSTEM.INI file:  FasterModeSwitch = 1 .  For more information on this switch see the SYSINI.WRI file in the Windows directory.

◊	Add or modify the following line in the SYSTEM.INI file:  COMBoostTime = ? .  The ? specifies the amount of time in milliseconds to allow a virtual machine to process a COM interrupt.  If you are losing characters on the screen  try increasing the value (default of 2) to around 5, and work your way up.

♦	Transfer protocols: Data transmission protocols (ie. XMODEM, YMODEM, ZMODEM, etc) vary greatly in a mulltitasking environment.  Some are designed to be very fast, with little error checking, while others trade throughput for error correction.  Usually XMODEM and ZMODEM work well with Windows.

♦	Serial port hardware: Newer serial ports use the 16550 UART, which contains a buffer to reduce the overhead and prevent overflow.

♦	System overhead: The more applications, TSRs and device drivers that are running, the busier the operating system is.  This reduces overall execution time for everybody in the system.  If you have many programs and devices active while attempting to transmit at high speeds, you are likely to see a decrease in performance.

Windows 3.1 and the 16550 UART buffer

Many serial port adapters and add-in modems arenow using the 16550 Universal Asynchronous Receiver Transmitter(UART) which contains a 16 byte character buffer to reduce interrupt overhead and errors during high speed serial transmissions.

You can find out if your serial ports use the 16550 UART by running the Microsoft Diagnostics(MSD.EXE) outside of Windows.

Windows 3.1 does not enable the 16550 buffer for MS-DOS comm applications.


File

Directory Command

Print Command

Printer Setup Command

Save Configuration Command

DOS Mode Command

Exit Command


DOS Mode Command

This command will display a DOS prompt in the Microlink terminal screen.  Full screen DOS commands are not supported, such as EDIT or DOSSHELL.  To exit DOS Mode, enter EXIT at the command prompt or toggle the DOS Mode menu item.

Note: DOS Mode requires the file MWVXD.386 to be added to the SYSTEM.INI in the [386Enhanced] section, as follows:

device=MWVXD.386

The file must also be present in the WINDOWS\SYSTEM directory.


Edit

Copy Command

Paste Command

Clear Command

Copy to Command

Scratchpad


Commands

Dial Command

Batch Dial Command

Manual Dial Command

Auto Answer Command

Hang Up Command

Send File Command

Receive File Command

Chat Mode Command

Connect Port

Disconnect Port Command

Initialize Modem Command

Transmit Break Command


Host

Enter Host Mode Command

Options Command

Access Levels Command

Browse Users Command


Settings

Port  Settings Command

Session Command

Terminal Command

Keyboard Command

Function Keys Command

Transfer Protocols Command

Modem Command


Preferences

General Command

Dial Command

Paths Command

Screens Command

Toolbar Command

Windows Command

Mouse Command

Sound Command

Calling Profile Command


Scripts

Record Script Command

Pause Command

Stop Command

Script Editor Command

Related topics:

Script Language Glossary


Log

Open Capture Command

Close Log Command

Hold Command


Script Language Glossary

This index lists script commands and functions currently available.

AUTOANSWER

BEEP

CHAT

CLEAR

CLOSEACTLOG

CLOSELOG

CLS

DIAL

DOSMODE

END

EXITPROGRAM

FOR...NEXT

GOTO

HANGUP

IF...THEN...ELSE...ENDIF

INPUT

LOWER

MPRINT

ONDISCONNECT

ONERROR

ONTIMEOUT1, ONTIMEOUT2, ONTIMEOUT3

ONUSERTIMEOUT

OPENACTLOG

OPENHOST

OPENLOG

PAUSE,SLEEP

PUSH

REM

RECEIVE

RINPUT

RPRINT

SELECT

SEND

SET BAUDRATE

SET CARRIERDETECT

SET COMPORT

SET DATABITS

SET ECHO

SET ERROR

SET FLOWCONTROL

SET HOST ECHO

SET INCRLF

SET LOCKBAUDRATE

SET OUTCRLF

SET PARITY

SET PHONENUMBER

SET PROTOCOL

SET STOPBITS

SET TERMINAL

SET TEXTWRAP

SET TIMER1, TIMER2, TIMER3

SET TITLE

SLEEP

STRING

UPPER

VAL

WAITLIST, ENDWAITLIST

WAITFOR

WHILE

WRITEACTLOG


PhoneBook Menu
File Menu

Open

Dial

Batch Dial

Print

Set

Accept


Open

This command will create or select a Phonebook database.  The Phonebook file has to reside in the Microlink DIR directory.


Dial

This command will dial the currently selected entry.


Batch Dial

This command will open the Batch Dial selection process.

See also

Batch Dial


Print

This command will print the Phonebook entries names and phone numbers to the local printer.


Set

This command takes the current Phonebook entry settings and applies them to the Microlink global settings.  The Phonebook window will remain on the screen allowing further updates or additions.


Accept

This command takes the current Phonebook entry settings and applies them to the Microlink global settings.  The Phonebook window will not remain on the screen.


View Menu

Expand

Contract

Two Tone


Expand

This command will cause the Phonebook entries to be displayed including all the detailed items, such as Statistics, Script Options ,Keyboard Selection, etc.

See also:

Contract


Contract

This command will cause the Phonebook to display only the top level ID information.

See also:

Expand


Two Tone

For Phonebooks with large number of entries, this option causes the listing to be displayed using alternate colors to ease readability.


Database
Database Menu

Add

Delete


Add

This command adds a new entry to the Phonebook.


Delete

This command deletes the currently selected entry from the Phonebook.


Maintenance
Maintenance Menu

Rebuild

Refresh Stats

Export

Import


Rebuild

This command will rebuild the index structure for the Phonebook database.  This can be used to recover data or to enhance performance of the database during searches.


Refresh Stats

This command will reset all statistical information for the currently selected Phonebook entry, such as Download statistics, Upload statistics, Call connects,etc...


Export

This command will write a text file containing all Phonebook entries names and phone numbers, delimited by commas and quotation marks.


Import

This command will read a text file delimited in the same manner as explained in export. and add them as new entries in the Phonebook.


Phonebook Short Cut Keys

Key(s)	Function

Alt+D	Initiates Phonebook dial using the current entry settings.

Alt+F4	Exits Phonebook

Escape	Toggles the selected entry from expanded to contracted or vice versa.

Enter	Updates the current page of the selected Phonebook entry.

Home	Makes the topmost entry of the current page the current selection.

Page Up	Scrolls the Phonebook one page up.

Page Down	Scrolls the Phonebook one page down.

End	Makes the bottom entry of the current page the current selection.

Ctrl +(any character)	Positions the current selection at the next Phonebook entry starting with the selected character.


Transfer Protocols

Some Notes on File Transfer Protocols

Sending and receiving files is one of the most important capabilities to be handled by a

communications program.  To do so, a connection must  be made between the two

computers.  Then several things are necessary:

1.	The sending computer must know what file is wanted.

2.	The receiving computer must know what name to use when storing it.

3.	The sending computer needs to know when to start sending, and when to pause if it is sending faster than the receiving computer can store the data.

4.	Errors from a bad phone connection should be detected and corrected.

5.	A way must be provided to signal the end of the transmission.

These needs are handled by the file transfer protocol that is chosen.  MicroLink supports

the most popular file transfer protocols, and in most cases, you'll simply choose the most

sophisticated protocol available  on both computers.

ASCII Transfer Protocol

ASCII is the most primitive (in fact, most experts wouldn't consider it a protocol at all)

but it is the most universally available. No error detection is employed (unless you're

using MNP.)  The end of file is signified by a Ctrl-Z character (ASCII 26).  Because

binary files might have Ctrl-Z's and other control characters anywhere, they can't be sent

reliably with ASCII.

Unless the data to be sent is pure text, don't use ASCII. Even for text files, use ASCII

transfers only when no other  protocol is available.

XModem

In XModem transfers, a file is sent in blocks of 132 bytes.  The transfer is started by the

receiver, which sends a NAK character (ASCII 21) at 10-second intervals until the sender

responds with the first block.  Validity checking is done by evaluating the checksum and

the other non-data bytes in the block.

The receiver also expects no more than a 1 second interval between bytes.  If an error is

detected, the receiver sends a NAK and the block may be resent up to 10 times.

Otherwise, an ACK (ASCII 6) is sent to acknowledge correct receipt.  An EOT character

(ASCII 4) instead of another block indicates end of file, and the receiver responds with a

final ACK.  The Ctrl-X character (ASCII 24) between blocks by sender or receiver

requests  cancellation of the transfer.

An XModem Block

1 Byte  SOH (ASCII 1)

1 Byte  Sequence Number  0-255

1 Byte  Complement (255-seq number)

128 Bytes Data

1 Byte  Checksum

XModem CRC

The XModem CRC protocol improves on XModem by using CRC instead of a checksum

 for validity checking.  This provides a much better chance that errors due to a bad phone

line will be caught.  Instead of the initial NAK character(s), the receiving computer sends

"C" until the first block is received.

YModem - XModem 1k

The YModem protocol, sometimes called XModem-1k, is like XModem CRC, but faster

transfers can be achieved (when a phone connection is good) because 1024 bytes of data

are sent per block.  The sender may also use 128 byte blocks, at its discretion.  Blocks

with 1024 bytes have STX (ASCII 2) as the start of block character instead of SOH.

YModem Batch

One (usually insignificant) problem of XModem, XModem CRC, and YModem transfers

is that the file size on the receiving computer is always an even multiple of 128 bytes.

(ASCII zeros are padded onto the end.)   YModem Batch solves this problem and allows

more than one file to be  to be sent in a single transfer by including file name(s) and

size(s) along with the data. After requesting file(s) from the sender, the receiver only

needs to specify the drive and path for local storage.

In batch transfers the initial block number is zero (instead of one) to indicate that it

contains a file name and size.  After each file, another "filename block" is expected.  A

filename block with ASCII zeros instead of a file name indicates the end of the batch.

Because file naming is handled automatically, YModem batch (and G) are well suited for

unattended operation in scripts.

YModem G

These protocols correspond to YModem Batch but can be much faster because the sender

does not wait for an ACK character before sending each block.  In addition, the timing is

relaxed to make it more suitable for use on some transmission links where data is sent in

bursts, with (sometimes) more than one-second intervening delays.

YModem G are the preferred protocols for use with MNP, because MNP does its own

error checking and correcting.  They should not be used otherwise.

To start a YModem G, the receiver sends "G" instead of "C" to say it's ready.

One disadvantage of the "G" protocols is that cancellation (using Ctrl-X) is sometimes

messy.  By the time the sender receives the Ctrl-X, a lot of data may already be in transit.

The receiver may need to ignore several  pages of unintelligible data on the screen before

the sender's menu is redisplayed.

ZModem

The Zmodem protocol  provides reliable file transfer between application programs.

End-To-End data integrity is insured with the CRC16 or CRC32 data verification

schemes. File transfer is simplified with advanced file management features, Automatic

Receiver Transfer (AutoDownload), AutoFile Restart (Crash Recovery), and selective file

transfers.  Binary Data Escape techniques are implemented with a minimum amount of

overhead allowing transfer rates above the Kermit or YModem Batch protocols and

almost as good as YModem G.  Selective buffering and windowing techniques allow

Zmodem to operate on systems that do not support streaming protocols.


Preferences Command

General Command

Paths Command

Screens Command

Toolbar Command

Windows Command

Mouse Command

Sound Command

Calling Profile Command


ACS Reference

Using MicroLink with an ACS

EBIOS/INT14-based ACS Packages

Our testing with INT14-based ACS packages reveals that many of them do not work properly with Microsoft Windows.The most common problem is dropping characters when running at speeds greater than 4800 baud.  This is highly dependent on your hardware and the specific ACS you are using.  Microlink recommends using an NCSI/NASI-based ACS if possible.  If your ACS provides both an INT14 API and a NCSI API, you should use the NCSI API, which is always more efficient.

If you must use an INT14-based ACS, the BUFFER14 utility included with Microlink will help to solve some of these problems.  BUFFER14 is designed to help minimize the switching from protected to real mode when using character-at-a-time INT14 packages with Windows.

The BUFFER14 TSR is designed to be loaded after your INT14 provider TSR is loaded.  The TSR is loaded by typing:

BUFFER14 <Enter> at the DOS prompt.

BUFFER14 can be unloaded by typing

BUFFER14 /U <Enter> at the DOS prompt.

The steps required in order to use BUFFER14 are:

1.	Load your network software.

2.	Load your INT14 ACS provider TSR from the DOS prompt.

3.	Load BUFFER14 from the DOS prompt.

4.	Load DOSHOST (optional - needed only for DOS remote control)

5.	Start Microsoft Windows.

6.	Start Microlink for Windows.

Network Drivers for EBIOS/INT14-based ACS

NDIS or ODI network drivers are highly recommended on the user's workstation for proper operation of EBIOS/INT14-based ACS software on a Novell network with Microlink.  The monolithic (IPX.COM) versions of Novell's drivers do not work well in this configuration.

Using the "Start Connection" Parameter with an ACS

MicroWerk's testing has shown that most ACS products work with "RING" Message, Carrier Detect, or Data Received, but not with Ring Indicator. For most uses, the default option ("RING") will work.

Using Microlink with a LANexpress Server operating as an ACS

In order to dial-out through a LANexpress server, it is necessary to load the NCSI.EXE TSR provided on the LANexpress NCSI Utilities Diskette.

ACS Error Messages

"The specified Port or ACS Server could not be found."

1.	This indicates one of the following:

2.	The specified ACS is not running,

3.	The specified ACS and/or Port doesn't exist,

4.	If using Novell NACS, this may also indicate the specified Port is not available.

Suggestion: Verify your ACS (NCSI/NASI) configuration is correct and that the Server is running.

"The specified Port is not available."

This indicates that the specified port is currently in use or has been disabled.

Suggestion: Reconfigure for another port or try again later.

"Your local ACS driver is not loaded."

This indicates the ACS interface driver included with the ACS product and required to communicate with the ACS is not loaded on your workstation.

NOTE: It is not always possible for MicroLink to determine whether an INT14 driver is loaded because the INT14 API does not support a method to get this information.

Suggestion: This driver must be loaded for Microlink to access the communications server. If you do not have access to this driver, contact your network administrator for access and usage or consult the ACS user guide.

"Your BUFFER14 driver is not loaded."

This indicates the Microlink file BUFFER14.EXE has not  been loaded.  This file is required when Microlink is configured for EBIOS/INT14 communications.

Suggestion: Load BUFFER14.EXE after your local ACS INT14 driver.

"Communications port did not respond."

When using INT14, this error may occur if a COM port was specified that does not exist on the local system.  Use a COM port name that is an existing COM port that is not currently in use by another application.


Common Problems

Data Communications is a very inexact field and is prone to an inordinate number of problems. So by alleviating some of the common problems reported with MicroLink I hope to make your lives a bit easier.

Modem does not work when port speed is set to 14400 - Well this is probably the most common problem reported. And the answer is simple, at least from the Microlink standpoint. Do not set your port speed to 14400. It turns out that most modems, including those 14400 modems, do not support 14400. If you have a 16550 UART then you need to set your port speed to 38400. In Windows the standard COM driver does not work well above 38400 and Receive Overruns will occur.  If you do not have a 16550 UART or do not know what you have then set your port speed to 19200. You can use the Microsoft utility MSD.EXE included with your Windows system to determine the type of UART you have. The common ones are 8250, 16450, or 16550 so look for these numbers under the COM port section.

Receive Overruns are Occurring - Well this is the next most common problem that is reported. This is not as easy as the previous problem. The first thing is to read the previous problem on port speed settings.

If you have this set correctly the next most likely culprit is FLOW CONTROL. Flow control is set in the COM Driver and Flow Control is also set in the Modem. The Flow Control in the COM Driver is easy and we set that for you. But the Flow Control in the Modem is a lot more difficult because it turns out that there are numerous modems which implement the Flow Control command differently. Which means if your modem is not in the list then the chances are that your modem selection is not correct. When this occurs you can either experiment with a different modem until you find one that works of contact us and we will help select the right modem or work at creating an entry for your modem. Currently all modem strings are embedded, but this will be changed for our next version.

Also you should be using Flow Control for all DATA communications over 2400 BPS or if you have V42 or MNP enabled in a slower modem. And it should be Hardware Flow Control (In our case RTS/CTS).

Certain Modems do not handle the speed we initialize them at effectively. They have a tendency to drop off commands at the end of the Command string (Usually the flow control setting). To overcome this problem we have a parameter called XMIT Delay in the Settings/Modem Dialog Box. Place a value of 1 in this box and the initialization and command sequence will slow down enough to satisfy your modem.

And one last instance occurs when you are dialing into MicroLink Host Mode or AutoAnswer Mode with a modem which does not have a V42 or MNP capabilities and the dialing  modem is setup for V42 or MNP.  The V42 and MNP sequences are actually data that is transmitted after a carrier/Connect sequence has take place. Well to a modem which does not support V42 or MNP this data looks like garbage and may result in Receive overruns or some other odd messages. The best thing to do in this situation is have the party dialing into Microlink disable the MNP or V42 support for the duration of the call. Usually the negotiation of the V42 and MNP lasts about 1-3 seconds immediately after the first connect/carrier message.

Screen Paints are Choppy - Well if you are comparing to DOS programs you will find the screen paints are slower and choppier with slower MicroComputers. This is because the Graphical Interface is much slower and has a more difficult time handling the Scrolling process without playing tricks in the repaint routines.

Screen Paints are aligned incorrectly - This is usually the result of the Terminal Number of Rows are out of Sync with the number of Rows on the service that you are using. If the number of rows on the BBS service you are using are set to 25 then make sure the setting in the Settings/Terminal Dialog Box is also 25. Usually there is a menu item on the service you are using for your settings or parameters.

Modem Initialization Error - This error is usually the result of an mismatch in our modem string and the Modem you are using. You can either try selecting another modem in the list and experimenting with this or you can contact us for help. Also if you have added any modem init strings to the Settings/Modem Dialog Box take them out.

ANSI Graphic Characters are not displayed Properly  - If those special characters used to Jazz up the displays on BBS's are not displaying properly this is usually a result of the FONT selection. The only Font distributed with Windows that supports these characters is the Terminal FONT. Therefore if you select any other standard Windows Font you will not see these nice menus and pictures. Please note that the Terminal Font is not a True Type Font so if you have the True Type only enabled in the Window Control Panel Font Selection then you will not see the Terminal Font.

Also note that we only support Fixed Space fonts for efficiency purposes. To properly space Proportional Fonts (Which most fonts unfortunately are) it becomes inefficient in a Windows Communications Environment.

When reporting problems please include the following items:

A file containing your MSD.EXE

A copy of your mlink.ini file

If you are having screen problems I will need a copy of a LOG file of the session you are having problems with or the phone number and access to the system you are having problems with.

I may also ask for a trace file. To start a trace start Microlink as follows from the DOS Prompt in the Mlink Directory:

WIN MLINK *

This will create a file called trace.fle. Perform the sequence in error and after the error occurs shut down Microlink and send the trace to us.

Information can be sent to us using the following methods:

US Mail

Upload to our Support BBS (404-410-9358)

EMAIL to the CIS account for Stephen Leitner, 72510,1766

See also:

Errors and Troubleshooting


Open Activity Log

To Open the Activity log:

1.	Select Log and then Open Activity Log.

2.	Type the file name or select it from the directory listing.

3.	Select OK.

The Activity Log records the following information:

•	All calls to and from Microlink.

•	All file transfers to and from Microlink.

•	All disconnects.

•	All Host Mode user logons.

See also:

Close Activity Log


Close Activity Log

To Close the Activity log:

1.	Select Log and thenClose Activity Log.

See also:

Open Activity Log


WHILE

Action:	Repeats a group of instructions until a specified condition becomes false.

Syntax:	WHILE condition=true

[statementblock]

WEND

Example:	The following example uses a WHILE...WEND loop in a script:

counter = 0

WHILE counter < 5

WAITFOR "Continue? "	' Wait for 5

counter=counter+1

WEND


SET HOST ECHO

Action:	When host echo is on, any character entered by the remote terminal will be echoed back to the terminal from the host computer.

Syntax:	SET HOSTECHO ON/OFF


DOSMODE

Action:	This command will display a DOS prompt ito the remote terminal screen.  A series of eight ^X (CTRL+X)  will allow the remote user to terminate the DOS mode and continue the script.

Remarks:	Note:  the script is paused during execution of the DOS mode.

The DOSMODE script item does not work locally.

Warning:	The remote user has most of the single line DOS commands available so be aware that they can COPY, DELETE, FORMAT, FDISK, etc.. from their remote computer.  USE WITH EXTREME CAUTION!!!!

Syntax:	DOSMODE

Note: DOS Mode requires the file MWVXD.386 to be added to the SYSTEM.INI in the [386Enhanced] section, as follows:

device=MWVXD.386

The file must also be present in the WINDOWS\SYSTEM directory.


OPENACTLOG

Action:	Opens the activity log file.

Syntax:	OPENACTLOG filename$ [USING OVERWRITE/ APPEND]

Remarks:	The argument filename$ can be any string variable, string constant, or string expression.  If the filename$ is the file name without a path, the opened log command will prefix it with the path specified in the log path setting.  Any opened log files will be closed.

OVERWRITE will destroy the contents of the currently selected log file whereas APPEND will continue adding from the end of the current file.  The default will present an error if the file already exists.


CLOSEACTLOG

Action:	Closes the open activity log file.

Syntax:	CLOSEACTLOG

Remarks:	The CLOSEACTLOG statement closes the open activity log file.


WRITEACTLOG

Action:	Writes a user defined message to the activity log.

Syntax:	WRITEACTLOG (string$ [format],[var1,var2,var3....])

Example:	retries = 10

WRITEACTLOG( Number of retries complete= %.,retries)

REM write to the activity log the Number of retries complete= 10.,


SHELL

Action:	Launches the program file specified in the string variable.

Syntax:	SHELL (programname$)

Example:	SHELL(NOTEPAD.EXE)


SYSOPPAGE

Action:	Performs a sound event when selected by a remote terminal in the host script.

Remark: 	The sound event is set in the Preferences Sound Commandoption.

Syntax:	SYSOPPAGE


EXIT

Action:	Exits a FOR or WHILE loop.

Syntax:	EXIT

Example:

FOR I = 1 TO 5

WAITFOR "Continue? "	' Wait for 5

RPRINT "^M"	' and send each a CR

IF I=2 THEN

EXIT	get out if I=2

ENDIF

NEXT


LEN

Action:	Returns the length of a string.

Syntax:	LEN(stringexpression)


MID

Action:	Goes to a specific offset from the beginning of a string and extracts the next n characters.

Syntax:	MID(stringexpression,offset,numberofcharacters)

Example:	string1$ = MID(register now,9,3)     returns now in string1$


LTRIM,RTRIM

Action:	Trims spaces from the left (LTRIM) or right (RTRIM) of a string variable.

Syntax:	LTRIM(stringexpression)

RTRIM(stringexpression)

Example:	string1$ = LTRIM(     register now)     returns register now in string1$


GETTIMER1,GETTIMER2,GETTIMER3

Action:	Returns the current value of the selected timer.

Syntax:	numvar = GETTIMER1


USERUPLOAD,USERDOWNLOAD

Action:	Returns the current upload/download directory as specified in the Host Access Levels Command

Syntax:	string$ = USERUPLOAD


USERSYSOP

Action:	Provides the status of the sysop capabilities as specified in the Host Access Levels Command

Remarks:	A value of 1 means the user is sysop capable.


USERCHDIR

Action:	Provides the status of the directory change capabilities as specified in the Host Access Levels Command

Remarks:	A value of 1 means the user can change directories.


USERCHAT

Action:	Provides the status of the chat capabilities as specified in the Host Access Levels Command

Remarks:	A value of 1 means the user can enter chat mode.


USERPAGE

Action:	Provides the status of the sysop paging capabilities as specified in the Host Access Levels Command

Remarks:	A value of 1 means the user can page the sysop.


USERFILESPEC

Action:	Provides the status of the users ability to alter the type of files that the user may view as specified in the Host Access Levels Command

Remarks:	A value of 1 means the user can alter the file specification.


USERTIMEOUT

Action:	Returns the amount of time the user can remain online before the script times him/her out.

Remarks:	The return value is a number in seconds.


SESSIONPASSWORD

Action:	Returns the password set in the Phonebook or the Settings dialog box.


SESSIONFIRSTNAME,SESSIONLASTNAME

Action:	Returns the first name or last name set in the Phonebook or the  Settings dialog box.


SESSIONVAR1,SESSIONVAR2,SESSIONVAR3

Action:	Returns the VAR1,VAR2, or VAR3 set in the Phonebook or the  Settings dialog box.


CONNECTED

Action:	Returns the the current status of the online connection.

Remark:	A value of 1 means an online state.


DEFAULTDIR

Action:	Returns the default directory specified in Host Access Levels Command


UPLOADDIR

Action:	Returns the upload directory specified in Host Access Levels Command


HOSTBNAME

Action:	Returns the board name specified in Host Options Command


FILESPEC

Action:	Returns the file specifications defined in Host Access Levels


WAITSELECTION

Action:	Returns the received selection fro the corresponding waitlist.


CHANGEDIR

Action:	Changes the directory .

Syntax:	CHANGEDIR(string$)

Example:	CHANGEDIR(c:\\windows)


VERIFYUSR
VERIFYUSER

Action:	Verifies a user aginst the host users database. .

Syntax:	VERIFYUSER(firstname,lastname,password)


GETFIRSTDIRENTRY

Action:	Returns the first directory entry in the current directory .

Syntax:	GETFIRSTDIRENTRY(dirname,filespec)

Example:	string$ = GETFIRSTDIRENTRY(c:\,*.zip)


GETNEXTDIRENTRY

Action:	Returns the next directory entry based on the settings of the GETFIRSTDIRENTRY.

Syntax:	GETNEXTDIRENTRY( )

Example:	string$ = GETNEXTDIRENTRY( )


DOESFILEEXIST

Action:	Verifies the existence of a specific file..

Syntax:	DOESFILEEXIST(string$)

Remarks:	A value of 1 verifies the existence of the file.

Example:	numvar = DOESFILEEXIST(autoexec.bat )


REMOVEFILE

Action:	Deletes a specific file..

Syntax:	REMOVEFILE(string$)


RENAMEFILE

Action:	Renames a specific file..

Syntax:	RENAMEFILE(oldname,newname)


DISPLAYFILE

Action:	Transmits the specified file.

Remarks:	Can be used in host mode to transmit files.

Syntax:	DISPLAYFILE(string$)


VALIDFILENAME

Action:	Determines whether a file name is valid under the DOS system.

Syntax:	VALIDFILENAME(filename)


ADDUSER

Action:	Adds a user to the host user database.

Syntax:	ADDUSER(firstname,lastname,password,accessfile)

Remarks:	The accessfile must be a valid access level as defined in the Host Access Levels Dialog


NEWUSER

Action:	Adds a user to the host user database and sets the access level to the default.

Syntax:	NEWUSER(firstname,lastname,password)


SETLOGON

Action:	Used by Host mode to notify Microlink that a user is logged on.

Remarks:	This will start the user timer and initiate the logging information in the user activity log.

Syntax:	SETLOGON


SETLOGOFF

Action:	Used by Host mode to terminate the logging of information for the current user.

Syntax:	SETLOGOFF


CHANGEUSER

Action:	Modifies the users information in the host user database.

Syntax:	CHANGEUSER(firstname,lastname,password,accessfile)


DELETEUSER

Action:	Deletes a user in the host user database.

Syntax:	DELETEUSER(firstname,lastname)


Kermit configuration

The configuration options are:

(***ALL VALUES REFERENCED BELOW ARE DECIMAL***)

•	Start of Packet, determines the first byte of the packet.  The default value of 1 should be used in most cases.

•	Pad Character, determines the pad character used to fill the line for unbuffered devices to eliminate data loss.  It is usually the value 0, as most machines are buffered.

•	End of Line, determines what character is used to terminate an incoming packet.  Most systems use the CR ( 13 ).

•	Quote, used to determine what character will prefix control characters for data transfer transparency.  The normal value is the # ( 35 ).

•	Max. Packet Size, determines the maximum size of the Kermit transfer package.  The current implementation uses a small packet technique and cannot be greater than 95 bytes.

•	Pad Count, determines the number of pad characters that will preceed each incoming packet.  The normal value is 0.

•	8th Bit Quote, determines the character that will mask 7-bit transmissions when 8-bit characters are present.

The Checksum Options are:

•	1-Byte, uses a 6-bit checksum which reduces the probability of an error going undetected.  This option is not recommended as it tends to allow errors to go by undetected on noisy communication lines.

•	2-Byte, uses a 12-bit checksum which reduces the probability of an error going undetected.  This option is adequate in most cases.

•	3-Byte CRC,uses 16 Bit Cyclic Redundancy Check, which greatly reduces the probability of an error going undetected.  It has the gretatest amount of overhead and is more than adequate for most file transfers.


Mail Editor

The Mail Editor provides a facility to compose text files that can be posted to existing mail editors.  The following options are available:

•	Send, transmits the text in the edit area to the remote system.

•	SpellCheck,  provides a fully functional spell checker.

•	Save/Load, saves the text in the edit area to a file, or loads an existing one.


Configure ASCII

The following options are available to configure the ASCII protocol:

•	Append Ctrl+Z , adds the ^Z, the DOS end of file marker to the end of the received/transmitted file.

•	Expand CR -> CR+LF, converts all carriage return characters to carriage returns plus line feeds for received/transmitted files.

•	Compress CR+LF -> CR, converts all carriage return + line feed combinations into carriage returns for all received/transmitted files.

•	Insert CR at Column, inserts a carriage return at the specified column. The default value 0 ignores this option.

•	Timeout after (sec), terminates receive operation if no data is received in the specified number of seconds.