Script File Command Overview

Top  Previous  Next

 

This section describes all the commands available for script processing. Commands are shown in uppercase for legibility but may be upper or lower case when used.

 

The general syntax of a FileLink script command is shown below.

 

       opcode  [arg1] … [argn]

 

The opcodes for the various commands are listed below:

 

; or *

-

Comment line

:

-

Label marker

@

-

Suppress command and results from logging

!

-

Suppress command only from logging

ANSWER

-

Wait for incoming telephone call

APPEND

-

APPEND one file to another

ASK

-

Display question in a Yes/No dialog box

AUTHDATA

-

Obtain user data from authorization file

AUTHPW

-

Verify remote user password

AUTHUSER

-

Verify remote user name

BEGINFUNCTIONS

-

Begin function declaration section in script file

BREAK

-

Set a script file breakpoint

BROWSE

-

Display a pop-up open file dialog box

CALL

-

CALL another script file

CHAIN

-

Transfer to another script file

CHGDIR

-

An alias for the

CONNECT

-

open direct connection

CONSOLE

-

Control output to CONSOLE window

COPY

-

COPY one file to another location

CREATEMAIL

-

Create An e-mail message

CRON

-

script scheduling using crontab file

DATEADD

-

Add days to a date variable

DATESUB

-

Subtract days from a date variable

DBCLOSE

-

Close and optionally delete a database file

DBGETRESULTS

-

Get results froma database query

DBQUERY

-

Issue a database query

DBREWIND

-

Reset results search to beginning

DBUSE

-

Create and/or open a database file

DEC

-

Decrement a variable by one

DELDIR

-

Delete an empty local folder

DELETE

-

DELETE a file

DIAL

-

Initiate modem auto-dialer

DIFF

-

Find differences between current state of the local PC file system and the last snapshot or DIFF operation

DIFFREWIND

-

Reset file pointer for GETDIFF command

DISCONNECT

-

DISCONNECT the line

DISPLAY

-

DISPLAY all or a specified variable

DOSCMD

-

Execute An internal MS-DOS command

ENDFUNCTION

-

End function declaration

ENDFUNCTIONS

-

End function declaration section in script file

EXEC

-

Execute An external program

EXIT

-

Quit FileLink

EXPORT

-

EXPORT configuration settings to a file

FLUSH

-

FLUSH characters from receive buffer

FUNCTION

-

Begin FUNCTION declaration

GETDIFF

-

Sequentially report the different files found during the last DIFF operation

GETFILE

-

Get next file in local folder/subfolder tree

GETMAIL

-

Get An e-mail message

GETNEXTFILE

-

Get next file in a local directory

GETREWIND

-

Reset GETFILE to first matching file

GO

-

(Re)run the currently selected script file from beginning

GOTO

-

Direct flow to Label

IFDATE

-

Conditional branch upon file date comparison

IFERROR

-

Conditional branch after testing result code

IFFILE

-

Conditional branch on file existence

IFNFILE

-

Conditional branch on file non-existence

IFNO

-

Conditional branch if ‘No’ is clicked in ASK dialog box

IFNSTRCMP

-

Conditional branch when two string variables are not equal

IFNSUBSTR

-

Conditional branch if sub-string is not found in string variable

IFNUM

-

Conditional branch upon numeric variable comparison

IFSIZE

-

Conditional branch upon file size comparison

IFSTRCMP

-

Conditional branch when two string variables are equal

IFSUBSTR

-

Conditional branch if sub-string is found in string variable

IFTIME

-

Conditional branch upon file time comparison

IFYES

-

Conditional branch if ‘Yes’ is clicked in ASK dialog box

IMPORT

-

IMPORT configuration settings from a file

INC

-

Increment a variable by one

LINEIN

-

Read one or more characters from COM port

LINEOUT

-

Write one or more characters to COM port

LISTDIR

-

Write local directory listing to a file

LOG

-

Specify the script LOG file name

LOGMSG

-

Write a message to the script LOG file

LOGNTEVENT

-

Write a message to the NT application event LOG

LOOPCOUNT

-

Set maximum loop repetition

LOOPIF

-

Conditional branch used in conjunction with LOOPCOUNT

LOOPTO

-

Unconditional branch used in conjunction with LOOPCOUNT

MAILTO

-

Send An e-mail message (manually) via default e-mail client

MAKEFILENAME

-

Create a unique, non-existant file name

MESSAGEBOX

-

DISPLAY text in message box

MINIMIZE

-

MINIMIZE FileLink window

MODEMCMD

-

Send AT command to modem

MODEMDEFAULTS

-

Restore modem factory default settings

MODEMDETECT

-

Detect first available COM port and/or modem in system

MODEMRESET

-

Sent Reset command to modem

MODEMRESP

-

Read response to command Sent to modem

MOVE

-

MOVE one file to another location

NATO

-

Specify a No activity time-outNATO

MAKEDIR

-

Create a new local folder

PAUSE

-

PAUSE for specified length of time or until specified hour:minute

PERFORM

-

Execute script command contained in character string or variable

PGPCOMMAND

-

Send a “raw” GnuPG command

PGPDECRYPT

-

Decrypt a PGP encrypted file

PGPENCRYPT

-

Encrypt a file using PGP

PGPIMPORT

-

IMPORT a PGP key

PLAYSOUND

-

Play a sound (.wav) file

PRESSANYKEY

-

Suspend script execution pending a key press

PRINT

-

PRINT a file

PROMPT

-

DISPLAY message box and accept user input

PROTOCOL

-

Specify default file Transfer PROTOCOL

RCVFILE

-

Receive one or more files

READFILE

-

Read string variable value from text file

RENAME

-

RENAME a file

REMOTECMD

-

PERFORM a script command received via a COM port

RESTORE

-

RESTORE minimized FileLink window to original size

RESUME

-

RESUME execution of a script file stopped AT a breakpoint

RETURN

-

Force RETURN from a FUNCTION

SENDCMD

-

Send script command to remote FileLink (same as LINEOUT)

SENDFILE

-

Send one or more files

SENDMAIL

-

Send An e-mail message

SET

-

Assign or concatenate string variable(s)

SETEXTRACT

-

Extract delimited substring from a string

SETLEFT

-

Extract left substring

SETLEN

-

Assign length of specified string to a variable

SETMID

-

Extract mid substring

SETNUM

-

Assign or evaluate numeric variable(s)

SETSUBSTR

-

Find number of substrings in string

SETRIGHT

-

Extract right substring

SPEAKER

-

Control modem SPEAKER mode

SNAPSHOT

-

Take SNAPSHOT of current state of local PC file system

SRVNAME

-

Define service name and Control interaction with SrvMonitor

STOP

-

Stops script processing

TERMINAL

-

Activate the TTY TERMINAL applet

TRACELOG

-

Specify trace/diagnostic LOG file name

TRACEWIN

-

Open/Close trace logging window

UNZIP

-

Extract file(s) from a zip archive

USEPORT

-

Specify COM port and parameters

WORKINGDIR

-

Specify default working folder

WRITEFILE

-

Write character string or string variable value to text file

ZIP

-

Create or Add to a ZIP archive

 

See also: Script File Command Arguments, Sample Script Files