We Appreciate Your Comments
Reader’ Comment Form . • Did you find any errors? • Is the information presented clearly? • Are the examples correct? Do you need more examples? • What features did you like? If you found any errors or have any other suggestions for improvement.
vii
. Your feedback is an important part of our revision process.oracle.com. please send your comments by e-mail to oddoc@us. Thank you for your help.A73152-01 s
Oracle Corporation welcomes your comments about this manual’ quality and s usefulness.

.

This reference guide includes information to help you effectively work with Forms Developer and contains detailed information about its built-in packages. This preface explains how this user’ guide is organized and s introduces other sources of information that can help you use Forms Developer.
ix
.Preface
Welcome to Release 6i of the Oracle Forms Developer and Oracle Reports Developer: Common Built-in Packages .

and keywords. In commands.Prerequisites
You should be familiar with your computer and its operating system. You should also be familiar with such programs as the Explorer. SQL reserved words. such as the elements of an application window. Text typed on a PC is not case-sensitive unless otherwise noted. Refer to your Microsoft Windows 95 or NT and DOS product documentation for more information. Uppercase characters within the text represent command names. Substitute an appropriate value. For example. Boldface is used to indicate user interface items such as menu choices
UPPERCASE
boldface
x
. you should know the commands for deleting and copying files and understand the concepts of search paths. and Registry. punctuation other than brackets and vertical bars must be entered exactly as shown. lowercase Lowercase characters in a command statement represent a variable. and path names.
Notational Conventions
The following typographical conventions are used in this guide: Convention fixed-width font Meaning Text in a fixed-width font indicates commands that you enter exactly as shown. You should also understand the fundamentals of Microsoft Windows. subdirectories. Taskbar or Task Manager.

Related Publications
You may also wish to consult the following Oracle documentation: Title Oracle Forms Developer and Oracle Reports Developer: Guidelines for Building Applications SQL*Plus User's Guide and Reference Version 3.1 Part Number A73073
A24801
xi
. Your prompt may differ.and buttons. C> C> represents the DOS prompt.

.

