PickBASIC / FlashBASIC

571 topics in this section.

A

abort statement
The abort statement immediately stops program execution and unconditionally returns to the TCL command prompt.
abs() function
The abs() function returns the absolute (positive) portion of the integer number derived from the given numeric expressi
access() function
The access() function provides data about the AQL or Update processor environments when the program is called from a dic
Accessing VME resources from a rule module
There are several important rules to observe when running a FlashBASIC module, either as a Visual Basic rule module obje
alpha() function
The alpha() function evaluates the expression and returns 1 (true) if every character in the string is alphabetical (tha
and logical operator &
The and logical operator indicates that both components of a logical expression must be true.
Arithmetic expressions
Arithmetic expressions perform mathematical calculations on any set of operand expressions.
Arithmetic operators
Arithmetic operators add, subtract, multiply, and divide numeric operands in arithmetic expressions.
Array references
Dimensioned and Dynamic arrays can be referenced in BASIC programs.
Array variable
An array variable references a dynamic or dimensioned array.
Arrays
Pick BASIC has two types of arrays:
Arrays and relational expressions
Individual elements of dimensioned and dynamic arrays are compared in relational expressions using the standard syntax.
ascii() function
The ascii() function converts a string of EBCDIC-encoded characters into their equivalent ASCII values.
assigned() function
The assigned() function determines if the variable has been assigned a value.
Assignment
Assignment is the process of assigning the value of an expression to a variable.
Attribute count expression
An attribute count expression (ac expression) is any numeric constant or any arithmetic, logical, or string expression t
aux statement
The aux statement enables or disables spooling to the auxiliary port.

B

C

call statement
The call statement transfers control to an external FlashBASIC or BASIC subroutine and optionally passes a list of argum
capturing clause
The capturing clause resumes the capturing effect from the previous execute...capturing statements in a FlashBASIC or BA
capturing statement
The capturing statement resumes the capturing effect from the previous execute...capturing statements in a FlashBASIC or
case statement
The case statement delineates a conditional case construct.
casing statement
The casing statement toggles case sensitivity relative to input data and string comparisons in the current program and a
cat relational operator :
The cat relational operator concatenates strings in an expression.
Cataloging a FlashBASIC Module
Cataloging makes code easier to locate. It is not necessary to catalog a BASIC module to run or call it. Cataloging does
cfunction statement
The cfunction statement provides access to C libraries from BASIC.
chain statement
The chain statement transfers processing control to TCL, which interprets and executes the statement defined in the expr
change() function ereplace()
The change() function searches a str.exp for the search.str. If the search.str is at the start occurrence, then replacem
char() function
The char() function converts a number between 0 and 255 to its corresponding ASCII character equivalent.
clear statement
The clear statement sets all local and common variables to 0 in a main program.
cleardata statement
The cleardata statement clears the data stack.
clearfile statement
The clearfile statement deletes all items in the specified file variable previously opened with an open statement.
clearselect statement
The clearselect statement clears the active select-list specified by the list.var and releases all overflow associated w
close statement
The close statement closes the file identified by file.var. If file.var is not specified, the file referenced by the def
col1() function
The col1() function returns the numeric column position of the character immediately preceding the substring retrieved i
col2() function
The col2() function returns the numeric column position of the character following the substring retrieved in the most r
commit work statement
The commit work operation commits a transaction.
common statement com
The common statement declares data elements to share among different FlashBASIC or BASIC modules.
compare statement
The compare statement compares two dynamic arrays.
Compile stamps
Compile stamp items contain descriptive internal information about programs compiled for BASIC.
Compiler directives
Compiler directives control how a program is compiled. D3 supports a number of compiler directives to affect how a progr
Compiling programs
Compiling a BASIC program converts the source code into a list of binary instructions called object code.
continue statement
The continue statement restarts a loop that is under for...next or loop...repeat control.
Conversion expression
A conversion expression is any function that evaluates to any of the valid processing codes listed below in the See also
convert statement
The convert statement searches a given variable and replaces each occurrence of a character by another.
convert() function
The convert() function searches a given variable and replaces each occurrence of a character by another.
cos() function
The cos() function calculates the trigonometric cosine of an angle of a specified numeric expression in the range 0 to 3
count() function
The count() function returns the number of occurrences of str.exp2 within str.exp1.
Creating a FlashBASIC module
A BASIC module is a subroutine that does no I/O and is call from an external source. (It is possible to post-compile an
Creating user-defined C functions (D3 UNIX)
A user-defined C function can be incorporated in the D3 monitor, thus making C functions available to all applications r
Creating user-defined C functions (D3 Windows)
The example below describes creating, adding, removing, loading and unloading a C DLL function in Visual Studio 2008.
crt statement display
The crt statement outputs unconditionally to the terminal display, regardless of whether or not the printer on condition

D

Data representation
Data representation refers to the data types employed in BASIC. There are primarily two types of data:
data statement
The data statement queues responses for use by subsequent input requests initiated from chain, enter, execute, or input
date() function
The date() function returns the current system date in internal format as an integer number representing the number of d
dcount() function
The dcount() function returns the number of occurrences of the delimiter specified in str.exp2 within str.exp1, plus one
debug statement
The debug statement temporarily suspends execution of a FlashBASIC or BASIC program and invokes the FlashBASIC or BASIC
Default File Variables
The following statements make use of a feature known as default file variables:
deffun statement
Use the deffun statement to define a user-written external function (for example, an external sub-routine invoked using
del statement
The del statement provides an alternate to the delete() function for deleting a location from a dynamic array.
delete statement
The delete statement removes a specific item from a file.
delete() function
The delete() function removes a specific attribute, value, or subvalue from a dimensioned or dynamic array.
dimension statement dim
The dimension statement establishes a specific number of storage locations for a matrix of variables.
do clause
The optional do clause is used with the loop statement.
dquote() function
The dquote() function extracts a double-quoted string from str.exp.
dtx() function
The dtx() function converts a given decimal number to its corresponding hexadecimal equivalent. The number is first conv

E

ebcdic() function
The ebcdic() function converts a string of ASCII-encoded characters into their equivalent EBCDIC values.
echo statement
The echo statement toggles terminal echo on or off.
else clause
The else clause is the inline clause for the if statement to execute when it evaluates to false.
end case statement
The end case statement terminates case construct.
end statement
The end statement indicates both the end of a series of statements executed conditionally from a then or else condition
enter statement
The enter statement transfers control to another cataloged FlashBASIC or BASIC program.
Environment variables in triggers
The environment variables that are available when run from a trigger are described in this topic.
eq assignment operator =
The eq assignment operator represents either the assignment operator in an assignment statement or a relational operator
equate statement equ
The equate statement is a compiler directive that declares a constant at compile time or a synonym of another variable o
ereplace() function change()
The ereplace() function searches a str.exp for the search.str. If the search.str is at the start occurrence, then replac
Error condition
An error condition is the process state that occurs when a program encounters a condition that cannot be resolved, forci
Error logging
This topic describes how to record compiling errors when using FlashBASIC. Errors encountered during runtime are logged
error statement
The error statement displays the error message from the messages file and continues execution of the program.
error() function
The error() function retrieves the TCL command used to activate the program and loads it into a specified variable.
exchange() function
The exchange() function replaces the character specified as a hexadecimal string in str.exp1 with the character specifie
execute statement
The execute statement temporarily pushes a level and performs any valid TCL expression, and then continues execution of
execute statement (UNIX)
The execute statement executes a UNIX command from within a FlashBASIC or BASIC program.
exit statement
The exit statement forces an early exit from a loop that is under for...next or loop...repeat control.
exp() function
The exp() function returns the exponential of a numeric expression, that is, base e, which is 2.718281828 rounded to pre
extract() function
The extract() function retrieves a specific attribute, value, or subvalue from a dimensioned or dynamic array.

F

field() function
The field() function returns a substring from a string expression, by specifying a delimiter and the desired occurrence.
file statement
The file statement is a compiler directive that allows the use of attribute definition items in the file’s dictionary wh
File variable
A file variable is the symbolic way to access a file after being previously opened in a BASIC program. File variables ar
filelock statement
The filelock statement sets an exclusive lock on an entire file.
fileunlock statement
The fileunlock statement releases an exclusive lock set by the filelock statement on an entire file.
Flash interpreter
The d3flash utility is a DOS command that allows the launching of BASIC modules from a Windows command prompt. This laun
FlashBASIC and BASIC differences
This topic describes the differences between FlashBASIC and BASIC.
FlashBASIC automation application interfaces
The following FlashBASIC automation interfaces are presented.
FlashBASIC C functions
This section includes the following FlashBASIC C function topics.
FlashBASIC C functions list
The following FlashBASIC C Functions are available.
FlashBASIC C functions overview
C functions can be called from a FlashBASIC program or subroutine using a syntax similar to that of normal C.
FlashBASIC modules
This section includes the following FlashBASIC modules topics.
FlashBASIC triggers
Triggers are FlashBASIC subroutines that accept one argument called when an operation is performed on a record or a tabl
fmt() function
The fmt() function is identical to performing a FlashBASIC or BASIC mask.
fold() function
The fold() function folds a string expression into a string of a given length.
footing statement
The footing statement designates a text string composed of literals and special options to output at the bottom of each
for...next statement
The for...next statement is an iterative, incremental loop statement used to repeat a sequence of statements for a speci
Format strings
Numeric and nonnumeric strings can be formatted using format strings, which consist of numeric masks and format masks. T
function statement
User-defined functions can be defined within a program. They can be used like sub-routines invoked with gosub or called
Functions
Functions are elements in BASIC language expressions, returning a single value in place, as a function of the arguments.

G

H

I

iconv() function
The iconv() function converts a value from its external format to its internal equivalent, according to the processing c
ID expression
An ID expression is a string expression that evaluates to an item-ID, for use in all types of read and write statements.
if statement
The if statement tests the result of a logical expression. Depending on whether the expression evaluates to either true
ifr statement
The ifr statement tests the result of a logical expression.
in statement
The in statement accepts a single raw character of input from the keyboard, without displaying a prompt character or req
index() function
The index() function searches through a given str.exp for the occurrence of the character or substring specified by subs
inmat() function
The inmat() function returns information about arrays.
input statement
The input statement temporarily suspends execution of the program until a response is provided from the keyboard, and th
inputclear statement
The inputclear statement clears the keyboard type-ahead buffer.
inputctrl statement input
The inputctrl statement is used to enable or suppress control characters in BASIC input statements.
inputerr statement
The inputerr statement displays a message on the status (bottom) line of the terminal. it meant to be used with the inpu
inputerr statement (Windows)
When run from a trigger, from the D3 File Manager, or from a Visual Basic rule module, the inputerr statement displays a
inputif statement
The inputif statement captures input from the type-ahead buffer and assigns the input to a variable.
inputnull statement
The inputnull statement is used with the input @ statement to define the character used to indicate a null input on subs
inputparity statement
The inputparity statement enables or disables the extended character set (xcs) for the current process.
inputtrap off statement
The inputtrap off statement cancels the previous inputtrap statement.
inputtrap...gosub statement
The inputtrap...gosub statement, using the str.exp, sets up an automatic computed gosub based on the next input @ statem
inputtrap...goto statement
The inputtrap...goto statement, using the str.exp, sets up an automatic computed goto based on the next input @ statemen
ins statement
The ins statement is an alternative to the insert() function for inserting a string expression into a dynamic array.
insert() function
The insert() function inserts the element referenced by str.exp into a specific attribute, value, or subvalue location i
Inserting a trigger
A trigger is inserted by adding a correlative in the D-pointer of the table.
int() function
The int() function returns the numeric integer equivalent from a given expression.

K

L

M

N

O

P

page statement
The page statement terminates the current page of output, prints the optional footing, positions to the top of the form,
Passing D3 Visual Basic objects
The following D3 Visual Basic object handles (using the brHandle method available to each D3 Visual Basic object) can be
Passing Visual Basic arguments
As detailed in the D3 Visual Basic documentation, only VARIANT variables can be passed to the FlashBASIC subroutine, and
Performance
There are three methods for increasing performance:
Precedence
Precedence is the set of rules imposed upon the evaluation of components of an expression that are not otherwise overrid
precision statement
The precision statement defines the number of fractional decimal places that a numerical value can hold.
print on statement
The print on statement directs output to one of 32,767 open print files.
print statement
The print statement directs output of an expression to the current output device.
printchar statement
The printchar statement prints the first character of the string expression to the screen or to the printer.
printer statement
The printer statement controls the output from subsequent print, heading, footing, or page statements.
printerr statement
The printerr statement allows BASIC programs to produce output messages using the Error Message Processor and the errmsg
procread statement
The procread statement reads the calling Proc’s primary input buffer and assigns its contents to a specified variable.
procwrite statement
The procwrite statement writes a string expression variable to the calling Proc’s primary input buffer.
program statement
The program statement is optionally used on the first line of a program to indicate that this is a program.
prompt statement
The prompt statement indicates the single character to display during subsequent input statements that prompt for input
prvkey statement
The prvkey statement operates in the same manner as the nxtkey statement with the exception that the keys returned are t
pwr() function
The pwr() function raises a value contained in an expression to the power of the value of a second expression.

R

read statement
The read statement reads an item as a dynamic array and stores the item as a string. Each attribute is automatically an
readf statement
The readf statement reads the specified number of characters from a normal item.
readnext statement
The readnext statement retrieves the next item-ID from an active list and assigns it to a specified variable.
readt statement
The readt statement reads a tape record and assigns the value returned to a specified variable.
readtx statement
The readtx statement reads a tape record, converts the tape record to hexadecimal, and assigns the resulting hexadecimal
readv statement
The readv statement reads an item from the optionally-specified file variable and assigns the value contained in the att
Recompiling a trigger
By default, when the FlashBASIC code for a trigger is recompiled, it is not immediately used by the application. All fil
Relational expressions
A relational expression evaluates to 1 if the relation is true, and evaluates to 0 if the relation is false. Relational
Relational operators
Relational operators are used to compare both strings and/or numerics.
release statement
The release statement clears locks on items locked with a previous matreadu, readu, or readvu statement.
rem statement !
The rem statement designates that all text that follows the statement on the same line is ignored by the compiler.
rem() function
The rem() function returns the remainder portion of the result of dividing one number by another.
remove statement
The remove statement retrieves a substring delimited by a system delimiter from a dynamic array.
repeat statement
The repeat statement defines the end of a loop. See loop statement for more information.
replace statement
The replace statement maintains referential integrity between items that contain bidirectional bridges used by the Updat
replace() function
The replace() function inserts or replaces a specific attribute, value, or subvalue in the string referenced by dyn.arra
Reserved characters
Reserved characters are the characters that are reserved for special purposes.
Reserved words
The rules for reserved words are:
Retrieval locks
If a BASIC program is run by a user that does not have retrieval or update privileges (for a file that does and is opene
return statement
The return statement terminates an internal or external subroutine, and returns execution control to the statement follo
rewind statement
The rewind statement rewinds the currently attached magnetic tape unit to the beginning of the tape.
rnd() function
The rnd() function generates a random number.
rollback work statement
The rollback work statement rolls back (or undoes) a transaction.
root statement
The root statement provides an interface to the B-tree indexes for subsequent references with the key statement.
rqm statement
The rqm statement suspends processing for a specific number of seconds, or until a specific time.
Running a FlashBASIC module
Once compiled, the BASIC object code can be run directly, or it can be cataloged. This topic explains how to run a BASIC
Running FlashBASIC from a Windows command prompt
BASIC object code can be exported to a DOS file with a .D3F extension, and then combined with a launcher to turn it into
Running FlashBASIC from Visual Basic
When using a FlashBASIC module with the D3 Visual Basic class, D3clsRuleModule, some differences and constraints are app

S

scan() function
The scan() function searches through a specified str.exp for the first occurrence of up to three user-definable characte
screen.display utility
The screen.display utility displays a screen and waits for a selection.
screen.erase utility
The screen.erase utility erases a formatted screen.
screen.init utility
The screen.init utility initializes the screen common workspace. This call should be done prior to any other call the sc
screen.input utility
The screen.input utility displays a formatted screen and waits for input from a user. Multiple fields can be entered by
select statement
The select statement creates an active list of item-IDs, allowing sequential access to each item in the file by use of t
send statement
The send statement sends output to a specified port.
sendx statement
The sendx statement converts the exploded ASCII hexadecimal string results of str.exp to its binary equivalent and then
sentence() function
The sentence() function is identical to performing a tclread statement. It returns the TCL command used to activate the
seq() function
The seq() function converts any ASCII character to its corresponding numeric equivalent in the range 0 through 255.
setting clause
The setting clause defines the variable to receive the index results of a get or locate statement.
sin() function
The sin() function calculates the sine of an angle specified in degrees.
sleep statement rqm
The sleep statement places a process to sleep for a specific number of seconds, or, until a specific time.
sort() function
The sort() function sorts an attribute or value mark delimited str.exp in ascending order.
soundex() function
The soundex() function returns the 4-digit soundex code for a phonetic string expression.
space() function
The space() function generates a string of spaces of a length equal to the value of the numeric expression.
spoolq statement
The spoolq statement enables or disables the spooler entry number message.
sqrt() function
The sqrt() function calculates the square root of a given numeric expression.
squote() function
The squote() function extracts a single-quoted string from str.exp.
statement blocks
A statement block is one or more statements that follow a BASIC decision-path related token such as, but not limited to,
statement labels
statement labels are used as the destination of a goto or gosub statement.
Statements and functions
This topic describes the differences between statements and functions in BASIC and provides working definitions of varia
status() function
The status() function returns the value of system(0).
stop statement
The stop statement stops program execution and returns to the invoking the process.
str() function
The str() function repeats a str.exp the number of times specified in num.exp.
String expressions
A string expression is any expression that evaluates to, or can be converted to a string of characters.
subroutine statement
The subroutine statement defines a program as an external subroutine.
Substring expressions
A substring expression extracts or assigns substrings by using the [ and ] characters.
Substrings
A substring is a set of characters that makes up part of a whole string. The syntax to specify a substring is:
Subvalue count expressions
A subvalue count expression (sc expression) is an expression that evaluates to a valid subvalue count.
sum() function
The sum() function returns the sum of a list of numbers delimited by attribute, value, or subvalue marks. If different o
summation() function
The summation() function returns the sum of a list of numbers delimited by attribute, value, or subvalue marks.
swap() function ereplace()
The swap() function searches a str.exp for the search.str. If the search.str is at the start occurrence, then replacemen
Symbol table (BASIC)
When a BASIC program is compiled, a symbol table is generated, unless the s (suppress table) option has been used with t
system() function
The system() function provides an interface to a number of system variables, depending on the requested numeric argument

T

ta statement
The ta statement toggles or resets the type-ahead buffer.
ta() function
The ta() function returns the number of characters in the type-ahead buffer for the current process or for any other pro
tan() function
The tan() function calculates the trigonometric tangent of the angle specified in degrees.
tcl statement
The tcl statement executes any valid TCL command as a subroutine.
tclread statement
The tclread statement loads the TCL command used to activate the program into a variable.
then clause
The then clause specifies which statements to execute when the conditional statement evaluates to true.
then/else statement blocks
then/else statement blocks are found in conjunction with conditional statements.
time() function
The time() function returns the current system time in its internal format, representing the number of seconds past midn
timedate() function
The timedate() function returns the current system time and date in external format (hh:mm:ss dd mmm yyyy).
timeout statement
mvBase Only: The timeout statement specifies the number of seconds the operating environment waits for terminal input be
transaction abort statement
transaction abort statement
transaction cache statement
The transaction cache statement enables or disables the transaction read cache.
transaction commit statement
transaction commit statement
transaction flush statement
The transaction flush statement enables or disables the transaction flush mechanism.
transaction rollback function
transaction rollback function
transaction start function
transaction start function
transaction statement
The transaction statement enables or disables participation in a transaction.
trim() function
The trim() function removes leading, trailing, and/or redundant characters from a string.
trimb() function
The trimb() function removes trailing spaces from a string.
trimf() function
The trimf() function removes leading spaces from a string.

U

u$pl.mon.data user exit
The u$pl.mon.data user exit returns this monitor information:
u0003 user exit u3
The u0003 user exit returns the TCL command invoking the FlashBASIC or BASIC program.
u0004 user exit u4
The u0004 user exit returns term settings in dynamic array format.
u0005 user exit u5
The u0005 user exit clears the type-ahead buffer.
u000e user exit ue
The u000e user exit gets the name of the current account.
u0010 user exit u10
The u0010 user exit creates a phantom process.
u0011 user exit
The u0011 user exit gets the port number of the scheduler process.
u001c user exit u1c
The u001c user exit gets the number of attributes (elements) after a matread.
u001e user exit u1e
The u001e user exit returns the checksum of a string.
u001f user exit
The u001f user exit returns the last shutdown status.
u0033 user exit u33
The u0033 user exit converts a decimal number into a Roman numeral.
u0039 user exit
The u0039 user exit reads an absolute disk sector. This user exit provides more information than u14a.
u005b user exit
The u005b user exit obtains and manipulates external strings, allowing the caller (likely non-FlashBASIC) to store data
u0074 user exit
The u0074 is used to get a list of the VME item locks in a dynamic array format.
u0079 user exit
The u0079 user exit returns the where status for the specified PCB (Process Control Block) FID, and its return stack inf
u007a user exit
The u007A user exit updates a binary item from a FlashBASIC or BASIC program.
u0089 user exit
User exit u0089 converts a hexadecimal number (in a string) to a binary number.
u009d user exit
The u009d user exit encodes or decodes a string of characters.
u009e user exit
The u009e user exit replaces all occurrences of str1 with str2 in str3.
u009f user exit
The u009f user exit converts a binary number to a hexadecimal number (32-bit limit).
u00b9 user exit
The u00b9 user exit returns a soundex value for a specified string.
u00ba user exit
The u00ba user exit performs BIOS INT 10 calls to change the video screen attributes on the console.
u014a user exit
The u014a user exit reads an absolute disk sector.
u014b user exit
The u014b user exit writes an absolute disk sector.
u017e user exit
The u017e user exit allows output of any character to the terminal or spooler.
u01b6 user exit
The u01b6 user exit converts a numeric expression to the number of units as defined by the TCL set-units, set-dozens, se
u0209 user exit
The u0209 user exit returns only alphabetical and numeric characters.
u0358 user exit
The u0358 user exit allows character input combined with an eoi (end-of-input) character.
u0c user exit uc
The u0c user exit encrypts a password.
u1072 user exit
The u1072 user exit returns a dynamic array, sorted in ascending order.
u10b9 user exit
The u10b9 user exit converts American currency punctuation ($1,000.00) to international punctuation (#1.000,00)
u11b6 user exit
The u11b6 user exit converts a unit expression to a numeric value as defined by the TCL set-units, set-dozens, set-decim
u1209 user exit
The u1209 user exit breaks a single line of text into multiple lines of text with each line being no longer than length
u1a user exit
The u1a user exit returns the tape block size.
u1f user exit
The u1f user exit returns a string of digits indicating the boot status.
u20b9 user exit
The u20b9 user exit converts international currency punctuation (#1.000,00) to American punctuation ($1,000.00).
u21 user exit
The u21 user exit converts upper case to lower case.
u2117 user exit
The u2117 user exit returns information about the current process.
u21a3 user exit
The u21a3 user exit opens a file, or reads the next attribute from a file.
u21b6 user exit
The u21b6 user exit returns a numeric value representative of the current unit setting defined by the TCL set-units, set
u22 user exit
The u22 user exit converts lower case to upper case.
u222d user exit
The u222d user exit retrieves the CC pointer item information from binary items.
u28 user exit
The u28 user exit returns the number of saves that have occurred since the last full restore.
u3060 user exit
The u3060 user exit encrypts a character string. The result is always an 8-character hexadecimal string.
u3079 user exit
The u3079 user exit returns the PCB FID of the current process, or returns the port number of the current process.
u307a user exit
The u307a user exit suspends processing until a specified time.
u3090 user exit
The u3090 user exit aborts a FlashBASIC or BASIC program.
u313c user exit
The u313c user exit returns the diskette drive type and density selected.
u352e user exit
The u352e user exit retrieves statistical information about the use of buffers by the D3 monitor. This user exit is for
u3b user exit
The u3b user exit returns information about the port.
u3f user exit
The u3f user exit converts an ASCII hexadecimal-format string to binary, and sends it to the printer.
u4070 user exit
The u4070 user exit directs all subsequent output to the terminal. This is the same as the BASIC printer off statement.
u407a user exit
The u407a user exit sets a port to sleep for a specified number of seconds. This is the same as the BASIC sleep statemen
u4117 user exit
The u4117 user exit returns the PCB (Process Control Block) in hexadecimal for the current process.
u413c user exit
The u413c sets the format type to the given format media.
u4209 user exit
The u4209 user exit parses the input into discrete words.
u47 user exit
The u47 user exit writes a string in ASCII or hexadecimal to a specific location in a frame.
u48 user exit
The u48 user exit reads a specific location of a frame and returns the content.
u50bb user exit ub
The u50bb user exit returns the port number, user-ID, and current account for this process, just like the TCL who comman
u5117 user exit
The u5117 user exit returns the PCB in hexadecimal for port 0.
u5e user exit
The u5e user exit clears the internal BASIC heading and footing so that subsequent heading and footing statements displa
u60ba user exit
The u60ba user exit flushes all memory to disk, and shuts down the D3 system.
u60bb user exit
The u60bb user exit returns the user-ID and account name of the current process.
u6193 user exit
The u6193 user exit removes all but the last three characters from the data passed from the variable.
u63 user exit
The u63 user exit sets/clears privilege bits.
u65 user exit
The u0065 user exit returns the estimated number of items in the most recently referenced file.
u6d user exit
The u6d user exit sends shutdown message.
u7000 user exit
The u7000 user exit returns the size of an item.
u70ba user exit
The u70ba user exit forces the system to restart.
u71 user exit
The u71 user exit sets the HAForceCheck option programmatically. See the Host Authentication topic in the System Adminis
u7193 user exit
The u7193 user exit converts the American date format (mm/dd/yy) to international format (dd/mm/yy).
u8194 user exit
The u8194 user exit returns the number of items selected by the most previous select.
u83 user exit
The u83 user exit sets a group lock.
u84 user exit
The u84 user exit clears a group lock from the group lock table.
u86 user exit
The u86 user exit sets the root fid of the index.
u90 user exit
The u90 user exit returns the file of files number for the file most previously referenced in the FlashBASIC or BASIC pr
u90e3 user exit
The u90e3 user exit flips the parity bit on the input.
u91 user exit
The u0091 user exit reads and writes D3 shell variables.
u9116 user exit u9
The u9116 user exit logs on a given port.
u92 user exit
The u92 user exit follows the links of a frame.
u98 user exit
The u98 user exit retrieves the links for the specified fid.
ua116 user exit ua
The ua116 user exit logs of the specified port.
ub070 user exit
The ub070 user exit returns the absolute value of a variable, stripping the leading –, if any.
ub0ba user exit
The ub0ba user exit reads one string of memory. The string that is returned must be pre-allocated prior to running oconv
uc0ba user exit
The uc0ba user exit writes a value into a memory address.
uclose command
The uclose command closes a file variable previously opened with the uopen command.
ucreate command
The ucreate command creates and opens a specified file on the host system.
ud0ba user exit
The ud0ba user exit reads a character byte from a serial port.
udelete command
The udelete command removes the directory entry named by the path name.
ue0ba user exit
The ue0ba user exit writes a character byte out to a serial port.
uerror() function
The uerror() function returns the error number that resulted from the previous inter-operating system command.
uexecute command
The uexecute command allows users to execute various Windows programs from within mvBASIC.
uf070 user exit
The uf070 user exit starts and stops multiuser mode, and returns information about the number of serial ports, PIBs, pha
ulock command
The ulock command locks or unlocks a file specified by a file variable.
ulseek() function
The ulseek() function moves the file pointer in an open file and returns the position of the file pointer, which is the
umessage command
The umessage command sends a Windows-style message to the Client linked to the process executing the command. If the opt
unassigned() function
The unassigned() function indicates whether a variable has an assigned value.
unlock statement
The unlock statement resets an execution lock, in the range 0 to 991, previously set with a lock statement.
until clause
The until clause specifies a termination condition for a for...next or loop constructs.
uopen command
The uopen command opens a given file name to a file variable.
uread command
The uread command reads data from a previously opened file on the host system.
ureadline() function
The ureadline() function reads data from a previously opened file on the host system.
Using the COM interface to FlashBASIC
This topic describes the COM interface to FlashBASIC. The objective is to allow a FlashBASIC module to act as an Automat
usystem() function
The usystem() function is used to obtain information from the underlying operating system environment.
uwaitfor command
The uwaitfor command causes the process to wait until the Windows application, identified by the var variable, terminate
uwrite command
The uwrite command writes data to a previously opened file on the host system.

V

W

X

#

- arithmetic operator
The - arithmetic operator designates a subtraction operation, or to indicate a negative numeric value.
-= assignment operator
The -= assignment operator decrements a variable by a numeric expression.
, reserved character
The , (comma) reserved character several purposes:
; reserved character
The ; (semicolon) reserved character separates multiple FlashBASIC or BASIC statements on a single line.
: relational operator
The : (colon) relational operator concatenates strings in an assignment statement or, when the : displays at the end of
:= assignment operator
The := assignment operator concatenates a string to a variable and assigns it back to the given variable.
! logical operator or
The ! logical operator indicates an or operation in a logical expression.
! statement *
The ! statement indicates that the text following the ! is a comment. This works the same as the remark statement.
" Reserved Character
The " reserved character marks the beginning or ending of a literal string in FlashBASIC or BASIC.
() reserved characters
The () (left and right parentheses) reserved characters surround arguments within functions, encloses subscript referenc
[] reserved characters
The [] reserved characters perform substring extraction, assignment, and field store.
@() function
The @() function provides a standard means of performing control functions on a wide array of terminals.
* arithmetic operator
The * (asterisk) arithmetic operator is a mathematical operator indicating a multiply operation.
* statement !
The * (asterisk) statement is used as a remark. Text after this statement is ignored.
*= assignment operator
The *= assignment operator multiplies a numeric expression and assigns it to the variable.
/ arithmetic operator
The / arithmetic operator performs division.
/= assignment operator
The /= assignment operator divides a variable by a numeric expression and assigns it to the given variable.
\ arithmetic operator
The \ operator (also called the remainder operator) calculates the remainder of dividing the dividend by the divisor (ot
\ reserved character
The \ reserved character marks the beginning or ending of a literal string in FlashBASIC or BASIC.
\= assignment operator
The \= assignment operator divides a variable by a given numeric expression and assigns the remainder (modulo) to the va
& logical operator and
The and boolean operator indicates that both components of a logical expression must be true.
# relational operator ne
The # relational operator signifies not equal to.
%accept_ssl() function
The %accept_ssl() function first calls the %accept() function to extract the first connection on the queue of pending co
%accept_starttls() function
The %accept_starttls function provides the ability to elevate an unsecured connection to a secured connection.
%accept() function
The %accept() function extracts the first connection on the queue of pending connections, creates a new socket, and allo
%alarm() function
The %alarm() function instructs the alarm clock of the calling process to send the signal SIGALRM to the calling process
%bind() function
The %bind() function binds a socket to a named resource. In case of a network, the resource would be an access point int
%calloc() function
Allocates and frees dynamic memory.
%chdir() function
The %chdir() function changes the current directory to the one specified in str.
%chmod() function
The %chmod() function changes the mode of the file str to the value specified in mode.
%chown() function
The %chown() function changes the owner-ID and group-ID of the file str to the values specified in owner and group respe
%close_ssl() function
The %close_ssl function closes the socket specified by the fd file descriptor, as well as the secure connection specifie
%close() function
The %close() function closes the UNIX file specified by file.descriptor returned by a previous call to %open(), %creat()
%closeall() function
The %closeall() function closes all opened file-descriptors, including sockets.
%closesocket() function
The %closesocket() function closes an existing socket.
%CoCreateObject interface
Call to create a COM Object.
%CoGetDispatch interface
Call a to get an IDispatch.
%CoGetException interface
Get error description.
%CoInitialize interface
Call to initialize the COM library.
%CoInvoke interface
Call a method.
%connect_ssl() function
The %connect_ssl() function requests a secure connection between two sockets.
%connect_starttls() function
The %connect_starttls function provides the ability to elevate an unsecured connection to a secured connection.
%connect() function
The %connect() function requests a connection between two sockets.
%CoPropertyGet interface
Call a Property Get.
%CoPropertyPut interface
Call a Property Put.
%CoQueryInterface interface
Query IUnknown for IDispatch interface.
%CoQueryMethod interface
Query for a method.
%CoRelease interface
Release a dispatch or COM object when done.
%CoUninitialize interface
Uninitialize the COM library.
%creat() function
The %creat() function creates a new host OS file or prepares to rewrite an existing host OS file designated by str for w
%decrypt() function
The %decrypt() function decrypts a string. The appropriate OpenSSL libraries must be present to use this function. See y
%dup() function
The %dup() function returns a new file descriptor associated to the same file as the one associated with file.descriptor
%encrypt() function
The %encrypt() function encrypts a string. The appropriate OpenSSL libraries must be present to use this function. See y
%endlistilocks() function
The %endlistilocks() function is used to release the handle allocated by the %startlistilocks() function.
%fclose() function
The %fclose() function closes the stream specified by stream returned by a previous call to %fopen().
%fdopen() function
The %fdopen() function associates a stream with the file.descriptor obtained from an %open(), %dup(), or %creat().
%fgetc() function
The %fgetc() function returns the next character from the named input stream.
%fgets() function
The %fgets() function reads characters from the named input stream into var until n-1 characters are read or a new line
%filecheck() function
The %filecheck() function can be run from the TCL to call the system fsck (file system check) command.
%fopen() function
The %fopen() function opens the host OS file designated by str and associates a stream with it.
%fprintf() function
The %fprintf() function writes formatted output on stream under control of format.
%fputc() function
The %fputc() function writes the character specified by character on the named output stream.
%fputs() function
The %fputs() function writes the string designated by str on the named output stream.
%fread() function
Binary stream input/output.
%free() function
The %free() function frees a block of memory allocated by a call to %malloc().
%freopen() function
The %freopen() function substitutes the named file specified by str in place of the opened stream stream1.
%fsize() function
The %fsize() function returns the size in bytes of the file associated to the opened file.descriptor returned by a previ
%fwrite() function
Binary stream input/output.
%getaddrinfo() function
Front end to the socket %getaddrinfo() function.
%getenv() function
The %getenv() function searches the environment for a string of the form name=value and returns a pointer to value in th
%gethostid() function
The %gethostid() function allows a FlashBASIC application to retrieve the unique 32-bit identifier for the current host.
%gethostname() function
The %gethostname() function retrieves the standard host name for the local computer.
%getnamedhost() function
Front end to the socket %gethostbyname() function.
%getperfcount() function
The %getperfcount() function returns the D3 performance counters.
%getpgrp() function
The %getpgrp() function returns the UNIX process group ID of the calling process.
%getpid() function
The %getpid() function returns the Process-ID (PID) of the calling process.
%getppid() function
The %getppid() function returns the UNIX parent Process-ID of the calling process.
%getsockopt() function
The %getsockopt() function retrieves a socket option.
%inet_addr() function
The %inet_addr() function converts a string containing an IPv4 dotted-decimal address into a proper address for the IN_A
%ioctl() function
The %ioctl() function is a general purpose control function that passes the arguments request and arg to the device desi
%ioctlsocket() function
The %ioctlsocket() function controls the I/O mode of a socket.
%kill() function
The %kill() function sends the signal specified in signal to the process pid.
%listen() function
The %listen() function marks the specified socket as accepting incoming connections and limits the number of outstanding
%listitemlocksfilter() function
The listitemlocksfilter() function is used to get a list of the FSI item locks in a dynamic array format.
%lseek() function
The %lseek() function moves the read/write pointer. See your host OS system documentation.
%malloc() function
The %malloc() function allocates a memory block of size bytes and returns the address of this block.
%memccpy() function
Copies the memory area.
%memchr() function
Scans memory for a character.
%memcopy() function
The %memcopy() function copies characters from the memory area specified by s2 into s1, stopping after the first occurre
%memcpy() function
The %memcpy() function copies the number of characters specified by number from memory area s2 into s1.
%memxcpy() function
The %memxcpy() function copies a specified number of characters from memory area s2 into s1, and converts each input cha
%open() function
The %open() function opens the host OS file specified by str and sets the file status flags according to the value of of
%pause() function
The %pause() function suspends the calling process until it receives a signal.
%pclose() function
The %pclose() function closes the stream designated by stream opened by a %popen() and returns the exit status of the co
%pgetpid() function
The %pgetpid() function returns the UNIX Process-ID (PID) associated to the D3 process line.
%popen() function
The %popen() function creates a pipe between the calling process and the command to be executed.
%printf() function
Formatted output conversion.
%putenv() function
The %putenv() function makes the value of the environment variable name equal to the value designated by str, by alterin
%rdhex() function
The %rdhex() function reads the number of bytes designated by (size * 2) into var from the file specified in file.descri
%read_ssl() function
The %read_ssl() function reads the number of bytes designated in size into var, from the Secure connection specified by
%read() function
The %read() function reads the number of bytes designated in size into var, from the file specified by file.descriptor.
%readregistry() function
The %readregistry() function retrieves string values from the registry.
%realloc() function
The %realloc() function resizes the memory buffer specified to the specified size in bytes and returns a pointer to the
%recv() function
The %recv() function receives data from a connected socket or a bound connectionless socket.
%recvfrom() function
The %recvfrom() function receives a datagram from a bound socket and stores the information on the sender. If no errors
%semctl() function
The %semctl() function performs semaphore control operations.
%semget() function
The %semget() function creates a semaphore set.
%semop() function
The %semop() function performs an array of semaphore operations on a set of semaphores.
%send() function
The %send() function sends data on a connected socket.
%sendto() function
The %sendto() sends data to a specified destination. If no errors occur, the total number of bytes sent is returned.
%setflush() function
The %setflush() function sets the flush periods.
%setsockopt() function
The %setsockopt() function sets a socket option.
%shell() function
The %shell() function executes the MS-DOS command, command, and returns the exit code of the command.
%shellcapture() function
The %shellcapture() function executes the MS-DOS command, command, and captures the result in the buffer variable, up to
%shmat() function
The %shmat() function attaches a shared memory segment associated with the shared memory identifier shmid and returns th
%shmctl() function
Allows the user to receive information on a shared memory segment, set the owner, group, and permissions of a shared mem
%shmdt() function
The %shmdt() function detaches the shared memory segment located at the address specified by shmaddr.
%shmget() function
The %shmget() function creates a shared memory segment and returns a shared memory identifier.
%shutdown() function
The %shutdown() function disables sends or receives on a socket.
%socket() function
The %socket() function creates a socket in the specified addr.family and of the specified type. A protocol can be specif
%sprintf() function
Formatted output conversion.
%startfileio() function
Specifies that all input comes from the input file and all output goes to the output file.
%startlistilocks() function
The %startlistilocks() function prepares for calls to the %listitemlocksfilter() function and the %endlistilocks() funct
%stopfileio() function
Stops all input and output to and from the file. The FlashBASIC tab of the D3 Device Manager contains the default path o
%strcat() function
Concatenates two strings.
%strcpy() function
Copies a string.
%strlen() function
Calculates the length of a string.
%ttyname() function
The %ttyname() function returns a pointer to a static area containing the null terminated path name of the terminal devi
%unlink ()function
The %unlink() function removes the directory entry named by the path name pointed to by path. The named file is unlinked
%wait() function
The %wait() function returns the exit code of the child processes created by the current process.
%whex() function
The %whex() function writes to the file specified by file.descriptor returned by a previous call to %open(), %creat(), o
%write_ssl() function
The %write_ssl() function writes the number of bytes designated by size from var to the Secure connection specified by s
%write() function
The %write() function writes the number of bytes designated by size from var to the file specified by file.descriptor re
^ arithmetic operator **
The ^ symbol arithmetic operator is an alternate means of indicating an exponentiation operation on a specific numeric e
+ arithmetic operator
The + arithmetic operator performs addition or indicates a positive numeric value.
+= assignment operator
The += assignment operator adds a given numeric expression and assigns it to the given variable.
<= relational operator le
The <= relational operator is the less than or equal to operator.
<> relational operator ne
The <> relational operator represents a not equal to operator.
<> reserved characters
The <> reserved characters surround subscripts within dynamic arrays.
= assignment operator
The = assignment operator represents either the assignment operator in an assignment statement or a relational operator
> relational operator gt
The >relational operator is the greater than operator.
>< relational operator ne
The >< relational operator is the not equal operator.
>= relational operator ge
The >= relational operator is the greater than or equal to operator.
$* directive
The $* (asterisk) directive allows a comment to be embedded directly into the program’s object code at compilation.
$chain directive
The $chain directive continues FlashBASIC or BASIC compilation in a different source item.
$chain statement
The $chain statement continues FlashBASIC or BASIC compilation in a different source item.
$DEFINE directive
The $DEFINE directive supplies replacement text for a symbol and defines a symbol used to control the compilation of the
$IFDEF directive
The $IFDEF directive tests for the definition of an identifier in the compiler symbol table.
$IFNDEF directive
The $IFNDEF directive tests for the absence of a definition for an identifier in the compiler symbol table.
$include directive include
The $include directive inserts FlashBASIC or BASIC code from a separate item (known as an include item) to be compiled a
$include statement include
The $include statement inserts FlashBASIC or BASIC code from a separate item (known as an include item) to be compiled a
$options directive
The $options directive sets compatibility options for the FlashBASIC or BASIC compiler.
$options statement
The $options statement sets compatibility options for the FlashBASIC or BASIC compiler.
$UNDEFINE directive
The $UNDEFINE directive deletes a specified identifier from the symbol table. The identifier must have previously been d