Back to Contents


Documentation Conventions

Summary:


Console Only Features

Console only features are marked with the red warning: Console Only!


OPTIONS MENU LINE 3 Console Only!

Elements marked with this flag must only be used in programs designed for character-based terminals. 


De-supported Features

Product features that are no longer supported are marked with the red warning: De-supported!


The WIDGET="BMP" attribute De-supported!

Elements marked with this flag are no longer supported in the product.


Informix Specific Features

Features that are specific to Informix database servers are marked with the red warning: Informix only!


DATABASE dbname@dbserver Informix only!

Elements marked with this flag work only with Informix database servers, and are not recommended for multi-database programming.


Syntaxes

The term of 'syntax' is global and indicates the way to use a product function. For example, it can be used to describe a language instruction or a system command:

Syntax:

CALL function ( [ parameter [,...] ] ) [ RETURNING variable [,...] ]

Wildcard characters in syntax definitions are marked with an underscore:

Wildcards

Description
[   ] Square braces indicate an optional element in the syntax.
{ | } Curly braces indicate a list of possible elements separated by a pipe.
[...] Indicates that the previous element can appear more than once.
[,...] Previous element can appear more than once separated by a comma.

Notes

Notes hold a list of technical remarks about the product function:

Notes:

  1. identifier is the name of the variable to be defined.
  2. datatype can be any data type except complex types like TEXT or BYTE.
  3. ...

Warnings

Warnings are important technical remarks, describing special behavior of the product function:

Warnings:

  1. When a DATE, DATETIME or INTERVAL constant cannot be initialized correctly, it is set to NULL.
  2. ...

Tips

Tips are hints to use the product function more efficiently:

Tips:

  1. Do not include a NULL value in a Boolean expression.
  2. ...

Code Examples

Code examples are written with line numbers and language syntax highlighting as follows:

Example 1:

01 MAIN
02   DEFINE a1 ARRAY[100] OF INTEGER,
03         a2 ARRAY[10,20] OF RECORD
04              id INTEGER,
05   ...