Categoria: ZIM 4GL Language Reference

Calculates one number modulo another.

Syntax

$modulus(expr1,expr2)

Parameters

Return Value

Number, with no decimal places.

Comments

Expr1 modulo expr2 is the remainder of the division of expr1 by expr2.

Before the operation is carried out, expr1 and expr2 are rounded, if necessary, to yield integer values.

Example

$modulus(5,2)

Evaluates to 1.

$modulus(5.2,2.43)

Evaluates to 1.

$modulus(Age,10)

Evaluates to 4 if Age is 54.

See Also

About Functional Expressions

Invokes a special function built by the user.

Syntax

$userfunction(expression-1, expression-2, ...)

Parameters

Return Value

The return value is determined by the type and length of expression-1.

Comments for Windows Environments

On Windows environments, the user function is a DLL whose name is assumed to be “#z32func.dll” (it can be defined as any other name) where the symbol “#” denotes the directory where the environment variable ZIM points to (that is where is Zim is installed). You may modify it by setting the environment variable ZIMFUNC in the Registry to point to another location or to another name like this example:

ZIMFUNC     c:program fileszim8.50myfunc.dll

The DLL is loaded the first time the $UserFunction is invoked by a Zim command.

Comments for UNIX Environments

The name of the user function for UNIX environments is assumed to be “#zimfunc” where the symbol “#” denotes the directory where the environment variable ZIM points to (that is where is Zim is installed). You may modify it by setting the environment variable ZIMFUNC in the Registry to point to another location or to another name like this example:

ZIMFUNC=/usr/zim/zimfunc
export ZIMFUNC

The “zimfunc” executable is loaded once the first time the $UserFunction is invoked by a Zim command.

6. the length of the tUserBuf structure, this may or may not be used

7. ensure that you are using 1 byte packing (or /Zp1 on the compile line)

The example program, zfuncwin.c, displays information in a MessageBox

about the arguments that are passed to it from ZIM and returns the

first argument as the result.

To test this example try entering Zim:

list 5 docs format $userfunction (docname, filename)

or

out $userfunction ("hi there")

Performs a bit-wise OR of two values.

Syntax

$or(char1,char2)

Parameters

Return Value

Character string.

Comments

The $or function combines the bit patterns of two characters in the fashion of a Boolean OR and returns the resulting character.

If the char1 or char2 string contains more than one character, only the first character in the string (one byte) is processed. You can express char1 and char2 as hex codes (e.g., 6E).

Example

$or("E","F")

The bit pattern of hex 0E is 00001110 and of hex 0F is 00001111. The above expression returns the bit pattern 00001111 (hex 0F).

See Also

$and

$not

Executes server-side functions.

Syntax

$serverfunction (server specific syntax [«,parameters»])

Parameters

Return Value

A value created by the server-specific syntax.

Comments

$ServerFunction executes the specific syntax (for a particular server) using the parameters.

The syntax is not parsed and checked, but rather passed through directly to the Server and, therefore, must be accepted and understood there.

Examples

$ServerFunction ("sysfun.left(?,3)",var1)

This will is accepted as is by Oracle.

$ServerFunction("sysfun.left(cast(? as VARCHAR(20),3)",var1)

This syntax is accepted by DB2.

See Also

Server Side Functions with Input Parameters

The Benefits of $ServerFunction

Performs a bit-wise AND of two values.

Syntax

$and(char1,char2)

Parameters

Return Value

Character string.

Comments

The $and function combines the bit patterns of two characters in the fashion of a Boolean AND and returns the resulting character. If the char1 or char2 string contains more than one character, only the first character in the string (one byte) is processed. You can express char1 and char2 as hex codes (e.g., 6E).

Example

$ and("E","F")

The bit pattern of hex 0E is 00001110 and of hex 0F is 00001111. The above expression returns the bit pattern 00001110 (character hex 0E).

See Also

$not

$or

About Character Literals

About Functional Expressions

