Print
page
Add the row rowid to the current list of the form table.
Changes to directory expr.
Closes the current open directory (see also opendir).
[UNIX/DOS]: Permits switching of cursor display depending on its screen position.
Simulates pressing of a key, writing its value to the key buffer.
Example:
call dokey("fleft")
call dokey(3) -> Control-C.
call dokey(13) -> RETURN.
call dokey("freturn") -> RETURN.
call dokey("309-4589A") -> String.
Displays the number of rows of the current list of the FORM's active table and positions to the first row.
This function equals «evalvar» but works with an array element. The element is identified by «number».
Compares "exp1" with "exp2" using operator "oper" and returns:
"oper" can be one of the following: "=", ">", "<", ">=", "<=", "!=", "<>", "like", "matches"
Example:
let a = evalcond(b, ">", c, "ddd", a)
if equivalent to:
if b > c then
let a = "ddd"
else
let a = a
Executes function "funname" and - if it exists - returns its value.
Example:
| evalfun("getctlvalue", "version") | -> | getctlvalue("version") |
| evalfun(fun_name(), parm1) | -> | If function fun_name() returns"fun1" this equals -> fun1(parm1) |
Evaluates if "exp1" is a NULL value or not. Returns:
Example:
pause evalnull(payform, "no valid payform", "payform is: " & payform)
This function is similar to the statement GET QUERY WHERE....
| Parameter | Description |
| where_clause | Alphanumerical expression containing a WHERE and/or ORDER BY condition for the QUERY. |
| collist | Alphanumerical expression with a list of comma separated column names. They will be added to the SELECT of the QUERY. If an ORDER BY is used in the where_clause the columns used in the ORDER BY must be specified in collist, because otherwise the SQL will display an error like: "SELECT list must include column (...) for ORDER BY". |
The number of rows found will be returned.
Example:
let num = fgetquery("order
by client", "client")
let num = fgetquery("where client = 1")
let num = fgetquery("where client > 2 order by client", "client")
Also the following parameters may be passed in special cases:
fgetquery(fquery(TRUE))
Returns the size of the file "file" in bytes. If the file is not existent or if the parameter is invalid NULL will be returned.
Example:
if filesize("file")>0
then
...
The function fquery() equals the QUERY statement, but with the difference that this function will only return the corresponding SELECT condition.
Example:
let a = fquery() -> i.e. the
value of "a" might be: "where customer > 1"
...
Returns various CTL system information. What is being returned depends on the parameter "expr".
| expr | Return value |
| "version" | CTL version (i.e. "2.0.05") |
| "O.S." | Returns Operating System (z.B. "WINDOWS") |
| "porting" | Returns OS variant (i.e. "AIX") |
| "atcol" | Screen column at which CTL was started. |
| "atrow" | Screen row at which CTL module was started. |
| "ctlname" | Name of the current CTL module. |
With this function you can position to a specific row within a FORM's current list. The meaning of "expr" is:
| expression = 0 | Positions to the current row (no change). |
| expression = n | Positions to the n-th. row. |
| expression = -1 | Positions to the last row. |
| expression = -2 | Positions to the last but one row. |
| ... |
Permits to choose the page («SCREEN») in a FORM/FRAME with "expr". Possible values are:
| expression = 0 | Positions to the current page. |
| expression = n | Positions to page «n». |
| expression = -1 | Positions to the last page. |
| expression = -2 | Positions to the last but one page. |
| ... |
Returns TRUE if a character is contained in the keyboard buffer, FALSE in the other case. If TRUE is returned the key stored in the buffer can be read by a READ KEY or PAUSE statement or it may be used by any CTL element.
Example:
{Clear keyboard buffer}
while keypressed()=true
read key
Equals letvar but the value will be assigned to the array element indicated in «number».
The functions assigns the value "value" to the program variable passed to it in "expression".
Copies the contents of the file "source" to the file "dest" eleminating any comment lines (those beginning with ‘#’). The function returns:
Example:
nocomment("fl.err", "fl.sct")
The function msgtext now allows to pass a value as second parameter, which will be inserted in the message when required.
Example:
msgtext (150, "items")
- Message 150 = "Table %s does not exist in database" returns:
"Table items does not exist in database".
It is only possible to pass one or none value. In the first case the must be include a %s.
This function opens a directory. Returns TRUE if directory exists and can be opened, FALSE in the other case. Only one directory can be open at a time. In case of executing two ‘opendir’ functions the second one automatically executes a ‘closedir’ on the first directory opened.
Example:
if opendir(dir)=true then begin
forever begin
let fil = readdir()
if fil is null then break
...
...
end
call closedir()
end
Adds the environment variable "var" to the current user environment and assigns it the value "value". The optional parameter "mode" is used to indicate if the new environment variable is to be made known also to the running CTSQL.
| Mode | Description |
| 0 | Value is only valid for CTL (resp. CTSQL if it is of its own variables). |
| 1 | Value is only for CTSQL. |
| 2 | Value is for CTL and CTSQL. |
Please check page A/10 in the MultiBase Reference Manual for further information.
This function returns a string with all column names, types and optionally database defined attributes from a SELECT statement passed to it.
| flag | flag = 0: Attributes are not considered
(Default). flag = 1: Attributes are considered. |
| char_separator | Separator between the columns in the list. By default commas (,) are used. |
Example:
tsql "create table t1 (" & sqldescribe("select * from customers") & ")"
| Flag | Description |
| 0 (Default) | All cursors of a module are closed. This is true for FORMs and WINDOWs and for the cursors defined by the user (DECLARE CURSOR). |
| 1 | Only the Cursors of the FORM are closed. |
Uses "select_str" to open a Cursor and returns a handle (>=0). With this handle the cursor will be identified in sqlfetch and sqlclose. If an error occurs NULL is returned.
Example:
let handle = sql_select("select " && selected_cols() && " from
items")
let a = sqlfetch(handle)
call sqlclose(handle)
This example uses a user-defined function selected_cols which returns the columns to be selected in a char.
Counts the appearance of "what" in "where". Returns the number of appearances or NULL in case of parameter error.
Example:
let num = strcount("A-3393457332", "33")
Returns the n-th. word in the string "where".
| Parameter | Description |
| where | String to be searched. |
| num | Number of word within string. If "num" is ommitted the first word will be returned. |
| charseparator | Separator. |
| typesep | If its value is FALSE this indicates that various separators are equivalent to one separator. If every separator shall be treated separately TRUE is to be used. If charseparator is a space the default value is FALSE else TRUE. |
The function returns NULL if
The number of words should be checked before with strnumwords.
Example:
let a = strgetword("/tmp::/usr", ":", 2, false)
In this case the returned value is "/usr".
Searches one string in another.
| Parameter | Description |
| where | String to be searched. |
| what | String to be found. |
| num | Searches the num-th. occurance of "what" within "where" (default 1). If "num" is passed as a negative the num-th. search will start at the end of string (reverse). |
In case of parameter error NULL will be returned.
Eleminates spaces (blank) to the left of string "expr" and returns the result without leading spaces. If parameter error, NULL will be returned.
Counts the number of words in a string. Parameters are compatible to strgetword. In case of parameter error NULL is returned.
Example:
let oldpath = "/path1:/path2:/path3"
let num = strnumwords(oldpath, ":")
for i = num down to 1
let newpath = newpath & strgetword(oldpath, ":", i) & ":"
Repeats expr num times. The maximum length of the returned string is 512 characters.
Example:
let a = strrepeat("-.", 40)
Replaces a substring with another substring within a source string.
| Parameter | Description |
| where | String to be modified. |
| charold | String to be replaced. |
| charnew | Replacement. |
| num | Number of replacements to be done. If num is not indicated all occurances of charold will be replaced by charnew. |
The result will be the modified string. charold and charnew may be of different length only if the string size is below 512 characters. If charnew is an empty string charold will be cleared.
If a parameter error occurs NULL is returned.
Example:
let var = strreplace("/disk1/demo", "k1", "k2", 1)
Eleminates spaces (blank) to right of the string passed as "expr" and returns the new string (without padding chars). If a parameter error occurs NULL is returned.
Eleminates leading and padding spaces (blanks) of "expr". Also duplicated spaces between tokens are compressed into a single space. NULL is returned in case of an error.
Checks whether a file exists or if it is of the type/has permissions as indicated.
| Parameter | Description |
| file | File |
| attr | Expression identifying permissions.
Every character stands for one permission. Attributes can be freely combined. |
The function returns TRUE if all of the attributes indicated match. FALSE will be returned if one or more attributes don't mach or the file/directory is not existent.
When an erroneous parameter is passed the function will return NULL.
Example:
if testfile("file", "rwf")=TRUE
then
....
A second parameter can be passed to determine the default option. Valid are "y" and "n" for the options YES/NO, while "n" will be used as default (when the parameter is ommitted).