$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

$not

Performs a bit-wise NOT of a value.

Syntax

$not(char)

Parameters

chara character string, or an expression that evaluates to a character string

Return Value

Character string.

Comments

The $not function reverses the bit pattern of a single character in the fashion of a Boolean NOT and returns the resulting character.

If the char string contains more than one character, only the first character in the string (one byte) is processed. Char can be expressed as a hex code.

Example

$not("E")

The bit pattern of hex 0E is 00001110. The above expression reverses the bit pattern to 11110001 (hex F1).

See Also

$and

$or

About Character Literals

About Functional Expressions

$maxof

Returns the larger of a pair of numbers.

Syntax

$maxof(number1,number2)

Parameters

number1a number or an expression that evaluates to a number
number2a number or an expression that evaluates to a number

Return Value

The value returned by $maxof has the same number of decimal places as the number that is returned.

Comments

The function returns the larger of a pair of numbers.

Example

if event.eventname = "up"
let IndexPtr = $maxof(IndexPtr-1, 1)
else
... other commands ...
endif

Modifies an array index, without letting the index drop below 1.

See Also

$minof

About Functional Expressions

$length

Returns the length of a character string.

Syntax

$length(string)

Parameters

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

Return Value

Number.

Comments

If string is a complex arithmetic expression, then the result of $length(string) is always 17. Arithmetic expressions are evaluated using the data type vastint so that the largest possible number can always be handled. When converted to a string, a vastint value occupies 17 positions, regardless of its numeric value.

Example

$length("abcdefgh")

Evaluates to 8.

$length(5*3)

Evaluates to 17.

$minof

Returns the smaller of a pair of numbers.

Syntax

$minof(number1,number2)

Parameters

number1a number or an expression that evaluates to a number
number2a number or an expression that evaluates to a number

Return Value

The value returned by $minof has the same number of decimal places as the number that is returned.

Comments

The function returns the larger of a pair of numbers.

Example

if event.eventname = "down"
let IndexPtr = $minof(IndexPtr+1, ArrayLen)
else
... other commands ...
endif

Modifies an array index, without letting the index exceed the specified number.

See Also

$maxof

About Functional Expressions

$isodd

Tests if a number is odd.

Syntax

$isodd(expression)

Parameters

expressiona number, or an expression that evaluates to a number

Return Value

If expression evaluates to an odd number, the function returns “1” ($True); if expression evaluates to an even number, the function returns”0″ ($False)

If expression does not evaluate to a number, the software raises an error.  The function returns “0” ($False).

Comments

Expression is rounded before testing.

Example

$isodd(vAmount)=$False

Evaluates to $True if vAmount is even.

$isodd(-5)

Evaluates to $True.

$isodd(Salary*1.1)

Evaluates to $False if Salary is 20,000.

$isodd("123.4")

Evaluates to $True.

$isodd("abc")

Evaluates to $False.

See Also

$isnumber

About Functional Expressions

$month

Extracts the month number associated with a specified date value.

Syntax

$month(date)

Parameters

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

Return Value

Character string.

Comments

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

Example

$month(19931225)

Evaluates to “12”.

$month($date+7)

Evaluates to “1” when $Date is 19991225.

See Also

$addmonths

$Date

$day

$dayname

$monthname

$weekday

$year

About Data Types

About Functional Expressions

pt_BRPortuguese