Introduction to XStream Functions
Lists and describes the conventions used to describe the functions.
These conventions include:
-
Conventions for OCI Functions — For each function, the following information is listed:
-
Purpose — A brief description of the action performed by the function.
-
Syntax — The function declaration.
-
Parameters — A description of each of the function's parameters. This includes the parameter's mode. The mode of a parameter has three possible values, as described in the following table.
Table 27-1 Mode of a Parameter
Mode Description IN
A parameter that passes data to the OCI.
OUT
A parameter that receives data from the OCI on this call.
IN/OUT
A parameter that passes data on the call and receives data on the return from this or a subsequent call.
-
Comments — More detailed information about the function (if available), which can include return values, restrictions on the use of the function, examples, or other information that can be useful when using the function in an application.