Oracle Forms Developer – Form Builder Reference, Volume 1

USER_EXIT built-in
Description
Calls the user exit named in the user_exit_string.
Syntax
USER_EXIT
(user_exit_string VARCHAR2);
USER_EXIT
(user_exit_string VARCHAR2,
error_string VARCHAR2);
Built-in Type unrestricted procedure
Enter Query Mode yes
Parameters
user_exit_string Specifies the name of the user exit you want to call, including any
parameters.
error_string Specifies a user-defined error message that Form Builder should display if
the user exit fails.
USER_EXIT examples
/*
** Built-in: USER_EXIT
** Example: Invoke a 3GL program by name which has been
** properly linked into your current Form Builder
** executable. The user exit subprogram must parse
** the string argument it is passed to decide what
** functionality to perform.
*/
PROCEDURE Command_Robotic_Arm( cmd_string VARCHAR2 ) IS
BEGIN
/*
** Call a C function ’RobotLnk’ to initialize the
** communication card before sending the robot a message.
*/
User_Exit(’RobotLnk INITIALIZE Unit=6,CmdToFollow=1’);
IF NOT Form_Success THEN
Message(’Failed to initialize Robot 6’);
RAISE Form_trigger_Failure;
END IF;
/*
** Pass the string argument as a command to the robot
*/
User_Exit(’RobotLnk SEND Unit=6,Msg=’||cmd_string );
IF NOT Form_Success THEN
Message(’Command not understood by Robot 6’);
RAISE Form_trigger_Failure;
END IF;
/*
** Close the robot’s communication channel
*/
449