OMITTED Function

Purpose

Indicates if a parameter was not supplied on a call.

Parameters

x must be an un-subscripted parameter by address, and the corresponding argument must be declared as OPTIONAL in the ENTRY declaration.

Description

The OMITTED built-in function returns "true" i.e. a BIT(1) value equal to '1'B if the specified parameter is not supplied when calling the containing procedure.

The OMITTED built-in accepts Level-1 structure or union arguments.

Example

See the help topic for the OPTIONAL parameter for a code example that uses the OMITTED function.

Restrictions

None.