KEYWORD (short description of intended use)

Top  Previous  Next

 

[label] KEYWORD( | parameter1 | [ parameter2 ] ) [ATTRIBUTE1( )] [ATTRIBUTE2( )]

| alternate |

| parameter |

| list |

 

KEYWORD

A brief statement of what the KEYWORD does.

parameter1

A complete description of parameter1, along with how it relates to parameter2 and the KEYWORD.

alternate parameter list

A complete description of mutually exclusive alternates to parameter1, along with how they relate to parameter2 and the KEYWORD.

parameter2

A complete description of parameter2, along with how it relates to parameter1 and the KEYWORD. Because it is enclosed in brackets, [ ], it is optional, and may be omitted.

ATTRIBUTE1

A sentence describing the relation of ATTRIBUTE1 to the KEYWORD.

ATTRIBUTE2

A sentence describing the relation of ATTRIBUTE2 to the KEYWORD.

A concise description of what the KEYWORD does. In many cases the KEYWORD will be an attribute of a keyword that was described in the preceding text. Sometimes a KEYWORD has no parameters and/or attributes.

Events Generated:

If the KEYWORD generates events, they are listed here.

Return Data Type:

The data type returned if the KEYWORD returns a value.

Errors Posted:

If KEYWORD posts errors which may be trapped by the ERROR and ERRORCODE functions, they are listed here.

Related Procedures:

If KEYWORD defines a data structure, the procedures which operate on that data structure are listed here.

Example:

FieldOne = FieldTwo + FieldThree          !This is a source code example

FieldThree = KEYWORD(FieldOne,FieldTwo)   !Comments follow the "!" character

 

See Also:

Other pertinent keywords and topics