The entries in this manual all conform to the same conventions as follows:

Synopsis:   Provides a definition of the function and its arguments.

Arguments: Provides a description of the function arguments.

Description: Provides a detailed description of the function.

Returns: Describes the possible return values.

For each entry a synopsis is provided showing the function name, its return value and the function arguments as follows:

Synopsis:

       handle=getHandle(arg1,arg2[,arg3[,arg4]]);

In the above example the function getHandle() is defined with two compulsory arguments arg1, arg2 and a two optional arguments arg3 and arg4.     Optional arguments are specified by showing the arguments in square bracketss ([]).     

Below is another slightly different example:

Synopsis:

       handle=getHandle(arg1,arg2[,arg3[,...]]);

In this example the function getHandle() is defined with two compulsory arguments arg1, arg2 and an unspecified number of optional arguments all of a similar type to arg3 (if it is specified).      By specifying elipses inside the square brackets this indicates that the previous argument can be repeated an unspecified number of times.

The argument description and detailed description will then provide clarification about what arguments are actually required.

All example code shown in the manual will be shown in the 'Courier' font as shown below:

main

    applog("Goodbye Cruel World");

    sys_exit(1);

endmain