Oracle Forms Developer – Form Builder Reference, Volume 1

GET_OLEARG_ built-in
Description
Obtains the nth argument from the OLE argument stack.
There are four versions of the function (denoted by the value in type), one for each of the argument types
CHAR, NUM, OBJ, and VAR.
Syntax
FUNCTION GET_OLEARG_CHAR
(which NUMBER)
RETURN olearg VARCHAR2;
...or...
FUNCTION GET_OLEARG_NUM
(which NUMBER)
RETURN olearg NUMBER;
...or...
FUNCTION GET_OLEARG_OBJ
(which NUMBER)
RETURN olearg OLEOBJ;
...or...
FUNCTION GET_OLEARG_VAR
(which NUMBER, persistence BOOLEAN)
RETURN olearg OLEVAR;
Built-in Type unrestricted function
Returns the indicated argument. Note that the type varies according to the form of the function
used.
Parameters
which A relative number indicating which argument in the OLE
argument stack should be retrieved.
persistence Controls the persistence of the OLEVAR argument after
its retrieval. This is an optional parameter; if not
specified, the default value is FALSE (that is, nonpersistent).
Usage Notes
• Use this function to retrieve arguments whose value might change as a result of the method call.
• In contrast to a returned OLEVAR argument, whose persistence can be user-controlled, a returned
OLEOBJ argument is always set to be non-persistent.
208