$adddays

Calculates a date value by adding days to (or subtracting days from) from a specified date value.

Syntax

$adddays(date,number)

where

datea date, or an expression that evaluates to a DATE data type
numbera number, or an expression that evaluates to a number

Return Value

Number, representing a DATE value.

Comments

Use $adddays to perform arithmetic with date values. $Adddays calculates a date value by adding a number representing days to a date value. If number is negative, the effect is to subtract the days from the date.

The + (add) and – (subtract) operators can be used to achieve the same results.

If date or the result of the functional expression is an invalid date (e.g., 19930231), it is adjusted to produce a valid date (e.g., 19930228).

Example

If $Date has the value 19981225, then

$adddays($date,5)

Evaluates to 19981230.

$adddays($date,7)

Evaluates to 19990101.

$adddays($date,-5)

Evaluates to 19981220.

$adddays(19990201,30)

Evaluates to 19990303.

$atan

Calculates the arctangent of a number.

Syntax

$atan(number)

Parameters

numbera number, or an expression that evaluates to a number

Return Value

Number, with the same number of decimal places as number.

Comments

Use $atan to calculate the arctangent (in radians) of a number. The value returned by this function has the same number of decimal places as number.

Example

let vAngle[1] = $atan(0.500)

The preceding command sets the first element of array variable vAngle to 0.464.

See Also

$acos

$atan2

$tan

$tanh

About Functional Expressions

$fileprint

Prints a text or bitmap file.

Syntax

$fileprint(filename[,filetype])

Parameters

filenamea character string or an expression that evaluates to a character string
filetypea number that determines if the file is a text file (0) or a bitmap file (1)

Return Value

The $fileprint function returns “1” ($True) if no errors were detected before the print job was submitted. Otherwise, it returns “0” ($False).

Comments

Bitmap printing is available only in the Windows environment.

$filepath

$filepath

Returns the path of the disk file associated with a specified object.

Syntax

$filepath(objname)

Parameters

objnameThe name of an EntitySet, relationship, application directory, or application document.

Return Value

The $filepath function returns a character string containing the path to the disk file that contains the specified object. AREAS.ZIM or DIRS.ZIM entries that apply to the file are expanded, as are the special path indicator characters. The value of $filepath is dynamically set, unless the program is compiled. Once a program is compiled, this value cannot be changed.

See Also

$ClipPath

$DBPath

$filenum

$ImagePath

$WorkPath

$ZimPath

$truncate

Truncates a decimal number, making it an integer.

Syntax

$truncate(number)

Parameters

numbera number, or an expression that evaluates to a number

Return Value

Number, with no decimal places.

Example

$truncate(2.49)

Evaluates to 2.

$truncate(2.99)

Evaluates to 2.

int1 - $truncate(int1/int2) * int2

Performs int1 modulo int2. Can also be expressed as $modulus(int1,int2).

See Also

$modulus

$round

$tonumber

$ttrim

Trims trailing blanks from a character string.

Syntax

$ttrim(string)

Parameters

stringa character string, or any expression that evaluates to a character string

Return Value

Character string.

Comments

Use $ttrim to remove trailing spaces from a character string.

For output purposes, the implicit length of the result returned by $ttrim is the same as the length of string.

Example

$ttrim (LastName)

Evaluates to “Smith” if LastName is stored as “Smith “.

detail line $concat($ttrim(LastName),", ",FirstName)

Displays a last name first in a report.

See Also

$ltrim

$toupper

Converts alphabetic characters to upper case.

Syntax

$toupper(source)

Parameters

sourceany value, or an expression that yields any value

Return Value

Character string, in which all letters are uppercase.

Comments

$toupper returns a character string in which all letters are upper case. If source is not of a character data type, it is converted to a character data type before the function is applied.

Example

$toupper("the QUICK BROWN fox is 30 years oLD")

Evaluates to “THE QUICK BROWN FOX IS 30 YEARS OLD”.

See Also

$tolower

$IsConnected

Tests if Zim is connected to a particular server.

Syntax

$isconnected(string)

Parameters

stringa character string or an expression that evaluates to a character string

Return Value

1-character binary string. Evaluates to 1 ($True) if Zim is connected to the server name contained in string; if the server name is invalid or there is no connection,  evaluates to 0 ($False).

Example

$isconnected("ZIMSERV")

Evaluates to $True if a previous CONNECT statement to ZIMSERV was successfully issued.

See Also

CONNECT

DISCONNECT

$day

Extracts the day number associated with a specified date value.

Syntax

$day(date)

Parameters

datea data, or an expression that evaluates to a date, in the form YYYYMMDD

Return Value

Character string.

Comments

This function extracts day information from standard date values. Date is often the system variable $Date.

Example

$day(19981225)

Evaluates to “25”.

$day($date+7)

Evaluates to “1” when $Date is 19991225.

See Also

$adddays

$Date

$dayname

$month

$monthname

$weekday

$year

$asin

Calculates the arcsine of a number.

Syntax

$asin(number)

Parameters

numbera number, or an expression that evaluates to a number

Return Value

Number, with the same number of decimal places as number.

Comments

Use $asin to calculate the arcsine (in radians) of a number. The value returned by this function has the same number of decimal places as number. The absolute value of the number must be between 0 and 1.

Example

let vAngle[2] = $asin(0.500)

The preceding command sets the second element of array variable vAngle to 0.524.

See Also

$acos

$atan

$atan2

$sin

$sinh

About Functional Expressions

en_CAEnglish