ADD_PARAMETER Built-in
Description
Adds parameters to a parameter list. Each parameter consists of a key, its type, and an associated value.
Syntax
PROCEDURE ADD_PARAMETER
(list VARCHAR2,
key VARCHAR2,
paramtype NUMBER,
value VARCHAR2);
PROCEDURE ADD_PARAMETER
(name VARCHAR2,
key VARCHAR2,
paramtype NUMBER,
value VARCHAR2);
Built-in Type unrestricted procedure
Enter Query Mode yes
Parameters
- list or name
-
- Specifies the parameter list to which the parameter is assigned. The actual
parameter can be either a parameter list ID of type PARAMLIST, or the VARCHAR2
name of the parameter list.
-
- key
-
- The name of the parameter. The data type of the key is VARCHAR2.
-
- paramtype
-
- Specifies one of the following two types:
TEXT_PARAMETER A VARCHAR2 string literal.
DATA_PARAMETER A VARCHAR2 string specifying the
name of a record group defined in the current form. When Oracle Forms passes
a data parameter to Reports or Graphics, the data in the specified record
group can substitute for a query that Reports or Graphics would ordinarily
execute to run the report or display.
-
- value
-
- The actual value you intend to pass to the called module. If you are passing
a text parameter, the maximum length is 64K characters. Data type of the value
is VARCHAR2.
ADD_PARAMETER Restrictions
- A parameter list can consist of 0 (zero) or more parameters.
- You cannot create a parameter list if one already exists; to do so will cause an error. To avoid this error, use ID_NULL to check to see if a parameter list already exists before creating one. If a parameter list already exists, delete it with DESTROY_PARAMETER_LIST before creating a new list.
- You cannot add a parameter of type DATA_PARAMETER if the parameter list is being passed to another form.
ADD_PARAMETER Examples
/*
** Built-in: ADD_PARAMETER
** Example: Add a value parameter to an existing Parameter
** List 'TEMPDATA', then add a data parameter to
** the list to associate named query 'DEPT_QUERY'
** with record group 'DEPT_RECORDGROUP'.
*/
DECLARE
pl_id ParamList;
BEGIN
pl_id := Get_Parameter_List('tempdata');
IF NOT Id_Null(pl_id) THEN
Add_Parameter(pl_id,'number_of_copies',TEXT_PARAMETER,'19');
Add_Parameter(pl_id, 'dept_query', DATA_PARAMETER,
'dept_recordgroup');
END IF;
END;