Put_Line). any time you reference a construct in one of the packages. EXEC_SQ provides procedures and functions for executing dynamic SQL within PL/SQL code written for Forms Developer applications.
Forms Developer and Reports Developer Built-in Package Reference
1
. manipulating.g. The built-in packages are: provides Dynamic Data Exchange support within Forms Developer DDE components. and exceptions for debugging PL/SQL Debug program units. provides a PL/SQL API for creating.Built-in Packages
About built-in packages
Both Forms Developer and Reports Developer provide several built-in packages that contain many PL/SQL constructs you can reference while building applications or debugging your application code. provides constructs that allow you to read and write information from and to Text_IO files. provides procedures. functions. and accessing attributes OLE2 of OLE2 automation objects. provides procedures. Text_IO. Tool_Env allows you to access and manipulate the error stack created by other built-in Tool_Err packages such as DEBUG. These built-in packages are not installed as extensions to package STANDARD. examining how much time a specific piece of code takes to run). and exceptions you can use for tuning your Ora_Prof PL/SQL program units (e. L provides procedures. you must prefix it with the package name (for example. functions. As a result. allows you to interact with Oracle environment variables. This provides a means of creating arrays in PL/SQL Version 1. enables you to extract high-level information about your current language Ora_Nls environment. functions. and exceptions you can use to create and List maintain lists of character strings (VARCHAR2). provides a public interface for calling out to foreign(C) functions from Ora_Ffi PL/SQL.

The following packages are used only internally by Forms Developer.Tool_Res
provides a means of extracting string resources from a resource file with the goal of making PL/SQL code more portable by isolating all textual data in the resource file. C
2
Forms Developer and Reports Developer Built-in Package Reference
. Ora_De Used internally by Forms Developer to call subprograms stored in the database. There are no subprograms available for external use with these packages. Contains constructs used by Forms Developer for private PL/SQL services. STPRO Calls to this package are automatically generated.

it was necessary to attach a stub library so that calls to the Windows-specific DDE functions would compile and run correctly on non-Windows platforms. Note that these functions do not translate the data itself (all DDE data is represented with the CHAR datatype in PL/SQL). Dynamic Data Exchange (DDE) is a mechanism by which applications can communicate and exchange data in Windows.
n
Server support Oracle applications cannot respond to commands or requests for data from a DDE client. when you attempt to
Forms Developer and Reports Developer Built-in Package Reference
3
. in addition. Transaction Functions These functions are used to exchange data with DDE server applications. DDE does not include the following: n data linking (advise transaction)
Oracle applications cannot automatically receive an update notice when a data item has changed. Datatype Translation Functions These functions are used to translate DDE datatype constants to strings and back. DDE. DDE client support is added as a procedural extension to Forms Developer. However.Getformatnum allows users to register a new data format that is not predefined by Windows. Note: In previous releases of Forms Developer. Connect/Disconnect Functions These functions are used to connect to and disconnect from DDE server applications. just datatype constants.About the DDE package
The DDE Package provides Dynamic Data Exchange (DDE) support within Forms Developer components.
Support Functions These functions are used to start and stop other DDE server applications. The DDE functions enable Oracle applications to communicate with other DDEcompliant Windows applications (servers) in three ways: n importing data
n n
exporting data executing commands against the DDE Server
In this release. The PL/SQL package for DDE support provides application developers with an Application Programming Interface (API) for accessing DDE functionality from within PL/SQL procedures and triggers. Oracle Applications must initiate the DDE conversation (although data may still be transferred in either direction). This is no longer necessary.

DDE. DDE.Cf_Pendata The data is for the pen extensions to the Windows operating system. DDE.Cf_Sylk The data is in Microsoft Symbolic Link
4
Forms Developer and Reports Developer Built-in Package Reference
. DDE. This data is displayed in Text Format in lieu of the privately formatted data.
Microsoft Windows predefined data formats
See the Exceptions section for predefined data format exceptions.Cf_Oemtext The data is an array of Text Characters in the OEM character set.Cf_Dib The data is a memory object containing a BITMAPINFO structure followed by the bitmap data. DDE.Cf_Dspbitmap The data is a bitmap representation of a private format.Cf_DspmetafileThe data is a metafile representation of Pict a private data format.Cf_Palette The data is a color palette. DDE. DDE. DDE. the following messages are generated: FRM-40735: Trigger <name> raised unhandled exception. 00000 PL/SQL: ICD vector missing for this package. This data is displayed in bitmap format in lieu of the privately formatted data. Each line ends with a carriage return-linefeed (CR-LF) combination.Cf_Dif The data is in Data Interchange Format (DIF).Cf_Bitmap The data is a bitmap. DDE. DDE. A null character signals the end of the data. DDE. ORA-06509.CF_Dsptext The data is a Textual Representation of a private data format. This data is displayed in metafile-picture format in lieu of the privately formatted data. DDE.Cf_Riff The data is in Resource Interchange File Format (RIFF).Cf_Owner-Display The data is in a private format that the clipboard owner must display. DDE.execute a Windows-specific built-in function on a non-Windows platform.Cf_Metafilepict The data is a metafile.

DDE.Cf_Text

DDE.Cf_Tiff DDE.Cf_Wave

(SYLK) format. The data is an array of Text Characters. Each line ends with a carriage return-linefeed (CR-LF) combination. A null character signals the end of the data. The data is in Tagged Image File Format (TIFF). The data describes a sound wave. This is a subset of the CF_RIFF data format; it can be used only for RIFF WAVE files.

Forms Developer and Reports Developer Built-in Package Reference

5

DDE predefined exceptions
An application program specified in a DDE.App_Begin call could not be started. DDE.DDE_App_Not_ An application ID specified in a Found DDE.App_End or DDE.App_Focus call does not correspond to an application that is currently running. DDE.DDE_Fmt_Not_ A format number specified in a Found DDE.Getformatstr call is not known. DDE.DDE_Fmt_Not_Reg A format string specified in a DDE.Getformatnum call does not correspond to a predefined format and could not be registered as a userdefined format. DDE.DDE_Init_Failed The application was unable to initialize DDE communications, which caused a call to the DDE Layer to fail. DDE.DDE_Param_Err An invalid parameter, such as a NULL value, was passed to a DDE Package routine. DDE.Dmlerr_Busy A transaction failed because the server application was busy. DDE.Dmlerr_Dataacktimeo A request for a synchronous data ut transaction has timed out. DDE.Dmlerr_ExecackTime A request for a synchronous execute out transaction has timed out. DDE.Dmlerr_Invalidparam A parameter failed to be validated. eter Some of the possible causes are as follows: The application used a data handle initialized with a different itemname handle or clipboard data format than that required by the DDE.DDE_App_Failure

6

Forms Developer and Reports Developer Built-in Package Reference

transaction. The application used an invalid conversation identifier. More than one instance of the application used the same object. DDE.Dmlerr_Memory_Err A memory allocation failed. or DDE.Dmlerr_No_Conv_EstA client's attempt to establish a ablished conversation has failed. The service or topic name in a DDE.Initiate call may be in error. DDE.Dmlerr_Notprocessed A transaction failed. The item name in a DDE.Poke or DDE.Request transaction may be in error. DDE.Dmlerr_Not_Supporte A call is made to the DDE package d but DDE is not supported on the current software platform. DDE.Dmlerr_PokeacktimeoA request for a synchronous ut DDE.Poke transaction has timed out. DDE.Dmlerr_Postmsg_Fail An internal call to the PostMessage ed function has failed. DDE.Dmlerr_Server_ Died The server terminated before completing a transaction. DDE.Dmlerr_Sys_Error An internal error has occurred in the DDE Layer.

Forms Developer and Reports Developer Built-in Package Reference

7

and exceptions for use when debugging your PL/SQL program units. OLE2 automation objects encapsulate a set of attributes and methods that can be manipulated or invoked from an OLE2 automation client.
About the List package
The List package contains procedures. Use these built-in subprograms to create debug triggers and set breakpoints with triggers. manipulating. use only doubles within your code. methods. functions. and exceptions you can use to create and maintain lists of character strings (VARCHAR2). If you must use ANSI declarations. The OLE2 package allows users to access OLE2 automation servers directly from PL/SQL.About the Debug package
The Debug package contains procedures.
8
Forms Developer and Reports Developer Built-in Package Reference
.
About the Ora_Ffi package
The Ora_Ffi package provides a foreign function interface for invoking C functions in a dynamic library. and syntax specification. and accessing attributes of OLE2 automation objects. functions. Note that float arguments must be converted to doubles. These services provide a means of creating arrays in PL/SQL Version 1. Refer to the OLE2 programmers documentation for each OLE2 automation server for the object types.
About the OLE2 package
The OLE2 package provides a PL/SQL API for creating.

Information about character set collation and the character set in general can also be obtained. enabling you to customize your applications to use local date and number format. allowing you to create applications that test for and take advantage of special cases.
Ora_NLS character constants
Use the following constants to retrieve character information about the current language. All of the constants are of type PLS_INTEGER.About the Ora_NLS package
The Ora_Nls package enables you to extract high-level information about your current language environment. name of day 6 13 fri day7_abbr abbr. name of day 7 14 sat mon1 full name of month 1 15 january mon2 full name of month 2 16 february mon3 full name of month 3 17 march mon4 full name of month 4 18 april mon5 full name of month 5 19 may mon6 full name of month 6 20 june mon7 full name of month 7 21 july mon8 full name of month 8 22 august mon9 full name of month 9 23 september mon10 full name of month 10 24 october
Forms Developer and Reports Developer Built-in Package Reference
9
. name of day 2 9 mon day3_abbr abbr. name of day 4 11 wed day5_abbr abbr. This information can be used to inspect attributes of the language. name of day 1 8 sun day2_abbr abbr. with each assigned an integer value. name of day 3 10 tue day4_abbr abbr. Name Description Integer Value day1 full name of day 1 1 sunday day2 full name of day 2 2 monday day3 full name of day 3 3 tuesday day4 full name of day 4 4 wednesday day5 full name of day 5 5 thursday day6 full name of day 6 6 friday day7 full name of day 7 7 saturday day1_abbr abbr. Facilities are also provided for retrieving the name of the current language and character set. name of day 5 12 thu day6_abbr abbr.

check for open files. and exceptions you can use when tuning your PL/SQL program units. functions. The services in this package allow you to track the amount of time pieces of your code take to run. PUTF. and operations NEW_LINE procedures enable you to write information to an open file or output it to the Interpreter.
12
Forms Developer and Reports Developer Built-in Package Reference
.
About the Text_IO package
The Text_IO Package contains constructs that provide ways to write and read information to and from files. and close open files. the FOPEN and IS_OPEN functions.About the Ora_Prof package
The Ora_Prof package contains procedures. output (write) The PUT. respectively. falling into the following categories: file operations The FILE_TYPE record. input (read) The GET_LINE procedure enables you to read operations a line from an open file. and the FCLOSE procedure enable you to define FILE_TYPE variables. There are several procedures and functions available in Text_IO. PUT_LINE. open files.

Interpret built-in:
PROCEDURE error_handler IS
Forms Developer and Reports Developer Built-in Package Reference
13
.Using Text_IO constructs example
Below is an example of a procedure that echoes the contents of a file.
About the Tool_Err package
In addition to using exceptions to signal errors..txt'. Text_IO. you can access and manipulate the error stack.Get_Line(in_file. BEGIN in_file := Text_IO. Text_IO. Text_IO. where n is the number of errors currently on the stack..Put(linebuf). EXCEPTION WHEN no_data_found THEN Text_IO. END..'). the Debug package) provide additional error information.New_Line.Fopen('echo. LOOP Text_IO.
About the Tool_Env package
The Tool_Env package allows you to interact with Oracle environment variables by retrieving their values for use in subprograms. some built-in packages (e. Using the services provided by the Tool_Err package.Fclose(in_file).g. END LOOP.Put_Line('Closing the file. This information is maintained in the form of an "error stack". 'r'). Notice that the procedure includes several calls to Text_IO constructs:
PROCEDURE echo_file_contents IS in_file Text_IO. linebuf VARCHAR2(80). Errors on the stack are indexed from zero (oldest) to n-1 (newest).File_Type. linebuf).
Using Tool_Err constructs example
The following procedure shows how you can use constructs within the Tool_Err package to handle errors generated by the Debug. The error stack contains detailed error codes and associated error messages.

PRN).RES) from a Text File (. */ WHEN OTHERS THEN IF Tool_Err.Encode('DEPLI'. then discard the error from the stack ** If the error does not match. you would have received an error alert displaying the message PDE-PLI018: Could not find library LIB1. Using Tool_Err constructs.
If the exception handling code did not make use of Tool_Err constructs. then raise it.ATTACH LIB LIB1'). the error is caught and the message is sent to the Interpreter. Tool_Err.
Building resource files
In addition to extracting Textual Data from existing resource files./* Call a built-in that interprets a command */ BEGIN Debug.Message).Interpret('.Put_Line(Tool_Err.RES) to a Text File (. ELSE RAISE. END. The resulting resource file can be used with the Tool_Res Package. print the ** message.
14
Forms Developer and Reports Developer Built-in Package Reference
.18) THEN Text_IO. The goal is to ease porting of PL/SQL code from one language to another by isolating all of the Textual Data in the resource file. you can use the following utilities to create resource files that contain Textual Data. END IF. run the utilities without supplying any arguments. EXCEPTION /* ** Check for a specific error code.PRN).Code = Tool_Err. These utilities are distributed with Oracle*Terminal and are installed automatically with this product. RESPA21 Is a utility that generates a resource file (. To display the supported command line syntax of these utilities on your platform.
About the Tool_Res package
The Tool_Res package provides you with a means of extracting string resources from a resource file.Pop. RESPR21 Is a utility that converts a resource file (.

Rfread(resfileh. hellor VARCHAR2(16). To run the executables with arguments. 'goodbye_world').PRN:
Resource "hello_world" Type "string" Content table { string string 1 12 "Hello World!" } Resource "goodbye_world" Type "string" Content table { string string 1 14 "Goodbye World!" }
resource_name
is generated into the resource file HELLO.Rfread.Rfread(resfileh. use Run. Resource File Syntax Use the following syntax when you create strings for the resource file:
Resource resource_name" Type string" Content table { string string 1 character_count "content of string" }
where: Is a unique name that you can reference with Tool_Res.Rfhandle. and referenced by the following program unit:
PROCEDURE get_res IS resfileh Tool_Res. 'hello_world'). /*Close the resource file*/
Forms Developer and Reports Developer Built-in Package Reference
15
.RES using the RESPA21 utility. HELLO. you can invoke these executables from the Explorer or File Manager to display their command line syntax.Rfopen('hello. goodbyer:=Tool_Res. /*Get the resource file strings*/ hellor:=Tool_Res. character_count Is the number of characters in the string contents.In Microsoft Windows. content of string Is the actual string.res'). Example The following Text file. goodbyer VARCHAR2(16). BEGIN /*Open the resource file we generated */ resfileh:=Tool_Res.

/*Print the resource file strings*/ Text_IO. RAW. END.
About the EXEC_SQL package
The EXEC_SQL package allows you to access multiple Oracle database servers on several different connections at the same time. Text_IO.Column_Value after fetching rows to retrieve the values in a result set Does not support CHAR.Variable_Value to retrieve the value of an OUT bind parameter Must use EXEC_SQL. you must install OCA and an appropriate ODBC driver.Put_Line(goodbyer). LONG or ROWID data Does not provide a CANCEL_CURSOR procedure or function Does not support the array interface Indicator variables are not required because nulls are fully supported as values of PL/SQL variables Does not support PL/SQL tables or record types
n
n n n n
n
For more information about the DBMS_SQL package. The EXEC_SQL package differs from the DMBS_SQL package in the following ways: n Uses bind by value instead of bind by address
n
Must use EXEC_SQL.Rfclose(resfileh).Put_Line(hellor). Connections can also be made to ODBC data sources via the Open Client Adapter (OCA). The EXEC_SQL package contains procedures and functions you can use to execute dynamic SQL within PL/SQL procedures. see your Oracle7 Application Developer's Guide or Oracle8 Application Developer's Guide.
16
Forms Developer and Reports Developer Built-in Package Reference
. To access non-Oracle data sources. which is supplied with Forms Developer. You can issue any data manipulation language (DML) or data definition language (DDL) statement using the EXEC_SQL package.Tool_Res. the SQL statements are stored in character strings that are only passed to or built by your source program at runtime. Like the DBMS_SQL package.

connection handles of type EXEC_SQL. 4 Use EXEC_SQL. cursor handles of type EXEC_SQL. then you do not need to specify the connection in the EXEC_SQL routines. EXEC_SQL. To process a statement that returns a result set:
1 For each column.Execute. If you have multiple connections simultaneously opened.Define_Column to specify the variable for receiving the value.
EXEC_SQL predefined exceptions
Forms Developer and Reports Developer Built-in Package Reference
17
.Column_Value to obtain the value of each column retrieved by EXEC_SQL.Fetch_Rows returns 0.Connection and cursor handles
In a Forms Developer application. However. which we refer to as the primary Forms Developer connection.Default_Connection is automatically called to obtain the primary Forms Developer connection. Data can be accessed after a connection and a cursor are opened. If you are only accessing data from the primary Forms Developer connection.Fetch_Rows.Fetch_Rows to retrieve a row in the result set. When you open connections to the primary database or to other databases. use EXEC_SQL. you can have several connections to one or more databases at the same time. 5 Repeat 3 and 4 until EXEC_SQL. Each connection handle can have many cursor handles. When you open a cursor on a connection handle. 3 Use EXEC_SQL.
Retrieving result sets from queries or non-Oracle stored procedures
The EXEC_SQL package is particularly useful when you need to retrieve result sets from different Oracle or ODBC data sources into one form or report. there is always one primary database connection. 2 Execute the statement by calling EXEC_SQL.ConnType are created and used to reference the connections. Each connection handle refers to one database connection. When no handle is supplied to the EXEC_SQL routine. Handles are used to reference the Oracle or ODBC connections in your Forms Developer application.CursType are created and used to reference the cursor on the given connection. it is recommended that you explicitly include the specific handles as arguments in your EXEC_SQL routines.

Define_Column. Last_Error_Code and EXEC_SQL.Package_Error Any general error. EXEC_SQL. EXEC_SQL.Invalid_Column_Numb The EXEC_SQL.An invalid connection handle is passed.
EXEC_SQL. Use EXEC_SQL.Column_Value encountered a value that is different from the original value retrieved by EXEC_SQL. EXEC_SQL.Invalid_Connection
18
Forms Developer and Reports Developer Built-in Package Reference
.Describe_Column er procedure encountered a column number that does not exist in the result set.Value_Error The EXEC_SQL.Last_Error_Mesg to retrieve the error.

If the connection is Oracle. sql_string).CursType. ret := EXEC_SQL.Using the EXEC_SQL package
Executing arbitrary SQL against any connection Copying data between two databases Executing a non-Oracle database stored procedure and fetching its result set
Executing arbitrary SQL against any connection
The following procedure passes a SQL statement and an optional connection string of the form 'user[/password][@data source]'. but if the connection is a non-Oracle data source.Parse the SQL statement on the given connection. otherwise it implements it against the primary Forms Developer connection.Open a new connection. -.CLOSE_CURSOR(connection_id. -.
-. If the connection string is empty. cursor_number).OPEN_CONNECTION(connection_string). any DDL is done at parse time. ret PLS_INTEGER.
PROCEDURE exec (sql_string IN VARCHAR2. EXEC_SQL.And execute it. -. cursor_number EXEC_SQL.OPEN_CURSOR(connection_id). -.EXECUTE(connection_id. assume the user wants to use the primary Forms Developer connection. cursor_number).Close the cursor. this is not guaranteed. -.Open a cursor on the connection for executing the SQL statement. connection_string IN VARCHAR2 DEFAULT NULL) IS connection_id EXEC_SQL.
Forms Developer and Reports Developer Built-in Package Reference
19
. If a connection string is passed. cursor_number. ELSE connection_id := EXEC_SQL.CLOSE_CONNECTION(connection_id).PARSE(connection_id. END IF. cursor_number := EXEC_SQL. BEGIN IF connection_string IS NULL THEN connection_id := EXEC_SQL. The connection_id we have may come from calling EXEC_SQL.DEFAULT_CONNECTION.And we are done with the connection. EXEC_SQL.OPEN_CONNECTION or
EXEC_SQL.ConnType. the procedure executes the SQL statement against the data source.

EXEC_SQL.DEFAULT_CONNECTION. END. -. If the connection_id was obtained by EXEC_SQL. IF EXEC_SQL.EXCEPTION WHEN EXEC_SQL. and denotes an unexpected error in one of the calls.CLOSE_CURSOR(connection_id.CLOSE_CONNECTION will terminate that connection. END IF. EXEC_SQL.OPEN_CONNECTION.DEFAULT_CONNECTION. EXEC_SQL. cursor_number).
EXEC_SQL.IS_CONNECTED(connection_id) THEN IF EXEC_SQL.LAST_ERROR_MESG(connection_id)). Regardless. we should call EXEC_SQL.LAST_ERROR_CODE (connection_id)) || '): ' || EXEC_SQL.This is the general error raised by the EXEC_SQL package.
20
Forms Developer and Reports Developer Built-in Package Reference
. but it frees up EXEC_SQL package specific resources. cursor_number) THEN EXEC_SQL.PACKAGE_ERROR THEN TEXT_IO. If the connection_id was obtained by EXEC_SQL. It prints the error number and error message to standard out.PUT_LINE('ERROR (' || TO_CHAR(EXEC_SQL.CLOSE_CONNECTION.CLOSE_CONNECTION will NOT terminate that connection.IS_OPEN(connection_id.CLOSE_CONNECTION(connection_id). END IF.

birthdate DATE.
Forms Developer and Reports Developer Built-in Package Reference
21
.DEFINE_COLUMN(source_connid. 3. destination_connid EXEC_SQL.PARSE(source_connid. source_connection IN VARCHAR2 DEFAULT NULL.OPEN_CONNECTION(destination_connection).Prepare a cursor to insert into the destination table.
-. id). ignore := EXEC_SQL.CURR_CONNECTION.EXECUTE(source_connid.CursType. source_cursor. ELSE source_connid := EXEC_SQL. END IF. 2. 1. EXEC_SQL.CursType. ignore PLS_INTEGER BEGIN IF source_connection IS NULL THEN source_connid := EXEC_SQL. source_cursor. source_cursor).Prepare a cursor to select from the source table.PARSE(destination_connid. The procedure copies the rows from the source table (on the source connection) to the destination table (on the destination connection).OPEN_CONNECTION(source_connection).OPEN_CURSOR(source_connid).
-. destination_cursor.
-. EXEC_SQL. name VARCHAR2(30). It assumes the source and destination tables have the following columns:
ID of type NUMBER NAME of type VARCHAR2(30) BIRTHDATE of type DATE PROCEDURE copy (source_table IN VARCHAR2. If the user does not specify a secondary connection. but it illustrates the concepts in the EXEC_SQL package. source_cursor. END IF. the primary Forms Developer connection is used. EXEC_SQL.ConnType. source_connid EXEC_SQL. ELSE destination_connid := EXEC_SQL. EXEC_SQL. source_cursor. destination_cursor := EXEC_SQL. birthdate). destination_connection IN VARCHAR2 DEFAULT NULL) IS id NUMBER. EXEC_SQL. destination_table IN VARCHAR2.OPEN_CURSOR(destination_connid). destination_cursor EXEC_SQL. 30). source_cursor EXEC_SQL. name.DEFINE_COLUMN(source_connid. source_cursor := EXEC_SQL.ConnType.DEFINE_COLUMN(source_connid. name. 'SELECT id. birthdate FROM ' || source_table).DEFAULT_CONNECTION. IF destination_connection IS NULL THEN destination_connid := EXEC_SQL.Copying data between two databases
The following procedure does not specifically require the use of dynamic SQL.Open the connections.

minimized.xls'. which should be separated from the application program name with a space. or maximized size. then the following directories are searched in the order shown below: n current directory
n n n
Windows directory Windows system directory directory containing the executable file for the current task
For AppName.App_Mode_Maximized Start the application window in maximized size.exe emp.App_End
Description Ends an application program started by Dde_App_Begin.App_End (AppID PLS_INTEGER).App_Begin('c:\excel\excel. END. Usage Notes The application name may contain a path. The application may be started in either normal. If the application name does not contain a path.App_Mode_Minimized).
DDE. as specified by AppMode. BEGIN AppID := DDE.App_Begin. DDE. the application program name may be followed by arguments.App_Focus for that application window. Returns An application identifier. Syntax
PROCEDURE DDE.
DDE.
Parameters AppID
The application identifier returned by DDE. The application identifier returned by DDE.
30
Forms Developer and Reports Developer Built-in Package Reference
.xls loaded */ DECLARE AppID PLS_INTEGER.App_End and DDE.App_Begin example
/* ** Start MS Excel with spreadsheet emp.App_Begin must be used in all subsequent calls to DDE.

exe emp. END. DDE. DDE.App_Focus(AppID). DDE.App_Focus example
/* ** Start Excel. you must have previously called DDE. by clicking within the application window. DDE. BEGIN AppID := DDE.App_End example
/* ** Start Excel.exe'. Syntax
PROCEDURE DDE.App_Focus
Description Activates an application program started by DDE.
DDE. .xls'. BEGIN AppID := DDE.
Parameters AppID
The application identifier returned by DDE.Usage Notes The application may also be terminated in standard Windows fashion: for example.
Forms Developer and Reports Developer Built-in Package Reference
31
. perform some operations on the ** spreadsheet.App_End.App_Begin.App_Focus (AppID PLS_INTEGER).
Usage Notes The application may also be activated in standard Windows fashion: for example.App_Begin to start the application program..App_Begin to start the application program in order to end it using DDE.
DDE.App_Mode_Normal). */ DECLARE AppID PLS_INTEGER. by double-clicking the Control menu. then close the application.App_Begin('c:\excel\excel. To activate an application program using DDE. then activate the application window */ DECLARE AppID PLS_INTEGER. You must have previously called DDE.App_Begin.App_Mode_Maximized).
DDE.App_Begin('c:\excel\excel.App_End(AppID).App_Focus..

DDE.
Parameters ConvID CmdStr Timeout
The DDE Conversation identifier returned by DDE. in milliseconds.Execute example
/* ** Initiate Excel. Timeout PLS_INTEGER).now()]'. then perform a recalculation */ DECLARE ConvID PLS_INTEGER. BEGIN ConvID := DDE.Execute(ConvID.g.Execute (ConvID PLS_INTEGER.. that this routine waits for a response from the DDE server application.
DDE.END.xls'). a negative number). DDE. Syntax
PROCEDURE DDE.Initiate('EXCEL'. The timeout duration. then the default value of 1000 ms is used. END.
DDE.Getformatnum
Description Translates or registers a specified data format name and returns the numeric representation of the data format string. 1000).
Usage Notes The value of CmdStr depends on what values are supported by the server application. Timeout specifies the maximum length of time. Syntax
32
Forms Developer and Reports Developer Built-in Package Reference
. 'abc. in milliseconds.Execute
Description Executes a command string that is acceptable to the receiving server application. The command string to be executed by the server. CmdStr VARCHAR2. If you specify an invalid number (e. '[calculate.Initiate.

BEGIN FormatNum := DDE.Getformatstr returns a data format name if the data format number is valid. Returns The string representation of the supplied data format number.Getformatnum registers it and returns a unique format number. Valid format numbers include the predefined formats and any user-defined formats that were registered with DDE.
Parameters DataFormatName
The data format name string.
Forms Developer and Reports Developer Built-in Package Reference
33
. END.
DDE.
Parameters DataFormat-Num A data format number. If the specified name has not been registered yet.Poke and DDE.Getformatnum('CF_TEXT').
Usage Notes DDE.FUNCTION DDE.Getformatstr
Description Translates a data format number into a format name string. This number can be used in DDE.Getformatstr (DataFormatNum PLS_INTEGER) RETURN VARCHAR2. MyFormatNum PLS_INTEGER.Request transactions to represent the DataFormat variable.Getformatnum.Getformatnum('MY_FORMAT').Getformatnum converts a data format from a string to a number.Request transaction that is not one of the predefined formats. MyFormatNum := DDE.
DDE. then DDE.Getformatnum (DataFormatName VARCHAR2) RETURN PLS_INTEGER. Usage Notes DDE. This is the only way to use a format in a DDE.Getformatnum example
/* ** Get predefined format number for "CF_TEXT" (should ** return CF_TEXT=1) then register a user-defined ** data format called "MY_FORMAT" */ DECLARE FormatNum PLS_INTEGER. Syntax
FUNCTION DDE.Poke or DDE.

Initiate must be used in all subsequent calls to DDE. Topic is usually the document filename.Getformatstr(CF_TEXT).Getformatstr example
/* ** Get a data format name (should return the string ** 'CF_TEXT') */ DECLARE FormatStr VARCHAR2(80).Terminate for that conversation. BEGIN
34
Forms Developer and Reports Developer Built-in Package Reference
. The conversation identifier returned by DDE.Initiate
Description Opens a DDE conversation with a server application.Request. DDE.
DDE.
DDE.
Returns A DDE Conversation identifier.Terminate to terminate the conversation. For applications that operate on file-based documents. in addition.Initiate (Service VARCHAR2. The topic name for the conversation. the System topic is usually supported by each service. An application may start more than one conversation at a time with multiple services and topics.Poke.Initiate example
/* ** Open a DDE Conversation with MS Excel on ** topic abc. Syntax
FUNCTION DDE.Execute. and DDE.DDE.
Parameters Service Topic
The server application's DDE Service code. BEGIN FormatStr := DDE. DDE. END. Service is usually the name of the application program. Use DDE. provided that the conversation identifiers are not interchanged. Usage Notes The values of Service and Topic depend on the values supported by a particular DDE server application. Topic VARCHAR2) RETURN PLS_INTEGER.xls */ DECLARE ConvID PLS_INTEGER.

ConvID := DDE.Initiate('EXCEL', 'abc.xls'); END;

DDE.IsSupported
Description Confirms that the DDE package is supported on the current platform. Syntax
DDE.ISSUPPORTED

Returns TRUE, if DDE is supported on the platform; FALSE if it is not.

DDE.IsSupported example
/* ** ** ** */ IF Before calling a DDE object in platform independent code, use this predicate to determine if DDE is supported on the current platform.

The DDE Conversation identifier returned by DDE.Initiate. The data item name to which the data is to be sent. The data buffer to send. The format of outgoing data. The time-out duration in milliseconds.

Usage Notes The value of Item depends on what values are supported by the server application on the current conversation topic. The predefined data format constants may be used for DataFormat. A user-defined format that was registered with DDE.Getformatnum may also be used, provided that the server application recognizes this format. The user is responsible for ensuring that the server application will process the specified data format. Timeout specifies the maximum length of time, in milliseconds, that this routine waits for a response from the DDE server application. If you specify an invalid number (e.g., a negative number), then the default value of 1000 ms is used.

The DDE Conversation identifier returned by DDE.Initiate. Is requested data item name. The result data buffer. The format of the requested buffer. The timeout duration in milliseconds.

Usage Notes The value of Item depends on what values are supported by the server application on the current conversation topic. The user is responsible for ensuring that the return data buffer is large enough for the requested data. If the buffer size is smaller than the requested data, the data is truncated. The predefined data format constants may be used for DataFormat. A user-defined format that was registered with DDE.Getformatnum may also be used, provided that the server application recognizes this format. It is the user's responsibility to ensure that the server application will process the specified data format. Timeout specifies the maximum length of time, in milliseconds, that this routine waits for a response from the DDE Server application. If the user specifies an invalid number, such as negative number, then the default value of 1000 ms is used.

DDE. DDE..Execute. END. all subsequent calls to DDE.
38
Forms Developer and Reports Developer Built-in Package Reference
. 'abc.xls perform some operations. .Usage Notes After the DDE. DDE. then terminate ** the conversation */ DECLARE ConvID PLS_INTEGER.Terminate. and DDE.Terminate using the terminated conversation identifier will result in an error. To terminate a conversation with a server application using DDE. you must have used DDE.Request.Terminate call.Terminate example
/* ** Open a DDE Conversation with MS Excel on topic ** abc.xls'). BEGIN ConvID := DDE.Terminate(ConvID). DDE..Initiate('EXCEL'.Initiate to start the conversation.Poke.

Setx Debug.
Debug.Suspend
Debug.
Debug.Getn('my_sal') > 5000 THEN RAISE Debug.Break
Description Used to enter a breakpoint from within a debug trigger.Break Debug.Debug Package
Debug package
Debug.
Forms Developer and Reports Developer Built-in Package Reference
39
.Getx
Description Retrieve the value of the specified local variable. When the exception is raised.Break. END IF. Syntax
Debug.Interpret Debug.Getx Debug. control is passed to the Interpreter as if you had entered a breakpoint at the debug trigger location.Break EXCEPTION.
Usage Notes Debug.Break is very useful for creating conditional breakpoints.Break example
/* ** Create a breakpoint only when the value ** of 'my_sal' exceeds 5000 */ IF Debug.

Usage Notes This is useful when you want to determine a local's value from within a debug trigger.
Parameters varname
Debug. Procedure foo passes a unique argument of 'hello world' to bar.Getx examples
/* ** Retrieve the value of the variable 'my_ename' ** and use it to test a condition */ IF Debug. FUNCTION Debug. DATE.Syntax
FUNCTION Debug. PLS_INTEGER.
A VARCHAR2 or CHAR (Debug.
You have a program unit foo that calls the subprogram bar. FUNCTION Debug. FUNCTION Debug.Getc (varname VARCHAR2) RETURN VARCHAR2.Getd (varname VARCHAR2) RETURN DATE.TRIGGER PROC bar LINE 3 IS >BEGIN > IF Debug. Consider the situation where procedure bar accepts the argument 'message' from the many procedures that call it.Getn!('message') = 'hello world' THEN > RAISE Debug.Getn (varname VARCHAR2) RETURN NUMBER.
40
Forms Developer and Reports Developer Built-in Package Reference
.Getc('my_ename') = 'JONES' THEN RAISE Debug. END IF.Break.Geti (varname VARCHAR2) RETURN PLS_INTEGER. That subprogram (bar) is also called by many other program units. >END. In this case.Getc converts CHAR values to VARCHAR2).Break. we could define a trigger that raises a breakpoint in procedure bar only when foo passes its argument: PL/SQL> . or NUMBER variable. > END IF.

You want to create a breakpoint in bar. To do this. The following example creates a breakpoint which fires a trigger each time the breakpoint is hit.
Forms Developer and Reports Developer Built-in Package Reference
41
.SHOW LOCALS').enable break 1').Interpret examples
/* ** Execute the command SHOW STACK when ** a condition is met */ IF Debug.
PL/SQL> . That subprogram (bar) is also called by many other program units.SHOW LOCALS').Interpret('.go'). Syntax
PROCEDURE Debug.Interpret
Description Executes the PL/SQL statement or Procedure Builder Interpreter command string contained in input as if it had been typed into the Interpreter.Debug.break proc my_proc line 10 trigger +> DEBUG.
Debug. END IF.BREAK PROC foo LINE 6 TRIGGER >BEGIN > Debug. > Debug.Interpret('.
Parameters input A Procedure Builder command string. Usage Notes This is useful for automatically invoking Procedure Builder functions from a debug trigger. you need to perform the following steps: 1 Create a breakpoint in procedure bar where you want to suspend execution. 2 Disable the breakpoint you just created.INTERPRET('. >END. Create a breakpoint with a breakpoint trigger in procedure foo that enables the first breakpoint we created in procedure bar.Interpret('. For example: PL/SQL>.
You have a program unit foo that calls the subprogram bar. but you only want to enable the breakpoint when the subprogram is called from foo and not when it is called from other program units. You can perform both steps 1 and 2 from within the Breakpoint dialog box.Getc('my_ename') = 'JONES' THEN Debug.Interpret (input VARCHAR2).

Debug. PROCEDURE Debug.Setx examples
/* ** Set the value of the local variable 'my_emp' from a ** Debug Trigger */ Debug. Syntax
PROCEDURE Debug. Usage Notes This is useful when you want to change a local's value from a debug trigger. Syntax
PROCEDURE Debug.
42
Forms Developer and Reports Developer Built-in Package Reference
.Setc converts CHAR values to VARCHAR2). PLS_INTEGER. or NUMBER variable.Setc (varname VARCHAR2. '02-OCT-94').Suspend
Description Suspends execution of the current program unit and transfers control to the Interpreter. newvalue An appropriate value for varname. newvalue NUMBER).Setd (varname VARCHAR2. DATE.Setd('my_date'.
Parameters varname
Debug. newvalue VARCHAR2).Setc('my_emp'.Suspend. newvalue PLS_INTEGER).Setx
Description Set the value of a local variable to a new value. 'SMITH').
A VARCHAR2 or CHAR (Debug. newvalue DATE).Debug.Seti (varname VARCHAR2.Setn (varname VARCHAR2. PROCEDURE Debug. /* ** Set the value of the local variable 'my_date' from a ** Debug Trigger */ Debug. PROCEDURE Debug.

Variable_Value EXEC_SQL. EXEC_SQL.Open_Connection EXEC_SQL.More_Result_Sets EXEC_SQL.Default_Connection EXEC_SQL.Curr_Connection EXEC_SQL.Column_Value EXEC_SQL.Execute_And_Fetch EXEC_SQL.Is_OCA_Connection EXEC_SQL.Is_Connected EXEC_SQL.Describe_Column EXEC_SQL.Last_Error_Mesg
Forms Developer and Reports Developer Built-in Package Reference
45
.Parse EXEC_SQL.Last_Error_Position EXEC_SQL. EXEC_SQL.Last_Error_Code EXEC_SQL.Is_Open EXEC_SQL.Bind_Variable EXEC_SQL.EXEC_SQL Package
EXEC_SQL package
The functions and procedures are listed in the order they are usually called in a session.Open_Cursor EXEC_SQL.Execute EXEC_SQL.Last_Row_Count EXEC_SQL.Fetch_Rows EXEC_SQL.Define_Column EXEC_SQL.Last_SQL_Function_Code EXEC_SQL.Close_Connection The following functions retrieve information about the last referenced cursor in a connection after a SQL statement execution.Close_Cursor EXEC_SQL.

Data source IN VARCHAR2) RETURN EXEC_SQL.
EXEC_SQL. EXEC_SQL. BEGIN --.Open_Connection
FUNCTION EXEC_SQL.ConnType.a connection string is typically of the form 'username/password@database_alias' -connection_id := EXEC_SQL.Curr_Connection
Description Returns a connection handle that uses the same database connection originally established by Forms Developer. ...
EXEC_SQL.conntype -connection_id EXEC_SQL.
46
Forms Developer and Reports Developer Built-in Package Reference
.Curr_Connection.Open_Connection example
PROCEDURE getData IS --.EXEC_SQL. .. END.OPEN_CONNECTION('connection_string').Open_Connection (Username IN VARCHAR2.CONNTYPE. Password IN VARCHAR2.
Parameters Connstr Username Password Data source
Is a string in the form 'User[/Password][@database_string]' A string specifying the user name used to connect to the database A string specifying the password for the user name Either a string specifying the SQLNet alias or the OCA connection starting with 'ODBC:'
Returns A handle to the new database connection..Default_Connection replaces EXEC_SQL.a connection handle must have a datatype of EXEC_SQL.

Syntax
FUNCTION EXEC_SQL.Curr_Connection RETURN EXEC_SQL.ConnType;

Returns A handle to the primary Forms Developer connection. Usage notes Use EXEC_SQL.Default_Connection in place of EXEC_SQL.Curr_Connection. For backward compatibility, EXEC_SQL.Curr_Connection is still supported.

Returns A handle to the primary Forms Developer connection. Usage notes The default connection is the primary Forms Developer connection. The first time EXEC_SQL.Default_Connection is called, the default connection is found, placed in a cache within the EXEC_SQL package, and a handle is returned to the user. Subsequent calls to EXEC_SQL.Default_Connection simply retrieves the handle from the cache. Since this connection handle is cached, if you are accessing data from only the default connection, then you do not need to explicitly specify the connection handle in calls to other EXEC_SQL methods; EXEC_SQL automatically looks up the cache to obtain the connection handle. To clear the cache, call EXEC_SQL.Close_Connection on the connection handle that is obtained from calling EXEC_SQL.Default_Connection. For default connections, EXEC_SQL.Close_Connection does not terminate the connection, but only frees up the resources used by EXEC_SQL.

EXEC_SQL.Open_Cursor
Description Creates a new cursor on a specified connection and returns a cursor handle. When you no longer need the cursor, you must close it explicitly by using EXEC_SQL.Close_Cursor. Syntax

Is the handle to the connection you want to use. If you do not specify a connection, EXEC_SQL.Default_Connection retrieves the primary Forms Developer connection handle from the cache.

Returns A handle to the new cursor. Usage Notes You can use cursors to execute the same SQL statement repeatedly (without reparsing) or to execute a new SQL statement (with parsing). When you reuse a cursor for a new statement, the cursor contents are automatically reset when the new statement is parsed. This means you do not have to close and reopen a cursor before reusing it.

EXEC_SQL.Parse
Description This procedure parses a statement on a specified cursor. Syntax

Forms Developer and Reports Developer Built-in Package Reference

49

--.CONNTYPE..
50
Forms Developer and Reports Developer Built-in Package Reference
. sqlstr VARCHAR2(1000).Parse ([Connid IN CONNTYPE.OPEN_CONNECTION(connect_str). For non-Oracle data sources.the statement to be parsed is stored as a VARCHAR2 variable -sqlstr := 'select ename from emp'. Unlike OCI parsing.. This means you should always parse and execute all DDL statements in EXEC_SQL. the DDL may be executed on the parse or on the execute. BEGIN connection_id := EXEC_SQL. The SQL statement to be parsed. . Statement IN VARCHAR2 [Language IN PLS_INTEGER]). cursorID EXEC_SQL.PROCEDURE EXEC_SQL. A flag that determines how Oracle handles the SQL statement. EXEC_SQL. EXEC_SQL parsing is always immediate. It should not include a final semicolon.Parse example
PROCEDURE getData IS connection_id EXEC_SQL. You cannot defer EXEC_SQL parsing.CURSTYPE.] Curs_Id IN CURSTYPE. Parsing checks the syntax of the statement and associates it with the cursor in your code.
EXEC_SQL. cursorID := EXEC_SQL. For Oracle data sources. the DDL statements are executed on the parse. Is the cursor handle you want to assign the statement to. If you do not specify a connection. The valid flags are: V6 Specifies Oracle V6 behavior V7 Specifies Oracle V7 behavior NATIVE Default
Usage Notes All SQL statements must be parsed using the Parse procedure.Default_Connection retrieves the primary Forms Developer connection handle from the cache.
Parameters Connid
Curs_Id Statement Language_flag
Is the handle to the connection you want to use.OPEN_CURSOR(connection_id). You can parse any data manipulation language (DML) or data definition language (DDL) statement.

Contains the name of the column. The positions are numbered from left to right.Invalid_Column_Number exception is raised. on output. EXEC_SQL..Describe_Column ([Connid IN CONNTYPE. The valid values are one the following: EXEC_SQL. Type OUT PLS_INTEGER]). exec_sql. If you do not specify a connection.ROWID_TYPE
Forms Developer and Reports Developer Built-in Package Reference
51
. Contains the maximum length of the column in bytes. sqlstr.--.Default_Connection retrieves the primary Forms Developer connection handle from the cache.
Parameters Connid
Curs_Id Position
Name Collen Type
Is the handle to the connection you want to use. If you try to describe a column number that does not exist in the result set. Contains the type of the column..FLOAT_TYPE EXEC_SQL. cursorID. on output.VARCHAR2_TYPE EXEC_SQL. Curs_Id IN CURSTYPE. the EXEC_SQL. Name OUT VARCHAR2. Position IN PLS_INTEGER. Is the position in the result set of the column you want to describe. Is the cursor handle associated to the column you want to describe.NUMBER_TYPE EXEC_SQL. on output. .V7).Describe_Column
Description Obtains information about the columns in a result set of a parsed SQL statement. Tip Syntax
PROCEDURE EXEC_SQL.perform parsing -EXEC_SQL.LONG_TYPE EXEC_SQL.
EXEC_SQL. END. starting at 1.PARSE(connection_id. Collen OUT PLS_INTEGER.

END. . For IN and IN/OUT variables. END IF. Name IN VARCHAR2. Is the cursor handle in which to bind the variable. the data is actually ignored but you must still use Bind_Variable to indicate the type of PL/SQL variable to be retrieved later by Variable_Value.IF (nColumns <= 0) THEN TEXT_IO. Syntax
PROCEDURE EXEC_SQL. Curs_Id IN CURSTYPE.Bind_Variable ([Connid IN CONNTYPE]. If you do not specify a connection. Is the name of the variable in the SQL statement.
Parameters Connid
Curs_Id Name Value
Is the handle to the connection you want to use.
EXEC_SQL. EXEC_SQL.. Out_Value_Size IN PLS_INTEGER).Bind_Variable ([Connid IN CONNTYPE]..PUT_LINE('No columns returned in query').
54
Forms Developer and Reports Developer Built-in Package Reference
. cursor_number). Value IN VARCHAR2. the value is the data you want to bind to the named variable. EXEC_SQL. Name IN VARCHAR2.Default_Connection retrieves the primary Forms Developer connection handle from the cache.CLOSE_CONNECTION(connection_id).Bind_Variable
Description Binds a given value to a named variable in a SQL statement. Value IN <datatype>). For OUT variables. Curs_Id IN CURSTYPE.CLOSE_CURSOR(connection_id. EXEC_SQL.
where <datatype> can be one of the following:
NUMBER DATE VARCHAR2 PROCEDURE EXEC_SQL.

the bind_variable procedure assigns the value of the input argument to the named -.
The corresponding EXEC_SQL. --.OPEN_CURSOR(connection_id). --.
EXEC_SQL. cursor_handle.Bind_Variable example
PROCEDURE getData(input_empno NUMBER) IS connection_id EXEC_SQL. For each output placeholder.the statement to be parsed contains a bind variable -sqlstr := 'select ename from emp where empno = :bn'. -EXEC_SQL.Bind_Variable procedure is:
BIND_VARIABLE(connection_handle. You must also use placeholders for output values if the statement is a PL/SQL block or a call to a stored procedure with output parameters. exec_sql. the string ':X' is the bind variable in the following SQL statement:
SELECT ename FROM emp WHERE SAL > :X. .perform parsing -EXEC_SQL. The input placeholder or bind variable in a SQL statement is identified by a name beginning with a colon.DEFINE_COLUMN(connection_id. input_empno). ':X'.CURSTYPE.
Forms Developer and Reports Developer Built-in Package Reference
55
. The bind_variable procedure is called after the parse procedure. Note the use of the semi-colon and the quotes to designate the -. BEGIN connection_id := EXEC_SQL. EXEC_SQL. 3500).bind variable..CONNTYPE. cursorID := EXEC_SQL.Bind_Variable to supply the value. Usage Notes Use placeholders in SQL statements to mark where input data is to be supplied during runtime. If no size is specified.PARSE(connection_id.OPEN_CONNECTION(connect_str). For each input placeholder. sqlstr.V7). sqlstr VARCHAR2(1000).Bind_Variable to specify the type of variable to use for retrieving the value in subsequent EXEC_SQL.. 1.Out_Value_Size The maximum OUT value size in bytes expected for the VARCHAR2 OUT or IN/OUT variables. cursorID EXEC_SQL. mynum). For example. you must also use EXEC_SQL.bind variable. cursorID. cursorID.Variable_Value calls. cursorID. the current length of the Value parameter is used. --.BIND_VARIABLE(connection_id. you must use EXEC_SQL. ':bn'.

Default_Connection retrieves the primary Forms Developer connection handle from the cache. Is the relative position of the column in the row or result set.
where <datatype> can be one of the following:
NUMBER DATE VARCHAR2 PROCEDURE EXEC_SQL.Define_Column ([Connid IN CONNTYPE]. The column is identified by its relative position in the result set. Curs_Id IN CURSTYPE.Define_Column ([Connid IN CONNTYPE]. Curs_Id IN CURSTYPE. Column IN <datatype>). Is the cursor handle you want to define the column for. Column IN VARCHAR2.
Parameters Connid
Curs_Id Position
Column
Column_Size
Is the handle to the connection you want to use. Syntax
PROCEDURE EXEC_SQL.Define_Column
Description This procedure is used only with SELECT statements or calls to nonOracle stored procedures that return a result set. END. EXEC_SQL. Column_Size IN PLS_INTEGER). Is the value of the column being defined. the first relative position is identified by the integer 1.
EXEC_SQL.. If you do not specify a connection.. It defines a column to be fetched from a specified cursor. Position IN PLS_INTEGER. Is the maximum expected size of the column
56
Forms Developer and Reports Developer Built-in Package Reference
. Position IN PLS_INTEGER.. The actual value stored in the variable is ignored. The first column in the statement has a relative position of 1. The value type determines the column type being defined. The PL/SQL type of the Column parameter determines the type of the column being defined.

EXEC_SQL. --.is important to specify the maximumn length.OPEN_CONNECTION(connect_str).CURSTYPE.sql_str. cursorID. EXEC_SQL.relative positions of the columns being returned from the select statement.DEFINE_COLUMN(connection_id. -. cursorID.
EXEC_SQL. 1.PARSE(connection_id.or a date.variables to store the returned values. 30). 3.Define_Column example
PROCEDURE getData IS connection_id EXEC_SQL.
Forms Developer and Reports Developer Built-in Package Reference
57
.query ..value in bytes (for column type VARCHAR2 only) Usage Notes For a query. loc_eno NUMBER. sqlstr. We must use local -. . cursorID := EXEC_SQL.these are variables local to the procedure. loc_eno).. exec_sql. cursorID.used to store the return values from our desired loc_hiredate DATE. sqlstr VARCHAR2(1000).Execute
Description Executes the SQL statement at a specified cursor.. We obtain the -. For a result value that is a number -. hiredate from emp '.BIND_VARIABLE(connection_id. sqlstr := 'select ename. cursorID. -.DEFINE_COLUMN(connection_id. END. EXEC_SQL.we make one call to DEFINE_COLUMN per item in the select list. For a result value that is a VARCHAR. there is no need to specify the maximum length. -.DEFINE_COLUMN(connection_id. -. loc_ename. BEGIN connection_id := EXEC_SQL.
EXEC_SQL. you must define the column before retrieving its data by EXEC_SQL. it -. loc_hiredate).. 2. empno.V7). input_empno). cursorID. EXEC_SQL.CONNTYPE.OPEN_CURSOR(connection_id). ':bn'.Column_Value. loc_ename VARCHAR2(30). cursorID EXEC_SQL. -EXEC_SQL.

loc_eno NUMBER. 30). EXEC_SQL.
EXEC_SQL. cursorID EXEC_SQL. empno. loc_ename VARCHAR2(30).BIND_VARIABLE(connection_id. cursorID := EXEC_SQL. cursorID.EXECUTE(connection_id. you -.
Returns The number of rows processed.OPEN_CONNECTION(connect_str). EXEC_SQL. Usage Notes The return value is only valid for INSERT.are ready to execute the statement.Syntax
FUNCTION EXEC_SQL. exec_sql. loc_ename.
58
Forms Developer and Reports Developer Built-in Package Reference
. if necessary.PARSE(connection_id. sqlstr VARCHAR2(1000). hiredate from emp '. ':bn'. EXEC_SQL.
Parameters Connid
Curs_Id
Is the handle to the connection you want to use. UPDATE and DELETE statements.DEFINE_COLUMN(connection_id. loc_eno). -nIgn := EXEC_SQL. Curs_Id IN CURSTYPE) RETURN PLS_INTEGER. BEGIN connection_id := EXEC_SQL. cursorID). If you do not specify a connection. sqlstr.CONNTYPE.statement and its result set is encapsulated in the cursor referenced as cursorID. input_empno). 1. cursorID. EXEC_SQL. --. For other statements.OPEN_CURSOR(connection_id). ignore the return value because it is undefined. EXEC_SQL. cursorID.. cursorID. 2. sqlstr := 'select ename.V7). including DDL. loc_hiredate DATE.Execute example
PROCEDURE getData IS connection_id EXEC_SQL. .after parsing. and calling BIND_VARIABLE and DEFINE_COLUMN. loc_hiredate).Default_Connection retrieves the primary Forms Developer connection handle from the cache. Note that all information about the -.DEFINE_COLUMN(connection_id.. EXEC_SQL. 3.CURSTYPE.DEFINE_COLUMN(connection_id. cursorID. Is the cursor handle to the SQL statement you want to execute. nIgn PLS_INTEGER.Execute ([Connid IN CONNTYPE].

Calling EXEC_SQL.
Parameters Connid
Curs_Id Exact
Is the handle to the connection you want to use. loc_hiredate DATE. loc_ename VARCHAR2(30). The default is FALSE. BEGIN
Forms Developer and Reports Developer Built-in Package Reference
59
. It executes a SQL statement at a specified cursor and retrieves the first row that satisfies the query.CURSTYPE. Exact IN BOOLEAN DEFAULT FALSE) RETURN PLS_INTEGER. The row is retrieved even if the exception is raised.Execute_And_Fetch may reduce the number of round-trips when used against a remote database. loc_eno NUMBER.Fetch_Rows. ..
EXEC_SQL.Execute and then EXEC_SQL. sqlstr VARCHAR2(1000).. Set to TRUE to raise the exception EXEC_SQL.. cursorID EXEC_SQL. Syntax
FUNCTION EXEC_SQL. END.Execute_And_Fetch example
PROCEDURE getData(input_empno NUMBER) IS connection_id EXEC_SQL. Is the cursor handle to the SQL statement you want to execute. nIgn PLS_INTEGER.Execute_And_Fetch
Description This function calls EXEC_SQL.
Returns The number of rows fetched (either 0 or 1)...Package_Error. EXEC_SQL.CONNTYPE.Default_Connection retrieves the primary Forms Developer connection handle from the cache.Execute_And_Fetch ([Connid IN CONNTYPE]. Curs_Id IN CURSTYPE.
EXEC_SQL. If you do not specify a connection.

--.
EXEC_SQL.More_Result_Sets example
PROCEDURE esmoreresultsets(sqlstr VARCHAR2) IS
62
Forms Developer and Reports Developer Built-in Package Reference
. Is the cursor handle to the SQL statement from which you want to fetch.More_Result_Sets ([Connid IN CONNTYPE]. END IF.More_Result_Sets
Description This function applies to non-Oracle connections only. we keep track of the number of rows returned.. It determines if there is another result set to retrieve for a specified cursor.END LOOP. the function always returns FALSE.between these cases.
Returns TRUE or FALSE Usage Notes If used against Oracle databases. Curs_Id IN CURSTYPE) RETURN BOOLEAN. To distinguish -. This could have happen because -. EXEC_SQL. if required. . END. If you do not specify a connection. the function initializes the result set and returns TRUE.Default_Connection retrieves the primary Forms Developer connection handle from the cache.
Parameters Connid
Curs_Id
Is the handle to the connection you want to use.
EXEC_SQL. Syntax
FUNCTION EXEC_SQL.Fetch_Rows to retrieve the data.the query was incorrect or because there were no more rows.The loop terminates when FETCH_ROWS returns 0. If a non-Oracle stored procedure has another result set to retrieve.Describe_Column to obtain information about the new result set and EXEC_SQL. Use EXEC_SQL. -IF (nRows <= 0) THEN TEXT_IO.PUT_LINE ('Warning: query returned no rows')..

. sqlstr may contain a batch of queries.Column_Value
Description This procedure returns the value of the cursor for a given position in a given cursor. EXEC_SQL.v7).PUT_LINE(' no more result sets ').
EXEC_SQL.. --. curID) > 0) LOOP nRows := nRows + 1. [Actual_Length OUT PLS_INTEGER]).. curID.CONNTYPE. BEGIN --.Column_Value ([Connid IN CONNTYPE].OPEN_CONNECTION('connection_str_ODBC'). curID)) THEN TEXT_IO. Curs_Id IN CURSTYPE. --. [Column_Error OUT NUMBER].
where <datatype> is one of the following:
NUMBER DATE
Forms Developer and Reports Developer Built-in Package Reference
63
. curID := EXEC_SQL.FETCH_ROWS(conidODBC.CLOSE_CONNECTION(conidODBC). ELSE TEXT_IO.for some non-Oracle databases.MORE_RESULT_SETS checks for additional result sets -IF (EXEC_SQL. . nRes PLS_INTEGER. curID).an ODBC connection string.. END.. nRes := EXEC_SQL. Position IN PLS_INTEGER. END IF.EXECUTE(conidODBC. Syntax
PROCEDURE EXEC_SQL. EXEC_SQL.conidODBC EXEC_SQL.OPEN_CURSOR(conidODBC). exec_sql. nRows PLS_INTEGER := 0 . curID EXEC_SQL.MORE_RESULT_SETS(conidODBC. It is used to access the data fetched by calling EXEC_SQL. -. END LOOP. Value OUT <datatype>.CURSTYPE.PARSE(conidODBC.Fetch_Rows.PUT_LINE(' more result sets ').obtain results from first query in sqlstr WHILE (EXEC_SQL. sqlstr. usually has the form 'username/password@ODBD:dbname' -conidODBC := EXEC_SQL.

cursorID.VARCHAR2
Parameters Name Connid
Mode IN
Curs_Id Position Value Column_Error Actual_Length
IN IN OUT OUT OUT
Description Is the handle to the connection you want to use. loc_hiredate). cursorID EXEC_SQL.OPEN_CURSOR(connection_id). input_empno). the exception EXEC_SQL.PARSE(connection_id. hiredate from emp '. exec_sql. cursorID.DEFINE_COLUMN(connection_id.DEFINE_COLUMN(connection_id. .CONNTYPE.BIND_VARIABLE(connection_id. loc_hiredate DATE.Column_Value example
PROCEDURE getData IS connection_id EXEC_SQL. nIgn := EXEC_SQL. empno. EXEC_SQL.CURSTYPE. nRows PLS_INTEGER := 0. loc_eno). Starting from the left.Define_Column. EXEC_SQL. Is the cursor handle to the row from which you want to get the column value. loc_eno NUMBER. BEGIN connection_id := EXEC_SQL.
EXEC_SQL. cursorID. cursorID). EXEC_SQL. Is the relative position of the column in the specified cursor. cursorID.Value_Error is raised.
Usage Notes If you specify a value which has a PL/SQL type that is different from what was specified by EXEC_SQL.V7). cursorID. 2. loc_ename VARCHAR2(30).. If you do not specify a connection. sqlstr := 'select ename. EXEC_SQL.You must have used DEFINE_COLUMN to define the column data characteristics before
64
Forms Developer and Reports Developer Built-in Package Reference
. ':bn'. 30).EXECUTE(connection_id. Returns the value of the specified column and row. Returns the actual length of the column value before truncation. Returns the error code for the specified column value (Oracle data sources only). EXEC_SQL. the first column is position 1. loc_ename.OPEN_CONNECTION(connect_str). nIgn PLS_INTEGER..DEFINE_COLUMN(connection_id.Default_Connection retrieves the primary Forms Developer connection handle from the cache. EXEC_SQL. 1. --. 3. sqlstr VARCHAR2(1000). sqlstr. cursorID := EXEC_SQL.

Is the cursor handle you want to retrieve the bind variable from. Create or replace procedure tstbindnum (input IN NUMBER. exists on the server which is specified by the connection string used in OPEN_CONNECTION.Default_Connection retrieves the primary Forms Developer connection handle from the cache.Variable_Value ([Connid IN CONNTYPE]. If you do not specify a connection.
where <datatype> is one of the following:
NUMBER DATE VARCHAR2
Parameters Name Connid
Mode IN
Curs_Id Name Value
IN IN OUT
Description Is the handle to the connection you want to use.
EXEC_SQL. EXEC_SQL. Returns the value of the bind variable for the specified cursor. output OUT NUMBER) as BEGIN
Forms Developer and Reports Developer Built-in Package Reference
65
.
Usage Notes If you try to retrieve a data type other than what was specified for the bind variable by EXEC_SQL. Name IN VARCHAR2.Variable_Value
Description This procedure retrieves the output value of a named bind variable at a specified cursor.using COLUMN_VALUE to retrieve the value. Is the name of the bind variable.Value_Error is raised.Variable_Value example
It is assumed that the following procedure. It also returns the values of bind variables in anonymous PL/SQL blocks. tstbindnum.-. the exception EXEC_SQL.Bind_Variable. Syntax
PROCEDURE EXEC_SQL. Value OUT <datatype>). Curs_Id IN CURSTYPE. Assign the row's first value to the
EXEC_SQL.

Returns TRUE or FALSE
EXEC_SQL.Default_Connection retrieves the primary Forms Developer connection handle from the cache.
EXEC_SQL. If you do not specify a connection.Curs_Id
IN OUT
Is the cursor handle you want to close.Is_Connected
Description Returns TRUE if a specified connection handle is currently connected to a data source. EXEC_SQL.Is_Connected [Connid IN CONNTYPE] RETURN BOOLEAN. Returns TRUE or FALSE
Forms Developer and Reports Developer Built-in Package Reference
69
. Syntax
FUNCTION EXEC_SQL.
Parameters Connid Is the handle to the connection you want to use.Is_OCA_Connection ([Connid IN CONNTYPE] RETURN BOOLEAN.Default_Connection retrieves the primary Forms Developer connection handle from the cache. Syntax
FUNCTION EXEC_SQL.Is_OCA_Connection
Description Returns TRUE if a specified connection handle is for an OCA connection.
Parameters Connid Is the handle to the connection you want to use. you may not be able to open new cursors.
Usage Notes When you no longer need a cursor. Otherwise. you must close it. If you do not specify a connection. EXEC_SQL. Sets to NULL.

Last_Error_Position [Connid IN CONNTYPE] RETURN PLS_INTEGER. All memory allocated to the handle is also released.Close_Connection does not close the database connection. Syntax
FUNCTION EXEC_SQL. If you do not specify a connection. EXEC_SQL. It is important to close the connection when you do not need it. EXEC_SQL. remain in use. If you do not close the connection.Default_Connection retrieves the primary Forms Developer connection handle from the cache. Sets the handle to NULL.PARSE. The byte offset at which an error occurred cannot be determined for OCA data sources. EXEC_SQL.
Parameters Connid Is the handle to the connection you want to use.Default_Connection. including opened cursors.Last_Error_Position
Description Returns the byte offset in the SQL statement where an error occurred. If you do not specify a connection.
Forms Developer and Reports Developer Built-in Package Reference
71
.
Parameters Name Mode Connid IN
OUT
Description Is the handle to the connection you want to use.Close_Connection also closes the database connection. This may result in connection deadlocks. Usage Notes Use this function after EXEC_SQL.Close_Connection ([Connid IN OUT CONNTYPE]). If it is opened by EXEC_SQL. Returns An integer.PROCEDURE EXEC_SQL. EXEC_SQL. and before another EXEC_SQL procedure or function.
EXEC_SQL.
Usage Notes If the connection is opened by EXEC_SQL. the database connection remains open and any memory allocated to the connection.Open_Connection. The first character in the statement is at position 0.Default_Connection retrieves the primary Forms Developer connection handle from the cache.

Default_Connection. EXEC_SQL. If you do not specify a connection. it does not automatically return a handle to the new primary connection.Close_Connection (without arguments) before you change the primary connection.
Forms Developer and Reports Developer Built-in Package Reference
77
. the next EXEC_SQL. Usage Notes Use this function immediately after the EXEC_SQL. This allows EXEC_SQL to free up the memory resources allocated to the previous connection. To make sure you have the correct handle.
Tip
To obtain the number of columns in a result set.Default_Connection call continues to return the handle from the cache.Invalid_Column_Number exception is raised. loop through the columns from 1 until the EXEC_SQL. always use EXEC_SQL. Returns A string. without actually closing it.Parameters Connid Is the handle to the connection you want to use.Default_Connection retrieves the primary Forms Developer connection handle from the cache.Package_Error exception is raised.
Changing the primary database connection
If you change the primary Forms Developer connection after you have called EXEC_SQL.

Usage Notes The argument can be of the type NUMBER or VARCHAR2.Create_Arglist Function.Add_Arg example
/* ** Add an argument to my_Arglist */ OLE2. value IN Obj_Type).Create_Arglist function.
OLE2. The value of an Obj_Type argument to be passed to the OLE2 automation server.Create_Arglist.value PROCEDURE (List value
NUMBER).Add_Arg(my_Arglist.
OLE2. The argument value. VARCHAR2).
Forms Developer and Reports Developer Built-in Package Reference
85
.Add_Arg_Obj
Description Appends an object argument to an argument list created with OLE2.Add_Arg List_Type. Syntax
PROCEDURE OLE2.
Parameters List value
A list handle returned from a call to the OLE2.Add_Arg_Obj (List IN List_Type.
Parameters List value
The name of an argument List assigned to the OLE2. 'Sales Revenue'). OLE2.

Arglist
Automation Object.'GetMapCenterY'). 'text').Create_Arglist Function. Arglist List_Type := 0) RETURN NUMBER. y := OLE2. property VARCHAR2. */ x := OLE2.Get_Char_Property(obj.
Returns A character value.
OLE2.Get_Num_Property
Description Gets a number value from an OLE2 Automation Object. The name of an argument List assigned to the OLE2. */ str := OLE2.'GetMapCenterX').Get_Num_Property(Map.
88
Forms Developer and Reports Developer Built-in Package Reference
. Syntax
FUNCTION OLE2.Create_Arglist Function.
OLE2.
Returns A number value.
OLE2.Get_Num_Property example
/* ** Get the number value for the center of the map.
Parameters object property Arglist
An OLE2 Automation Object.Get_Num_Property(Map.Get_Char_Property example
/* ** Get the property for the object. The name of an argument List assigned to the OLE2. The name of a property in an OLE2 Automation Object.Get_Num_Property (object obj_type.

Parameters object method Arglist
An OLE2 Automation Object.Invoke_Char example
/* ** Get the character value for spell_obj. The name of an OLE2 Automation method to invoke.Invoke_Obj
Description Gets an object type value from an OLE2 Automation Object.
OLE2. 'get_para'.Invoke_Char(spell_obj. The name of an argument List assigned to the OLE2.
OLE2.Invoke_Obj example
/* ** Get the object type value for wp_obj.Create_Arglist Function.Create_Arglist Function. my_Arglist). my_Arglist).
OLE2. method VARCHAR2.Invoke_Obj(wp_obj. Syntax
FUNCTION OLE2. 'spell'. Arglist List_Type := 0) RETURN OBJ_TYPE. */ para_obj:=OLE2. The name of an argument List assigned to the OLE2.
Forms Developer and Reports Developer Built-in Package Reference
91
. The name of an OLE2 Automation method (function) that returns a character value.
Returns A character value. */ correct:=OLE2.object method Arglist
An OLE2 Automation Object.Invoke_Obj (object obj_type.
Returns An OLE2 Automation Object.

Returns The complete OLE2 error code from the last OLE2 exception. PL/SQL code using the OLE2 package ELSE . If included. if OLE2 is supported on the platform. The first syntax returns only the error code. you must remove the highest bit (Severity) and then translate the remaining number to INTEGER
92
Forms Developer and Reports Developer Built-in Package Reference
. . . Usage Notes n You can use either syntax for this function.
or
FUNCTION last_exception(message OUT VARCHAR2) return NUMBER. FALSE if it is not. . Syntax
FUNCTION last_exception return NUMBER.OLE2.
OLE2.
(OLE2. .ISSUPPORTED
Returns TRUE.
Parameters message
A text string (VARCHAR2) containing the text of the OLE2 error message. this variable is returned to the caller of the function.IsSupported example
/* ** ** ** */ IF Before calling an OLE2 object in platform independent code. in addition to the error code. in addition to the error code value. message that OLE2 is not supported END IF.
n
This function returns a complete OLE2 (Windows) style error code as a NUMBER.IsSupported
Description Confirms that the OLE2 package is supported on the current platform.
OLE2. To extract just the error code portion. the second syntax returns a text description of the error.ISSUPPORTED)THEN .Last_Exception
Description Returns the last OLE2 exception signaled by a PL/SQL exception. use this predicate to determine if OLE2 is supported on the current platform. Syntax
OLE2.

.funcHandleType.. .register_function (testlib_lhandle.
Ora_Ffi.Foreign function are created in your current name space and will appear under the Program Units node of the Procedure Builder Object Navigator.'foo'). PROCEDURE Ora_Ffi. For example.Find_Library.
Ora_Ffi.Funchandletype. the package name will be FFI_LIBTEST.Generate.Generate_Foreign (handle libHandleType.Funchandletype example
/* This example uses Ora_Ffi_Funchandletype */ PROCEDURE define_c_funcs IS getresult_fhandle ora_ffi.
Usage Notes
n
Packages generated by the Ora_Ffi. If you do not specify a package name. /* Register the info for function foo */ foo_fhandle := ora_ffi. You must first load the library. Syntax
PROCEDURE Ora_Ffi. register all of the functions you want to invoke. Once a package has been generated.. foo_fhandle ora_ffi.funcHandleType.register_function (testlib_lhandle. and register their parameter and return values. the name of the library. BEGIN /* Register the info for function getresult */ getresult_fhandle := ora_ffi.TYPE Ora_Ffi. prefixed with FFI_. is used. END. The name of the package to be generated. ..
Parameters handle pkgname
A library handle returned by Ora_Ffi. 'getresult').LoadLibrary or Ora_Ffi. you can copy it to the Program Units node of a PL/SQL
Forms Developer and Reports Developer Built-in Package Reference
101
. pkgname VARCHAR2).Generate_Foreign
Description Generates a package of PL/SQL code for all the functions defined in the specified library. if the library name is LIBTEST.Generate_Foreign (handle libHandleType).

END. foo_handle Ora_Ffi. 11265).Funchandletype. /*Define package body procedures */ PACKAGE BODY test IS PRODEDURE register_libs IS BEGIN /* Load the test library */ testlib_lhandle := Ora_Ffi_.. /* Generate PL/SQL package containing all functions defined in test library */ ora_ffi..Generate_Foreign example
/* Define components of package test */ PACKAGE test IS .
n
A PL/SQL package generated by the Ora_Ffi.
Ora_Ffi.register_function (testlib_lhandle. END. BEGIN /* Register the info for function getresult */ getresult_fhandle := ora_ffi.. each of the entry points will match the names of the foreign functions they map to. You can specify the name of the generated PL/SQL package.
Ora_Ffi.dll') END. 'test_ffi_pkg')...Generate_Foreign function automatically includes the required PRAGMA compiler directives for each of the registered functions: PRAGMA interface (C.'testlib.Funchandletype.. func_name. ..
102
Forms Developer and Reports Developer Built-in Package Reference
. /* Register the info for function foo */ foo_fhandle := ora_ffi. END. function. PROCEDURE define_c_funcs IS getresult_fhandle Ora_Ffi.Is_Null_Ptr
Description Determines whether a library. but within that package. or pointer handle is null.'foo')..register_function (testlib_lhandle.Library or to the Stored Program Units node of a database.generate_foreign (testlib_lhandle.'getresult'). where func_name is the name of a registered foreign function from a dll library that has already been loaded. and you can export it to a text file using File Export. just like any other new package or procedure that you have defined.load_library ('c:\orawin95\oralibs\'. . .

*/ Ora_Ffi. */ Ora_Ffi. /* Package Body mathgen */
To raise a number to a power with this method.pow(a. and then returns a generic pointer (i. to invoke the power function from package mathlib. END.b)). /* Procedure gen */ END. */ Ora_Ffi.
Forms Developer and Reports Developer Built-in Package Reference
113
. 'pow. PL/SQL> raise_to_power(5. Ora_Ffi.C_DOUBLE). you would generate it as follows:
PL/SQL> mathgen. when you generate the package. which are located in the library C:\oralibs\imglib. you must first generate a Pl/SQL package using package mathgen and procedure gen. Ora_Ffi. 25
Ora_Ffi Example 2
Suppose you want to create an interface to the following C functions. First. you might write a procedure such as:
PROCEDURE raise_to_power (a in number.C_DOUBLE)./* Register both parameters of the foreign function.
Then. /* Register the return type of the foreign function.Register_Return (to_power_fhandle. pkg_name. pkg_name).C_DOUBLE).generate_foreign(mathlib_lhandle. Ora_Ffi. a pointer of unspecified type) to that binary data.Register_Parameter (to_power_fhandle.put_line(mathlib. which displays the image on the screen. create a package specification that represents the library and defines the PL/SQL functions that you want to invoke:
PACKAGE imglib IS FUNCTION get_image(ikey IN OUT VARCHAR2) RETURN Ora_Ffi. if the generated PL/SQL power package is called mathlib.dll:
void *get_image(char *imgkey) void show_image(void *binimage. You then pass the pointer and a scaling factor to show_image..gen('mathlib'). /* Generate a PL/SQL package containing the foreign C function. float iscale)
Assume that the function get_image uses a keyword argument to load image data.pointerType. For example. Ora_Ffi.2).e.' You can name the new package by specifying a value for the parameter. END. b in number) IS BEGIN text_io.Register_Parameter(to_power_fhandle.

This is because encoding schemes for character sets do not necessarily define all characters in ascending numerical order. the sort position of a character may vary for different languages. IF collate = TRUE THEN lang_name (langinfo.txt).Linguistic_Collate. In addition. see Ora_Nls Constants. */ collate := Ora_Nls.FUNCTION Ora_Nls. Text_IO.Linguistic_Collate RETURN BOOLEAN.Get_Lang_Str (attribute PLS_INTEGER) RETURN VARCHAR2. BEGIN lang_name := Ora_Nls.
Parameters attribute
An Ora_Nls Constant or its associated integer value. depending on whether the characters in the current character set need to be collated according to special linguistic information.Get_Lang_Str example
/* ** Retrieve and print out the language name */ BEGIN lang_name (out Text_IO.
Ora_Nls. Usage Notes If this function returns TRUE.
Returns TRUE or FALSE. END. an "ä" is sorted before "b" in German. but after "z" in Swedish.
Forms Developer and Reports Developer Built-in Package Reference
119
. For example.Linguistic_Collate
Description Returns TRUE or FALSE.
Ora_Nls.Language).
Returns A character value. a binary sort of two characters will not necessarily return the correct value. Syntax
FUNCTION Ora_Nls.Putf (out. "Current Language is %s\n". lang_name).Linguistic_Collate example
/* ** Determine whether or not special collating is ** needed.Get_Lang_Str (Ora_Nls. For a List Of constants.File_Type) lang_name VARCHAR2(80).
Ora_Nls.

Usage Notes Linguistic specials are language-specific special cases for collation and case conversion (upper and lower).
Ora_Nls.txt). An example The uppercase for the German sharp "s" (one byte). ENDIF. depending on whether the date format has been modified. When there are linguistic specials defined for the linguistic definition that is in effect for a specific language handle. Linguistic specials are defined in a linguistic definition along with normal collation.
Returns TRUE or FALSE.
Ora_Nls. Sorting Also done according to the two-byte value.Text_IO. IF specials = TRUE THEN lang_name (langinfo.
Ora_Nls.
Returns TRUE or FALSE. Text_IO. Syntax
FUNCTION Ora_Nls. depending on whether there are linguistic specials in use.Linguistic_Specials RETURN BOOLEAN.
120
Forms Developer and Reports Developer Built-in Package Reference
.'). which is "SS" (two bytes). ENDIF.Linguistic_Specials
Description Returns true or false. output sizes of functions handling linguistic specials can be larger than input string sizes.Linguistic_Specials.Modified_Date_Fmt
Description Returns true or false.Put ('This needs special collating. Syntax
FUNCTION Ora_Nls.Linguistic_Specials example
/* ** Determine whether or not specials are in use ** and how to deal with them if so */ specials := Ora_Nls.Modified_Date_Fmt RETURN BOOLEAN.Put ('Specials are in use.').

Putf (langinfo.
Ora_Nls. IF modify = TRUE Text_IO. This is most likely caused by using Ora_Nls.
Ora_Nls.Modified_Date_Fmt example
/* ** Determine whether or not the date format has been ** modified */ modify := Ora_Nls.No_Item THEN Text_IO.Nls.Nls.Put ('An attribute supplied is not valid. ENDIF.No_Item EXCEPTION.Get_Lang_Str to retrieve numeric information.Not_Found THEN
Forms Developer and Reports Developer Built-in Package Reference
121
.
Ora_Nls.No_Item example
/* ** Hand the exception for an unidentified attribute constant */ EXCEPTION WHEN Ora.No_Item
Description Raised when a user-supplied attribute cannot be located in the List Of attributes constants.Not_Found example
/* ** Hand the exception for an item that was not found */ EXCEPTION WHEN Ora.txt.
Ora_Nls.').Not_Found
Description This exception is raised when a requested item cannot be found. Syntax
Ora_Nls.Get_Lang_Scalar to retrieve character information. or by using Ora_Nls.Modified_Date_Fmt. Syntax
Ora_Nls.Ora_Nls.').Not_Found EXCEPTION. 'The date format has been modified.

Put (langinfo.
Ora_Nls.Simple_Cs
Description Returns true or false. 'This is not a right to left language. Syntax
FUNCTION Ora_Nls.txt.Put ('The item was not found.'). Syntax
FUNCTION Ora_Nls.Right_to_Left
Description Returns true or false.e. Text_IO.. single-byte. no special characters. IF rtl = FALSE Text_IO. no special handling).
Returns TRUE or FALSE. check calls to Get_Lang.Simple_Cs RETURN BOOLEAN. IF simplecs = TRUE lang_name (langinfo.Simple_Cs example
/* ** Determine if the language is simple or not */ simplecs := Ora_Nls. ENDIF.Right_To_Left. ELSE lang_name (langinfo.Text_IO.
Ora_Nls.txt).').').
122
Forms Developer and Reports Developer Built-in Package Reference
. depending on whether the writing direction of the current language is "right-to-left".Simple_Cs.
Returns TRUE or FALSE. depending on whether the current character set is simple (i.
Ora_Nls.Put ('This language uses a simple character set.Right_To_Left RETURN BOOLEAN.txt).Right_To_Left example
/* ** Verify that the language is a right-to-left language */ rtl := Ora_Nls.
Ora_Nls.

IF bytes = FALSE lang_name (langinfo. depending on whether all of the characters in the current character set can be represented in one byte. END IF.').Single_Byte
Description Returns true or false. ENDIF. Syntax
FUNCTION Ora_Nls.Single_Byte.Text_IO.
Ora_Nls.
Ora_Nls.
Forms Developer and Reports Developer Built-in Package Reference
123
.Put ('This is a multi-byte character set.Single_Byte RETURN BOOLEAN.Single_Byte example
/* ** Determine if the character set is single or multi-byte */ bytes := Ora_Nls.Put ('This language uses a complex character set.').txt). Text_IO.
Returns TRUE or FALSE.

Destroy_Timer example
/* **Destroy the timer ‘LOOPTIME’.BAD_TIMER THEN text_io. Syntax
PROCEDURE Ora_Prof.Create_Timer
Description Allocates the named timer.Create_Timer('LOOPTIME').Create_Timer example
/* **Allocate the timer ‘LOOPTIME’.Destroy_Timer (timer VARCHAR2).Destroy_Timer
Description Destroys the named timer.
Ora_Prof.
Parameters timer
The name of the timer.
Parameters timer
The name of the timer. Syntax
PROCEDURE Ora_Prof.put_line('Invalid timer name'). END.
Ora_Prof.Create_Timer (timer VARCHAR2). Any references to the named timer before this service is used will raise an error.
Ora_Prof.
Ora_Prof. All memory associated with the timer is freed at that time. */ Ora_Prof. Any references to the named timer after this service is used will raise an error.EXCEPTION WHEN ORA_PROF. */
Forms Developer and Reports Developer Built-in Package Reference
125
.

Ora_Prof. then display the time in ** seconds.
Ora_Prof.Reset_Timer. Syntax
FUNCTION Ora_Prof.Stop_Timer('loop2'). Text_IO. */ PROCEDURE timed_proc (test VARCHAR2) IS i PLS_INTEGER.
Returns The amount of time (in milliseconds) accumulated in the code timer.Elapsed_Time (timer PLS_INTEGER) RETURN PLS_INTEGER.
126
Forms Developer and Reports Developer Built-in Package Reference
.Destroy_Timer('loop2').Elapsed_Time('loop2')).Reset_Timer (timer VARCHAR2). Ora_Prof.Elapsed_Time
Description Returns the amount of time accumulated in the code timer since the last call to Ora_Prof.Start_Timer('loop2').Elapsed_Timer example
/* ** Create a timer. Syntax
PROCEDURE Ora_Prof.
Parameters timer
The name of the timer.Reset_Timer
Description Resets the elapsed time of a timer to zero. test.
Ora_Prof.
Ora_Prof. start it. run a subprogram. Ora_Prof. Ora_Prof.Destroy_Timer('LOOPTIME').\n'.
Parameters timer
The name of the timer. Destroy the timer when finished.Create_Timer('loop2').Ora_Prof. ** stop the timer. END.Putf('Loop executed in %s seconds. BEGIN Ora_Prof.

...
Ora_Prof.. FOR i IN 1.10 LOOP Text_IO.
Forms Developer and Reports Developer Built-in Package Reference
127
.Second loop.
Ora_Prof.Start_Timer example
PROCEDURE multi_time IS i PLS_INTEGER. -Ora_Prof..Start_Timer
Description Starts a timer. FOR i IN 1..Create_Timer('loop'). END LOOP. --. -Ora_Prof..Ora_Prof.Put_Line('Hello'). Ora_Prof.Start_Timer (timer VARCHAR2). Ora_Prof.Put_Line('Hello').10 LOOP Text_IO.Reset_Timer example
PROCEDURE multi_time IS i PLS_INTEGER. -Ora_Prof.Start_Timer('loop').Start_Timer('loop').Stop_Timer('loop').First loop.Timer_Start and Ora_Prof.Stop_Timer('loop').10 LOOP Text_IO. FOR i IN 1. END LOOP. END. END LOOP.Create_Timer('loop').Stop_Timer('loop'). BEGIN Ora_Prof.Destroy_Timer('loop'). Ora_Prof. --.First loop. Ora_Prof..Start_Timer('loop').Timer_Stop added to the timer's total elapsed time. Any time accumulated between calls to Ora_Prof..
Parameters timer
The name of the timer. Syntax
PROCEDURE Ora_Prof.Put_Line('Hello'). --. BEGIN Ora_Prof.

. -Ora_Prof. END.Stop_Timer('loop').Second loop.
128
Forms Developer and Reports Developer Built-in Package Reference
. --. FOR i IN 1.--. --. END LOOP. Any time accumulated between calls to Ora_Prof.Start_Timer('loop').Destroy_Timer('loop'). FOR i IN 1. Ora_Prof. END LOOP.Start_Timer('loop').Destroy_Timer('loop').Timer_Start and Ora_Prof..10 LOOP Text_IO.
Parameters timer
The name of the timer.Put_Line('Hello').
Ora_Prof. FOR i IN 1.Create_Timer('loop').10 LOOP Text_IO..Start_Timer('loop')..Stop_Timer('loop')..First loop.10 LOOP Text_IO. END..
Ora_Prof.Stop_Timer
Description Stops a timer. Ora_Prof.Stop_Timer (timer VARCHAR2). -Ora_Prof.Second loop. Syntax
PROCEDURE Ora_Prof. BEGIN Ora_Prof..Put_Line('Hello').Timer_Stop added to the timer's total elapsed time. Ora_Prof.Stop_Timer example
PROCEDURE multi_time IS i PLS_INTEGER.Stop_Timer('loop')..Put_Line('Hello'). Ora_Prof.. -Ora_Prof. END LOOP. Ora_Prof.

Text_IO. A single case-insensitive character that specifies the mode in which to open the file. the other to write to.File_Type..File_Type.
Forms Developer and Reports Developer Built-in Package Reference
131
.
Text_IO. */ out_file Text_IO.
Text_IO.File_Type
Description Specifies a handle to a file.File_Type example
/* ** Declare a local variable to represent ** the output file you will write to.Fopen (spec VARCHAR2.Text_IO.e.Fopen
Description Opens the designated file in the specified mode. Syntax
FUNCTION Text_IO.
Parameters spec filemode
A case-insensitive string corresponding to a file's name.File_Type. filemode VARCHAR2) RETURN Text_IO.
Returns A handle to the specified file. and consists of one of the following characters: R Open the file for reading only. Syntax
TYPE Text_IO. appending).Fopen example
/* ** Declare two local variables to represent two files: ** one to read from. W Open the file for reading and writing after deleting all existing lines in the file. A Open the file for reading and writing without deleting existing lines (i.

item OUT VARCHAR2).Fclose(out_file). If there are no more characters remaining in the file.Is_Open(out_file) THEN Text_IO. */ IF Text_IO.txt'.Is_Open example
/* ** Determine if the output file is open.e. A variable used to hold the next line read
132
Forms Developer and Reports Developer Built-in Package Reference
. If so. the No_Data_Found exception is raised. 'w'). the Value_Error exception is raised. Syntax
FUNCTION Text_IO. Syntax
PROCEDURE Text_IO. Text_IO.txt'.
Text_IO. out_file Text_IO.
Parameters file Returns TRUE or FALSE.Get_Line
Description Retrieves the next line of an open fileand places it in item.Is_Open (file file_type) RETURN BOOLEAN.Fopen('salary.
Parameters file item
A variable that specifies an open file.File_Type.
A variable that specifies the file to check. out_file := Text_IO.Is_Open
Description Checks to see if the specified file is currently open.*/ in_file Text_IO. carriage return) is read or an end-of-file (EOF) condition is encountered.
Text_IO..Get_Line reads characters until a newline character (i.File_Type.Fopen('bonus.
Text_IO. If the line to be read exceeds the size of item. in_file := Text_IO. ** then close it. 'r').Get_Line (file file_type.

linebuf VARCHAR2(80).Text_IO. PROCEDURE Text_IO.New_Line
Description Concatenates the specified number of newline characters (i.
Parameters file n
A variable that specifies an open file.New_Line. Text_IO. if you specify no number (e.
Text_IO.New_Line (n PLS_INTEGER := 1).e. carriage returns) to the current line of an open file.
Forms Developer and Reports Developer Built-in Package Reference
133
. ‘r’).linebuf).. n PLS_INTEGER := 1). that is. Syntax
PROCEDURE Text_IO.File_Type.Fopen(‘salary. Text_IO.g.) a single newline character is created. An integer. or outputs them to the Interpreter.Get_Line(in_file..New_Line (file file_type. The default is 1.txt. in_file := Text_IO.Get_Line example
/* ** Open a file and read the first line ** into linebuf. */ in_file Text_IO.

PROCEDURE Text_IO.Put (item DATE).New_Line example
/* ** Write a string to the output file. */ Text_IO. Text_IO.New_Line(out_file. 2). SYSDATE).Put (file file_type. and PLS_INTEGER values for item. PROCEDURE Text_IO. PROCEDURE Text_IO. which accept VARCHAR2..Put (file file_type. NUMBER.Put (item PLS_INTEGER). item NUMBER).Put
Description Concatenates the supplied data to the current line of an open file.Put procedures. PROCEDURE Text_IO.
Parameters file item
A variable that specifies an open file.
Text_IO.e. PROCEDURE Text_IO. DATE. Notice that there are several Text_IO.Put (file file_type.Put (item NUMBER).Put(out_file.Text_IO. No newline character (i. or outputs it to the Interpreter. carriage return) Added. Syntax
PROCEDURE Text_IO. PROCEDURE Text_IO. then ** create a newline after it. All of the procedures (except VARCHAR2) convert the supplied data to a character string.
134
Forms Developer and Reports Developer Built-in Package Reference
. PROCEDURE Text_IO. item DATE). A variable to be used as a buffer. item VARCHAR2). item PLS_INTEGER).Put (item VARCHAR2).Put (file file_type.

Put('Processing ends.. PROCEDURE Text_IO. A variable that specifies an open file. [arg1 [. Syntax
PROCEDURE Text_IO. `value.
Usage Notes To format messages containing non-character substitutions.Text_IO. PROCEDURE Text_IO. arg VARCHAR2). using the
Forms Developer and Reports Developer Built-in Package Reference
135
.Putf (file file_type. SYSDATE).... Specifies the format of the message to be displayed.
Parameters arg format file
An argument that specifies the value to be displayed (e. carriage returns). create ** a newline.Put(out_file. "\n" patterns are replaced with newline characters (i.. PROCEDURE Text_IO.. arg5] VARCHAR2]).. `each'.g.e..Putf
Description Formats and writes a message to an open file.. Text_IO.. You can embed up to five "%s" patterns within format (e. [arg1 [.').'). The "%s" patterns are replaced with successive character arg values (e. arg5] VARCHAR2]).. use the TO_CHAR function on the argument (see the example below). variable). `Check'.New_Line(out_file). or outputs the message to the Interpreter. character string.Putf (arg VARCHAR2).
Text_IO.
Text_IO.. format VARCHAR2.g.g. Text_IO.Putf example
/* ** Write a line to the output file..Putf (file file_type.Putf (format VARCHAR2. '%s %s %s').Put example
/* ** Write a line to a specified output file. */ Text_IO. then write another line to the output ** file..

*/ Text_IO.Put_Line example
/* ** Print two complete lines to the output file. TO_CHAR(SYSDATE)).Put_Line
Description Concatenates the character data supplied by item to the current line of an open file. A variable that specifies the character data to be displayed.Put_Line(out_file.
Parameters file item
A variable that specifies an open file.Putf(out_file.'). Syntax
PROCEDURE Text_IO. */ Text_IO.e.
136
Forms Developer and Reports Developer Built-in Package Reference
.Put_Line('Starting test procedures. or outputs it to the Interpreter. carriage return) is automatically Added To the end of the string..
Text_IO.. Text_IO. item VARCHAR2).Put_Line (file file_type. A newline character (i.
Text_IO.'Today is %s\n'.. TO_CHAR(SYSDATE)).** TO_CHAR(SYSDATE) call to represent the substituted ** character variable.

Tool_Env.Getvar example
/* ** Retrieve the environment variable USER into a ** variable named :userid so you can use it in a ** connect string or other call. :userid). */ Tool_Env.
Forms Developer and Reports Developer Built-in Package Reference
139
.Getvar('USER'.

Code
Description Returns the error code for the ith error on the error stack (the default is the top-most error).
140
Forms Developer and Reports Developer Built-in Package Reference
.
Tool_Err.Clear
Description Discards all errors currently on the error stack.Message Tool_Err.Encode Tool_Err. Syntax
FUNCTION Tool_Err.Tool_Error Tool_Err.Code (i PLS_INTEGER := TOPERROR) RETURN NUMBER.Nerrors Tool_Err. Returns The error code of the error specified.Clear Tool_Err. If there are no errors on the stack.Code Tool_Err. zero is returned.Clear. Syntax
PROCEDURE Tool_Err.Toperror
Tool_Err.Pop Tool_Err.Tool_Err Package
Tool_Err package
Tool_Err.
Parameters i An integer that specifies an error on the error stack.

.Tool_Err. */
142
Forms Developer and Reports Developer Built-in Package Reference
.
Tool_Err. loop through stack. Then.Nerrors
Description Returns the number of errors currently on the error stack. FOR i IN 1.
Returns The number of error on the error stack. */ PROCEDURE print_all_errors IS number_of_errors PLS_INTEGER.
Parameters i An integer that specifies an error on the error stack.
Tool_Err. Syntax
FUNCTION Tool_Err.Nerrors example
/* ** Determine the number of errors ** on the stack.
Tool_Err. Returns An error message. Syntax
FUNCTION Tool_Err. BEGIN EXCEPTION WHEN OTHERS THEN number_of_errors := TOOL_ERR.Message (i PLS_INTEGER := TOPERROR) RETURN VARCHAR2.Nerrors RETURN PLS_INTEGER.NERRORS. END LOOP.Message
Description Returns the formatted message associated with the ith error on the error stack (the default is the top-most error). ** and print out each error message.number_of_errors LOOP TEXT_IO.PUT_LINE(TOOL_ERR. ** and print out each error message. END. loop through stack. Then.MESSAGE(i-1)).Message example
/* ** Determine the number of errors ** on the stack.

. BEGIN EXCEPTION WHEN OTHERS THEN number_of_errors := TOOL_ERR.Pop
Description Discards the top-most error on the error stack.Tool_Err.POP.MESSAGE(i-1)).
Tool_Err.Tool_Error EXCEPTION. ** print it. Syntax
Tool_Err..
Tool_Err. EXCEPTION WHEN OTHERS THEN FOR i IN 1..Pop.PUT_LINE(TOOL_ERR.
Forms Developer and Reports Developer Built-in Package Reference
143
. END LOOP. END.
Tool_Err.Pop example
/* ** Loop through each message in the stack. .number_of_errors LOOP TEXT_IO. . FOR i IN 1.Tool_Error
Description Defines a generic error you can raise to indicate that one or more errors have been pushed onto the error stack. END LOOP. Syntax
PROCEDURE Tool_Err. */ BEGIN . then clear the top most error.PUT_LINE(TOOL_ERR. TOOL_ERR.MESSAGE).Nerrors LOOP TEXT_IO. .PROCEDURE print_all_errors IS number_of_errors PLS_INTEGER. END.NERRORS. .

Tool_Res.No_Resource
Description This exception is raised when the named resource could not be found. If a file was specified, the resource does not exist in that file. If no file was specified, the resource does not exist in any of the resource files that are currently open. Syntax
Tool_Res.No_Resource EXCEPTION;

Tool_Res.Rfclose
Description Closes the specified resource file. All files opened with Tool_Res.Rfopen should be closed using Tool_Res.Rfclose before quitting the application. Syntax
PROCEDURE Tool_Res.Rfclose (file rfhandle);

Parameters file

A file to close.

Usage Notes The following exceptions may be raised by RFCLOSE: BAD_FILE_HAN Raised if the file handle does not point to a DLE valid file. Tool_Err.Tool_Er Raised if an internal error is trapped. ror

RFOPEN('C. only the specified resource file will be searched for the named resource. END.' */ fhandle := TOOL_RES. Otherwise.
Returns A handle to the specified file. If a file handle is included. Tool_Err. Usage Notes The following exceptions may be raised by Rfread: No_Resource Raised if the named resource could not be located..Rfread (resid VARCHAR2. Syntax
FUNCTION Tool_Res.Rfopen */ PROCEDURE my_init (fhandle OUT TOOL_RES.Rfopen example
/* ** This example uses Tool_Res. all currently open resource files will be searched.\my_app.
Parameters rfile resid restype
A file to read. ror
Forms Developer and Reports Developer Built-in Package Reference
151
.res'). resid VARCHAR2. 'fhandle.Tool_Res. The type of resource.
Tool_Res.Rfread
Description Reads the specified resource. restype VARCHAR2 := 'string') RETURN VARCHAR2. .Tool_Er Raised if an internal error is trapped.RFHANDLE) IS BEGIN /* Open a resource file and assign it to the handle. FUNCTION Tool_Res.Rfread (rfile rfhandle. restype VARCHAR2 := 'string') RETURN VARCHAR2.. Buffer_Overflow Raised if the supplied "buffer" is smaller than the requested resource. A resource ID.