Calculates a time value by adding ticks to (or subtracting ticks from) a specified time value.

Syntax

$addticks(time,number)

Parameters

Return Value

Number, representing a time value.

Comments

Use $addticks to perform arithmetic with time values. The $addticks function calculates a time value by adding a number representing ticks to a time value. If number is negative, the effect is to subtract the ticks from the time.

Example

If $Time has the value 22503075, then

$addticks($time,5)

evaluates to 22503080.

$addticks($time,25)

evaluates to 22503100.

$addticks($time,-5)

evaluates to 22503070.

$addticks($time,200)

evaluates to 22503275.

See Also

$addhours

$addminutes

$addseconds

$ticks

Returns information about the currently accessed application directories.

Syntax

$dirpath()

Return Value

Character string.

Comments

$dirpath returns a character string consisting of the names of all currently accessed application directories and their access types (U for update, R for read). Information about each directory is enclosed in semicolons (;). The directory name appears first, followed by the access type in parentheses.
Directories appear in the order that they were accessed; that is, the most recently accessed directories appear first.

Example

access dir1

access dir2 updatev

output $dirpath()

Prints the string; dir2(U);dir1(R);ZIM(U);_$ZimServices(R);_$session$_(U);

let vDirPath = $dirpath()

let vPos = $position($toalpha(vDirPath, -1), ";Dir1(")

if vPos > 0

output "Directory Dir1 is accessed ";

if $substring(vDirPath,vPos+6,1)="U"

output "update."

else

output "read."

endif

else

output "Directory Dir1 is NOT accessed."

endif

Uses $position to test if a particular directory is accessed.

See Also

ACCESS

RELEASE

Calculates a time value by adding minutes to (or subtracting minutes from) a specified time value.

Syntax

$addminutes(time,number)

where

Return Value

Number, representing a time value.

Comments

Use $addminutes to perform arithmetic with time values. The $addminutes function calculates a time value by adding a number representing minutes to a time value. If number is negative, the effect is to subtract the minutes from the time.

Example

If $Time has the value 22503075, then

$addminutes($time,5)

Evaluates to 22553075.

$addminutes($time,10)

Evaluates to 23003075.

$addminutes($time,-5)

Evaluates to 22453075.

$addminutes($time,65)

Evaluates to 23553075.

Calculates a time value by adding seconds to (or subtracting seconds from) a specified time value.

Syntax

$addseconds(time,number)

Parameters

Return Value

Number, representing a time value.

Comments

Use $addseconds to perform arithmetic with time values. The $addseconds function calculates a time value by adding a number representing seconds to a time value. If number is negative, the effect is to subtract the seconds from the time.

Example

If $Time has the value 22503075, then

$addseconds($time,5)

evaluates to 22503575.

$addseconds($time,35)

evaluates to 22510575.

$addseconds($time,-5)

evaluates to 22502575.

$addseconds($time,65)

evaluates to 22513575.

$addseconds(22595900,1)

evaluates to 23000000.

See Also

$addhours
$addminutes
$addticks
$seconds

Counts the number of set members that meet a specified condition, excluding records in which the condition is $Null.

Syntax

$count(expression)

Parameters

Return Value

Number, with no decimal places.

Comments

Expression is often a WHERE expression that includes only selected set members in the counting operation. If the WHERE expression (expr1 WHERE expr2) is true, then the member containing expr1 is included in the running count; otherwise, expression is considered $Null and is not included in the running count.

Example

compute Employees where DeptName="Sales" 
  evaluate (let EmpsInSales = $count(LastName where LastName = "Smith"))

First finds all employees in the sales department, then counts the number of Smiths among those employees.

add Employees from TestData let EmpNum = ($count("")+1000)

As employee data is added, each new record is counted. New employee records are assigned unique employee numbers in sequence, based on the current value of $count plus 1000.

See Also

$average

$max

$min

$total

About Character Literals

About Functional Expressions

WHERE