End_Dialog subroutine [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== End_Dialog subroutine ======


 
==== Description ====
 
 
This stored procedure closes a modal dialog box and returns a value back to the caller.
 
 
 
 
==== Syntax ====
 
 
Call End_Dialog( DialogID, RetVal )
 
 
 
 
 
 
==== Parameters ====
 
 
 
 
 
 
 
^Name^Required^Description^
|DialogID|Yes|Name of the dialog box to close.  Must be in upper-case.|
|RetVal|No|Value to return to the caller.|
 
 
==== Returns ====
 
 
N/A
 
 
 
==== Errors ====
 
N/A
 
 

==== Remarks ====
 
 
This stored procedure is used to close a modal dialog box and return a value to the caller. If the dialog box was launched in synchronous mode the return value is returned directly from the originating Dialog_Box() call, otherwise the return value is passed to the caller's ENDDIALOG event instead.  See the description of the Dialog_Box() stored procedure above for more details.
 
 
 
This stored procedure should only be used with modal dialog boxes that have been executed via a call to Dialog_Box().  It can be used with non-modal dialog boxes but there is little point as a value cannot be returned to a caller.
 
Note that The WINDOW CLOSE method can also be used with a modal dialog – it is the equivalent of  calling End_Dialog and passing a null RetVal parameter.
 
 
 
 
==== Example ====
 
See the Dialog_Box() function above for an example of how to use End_Dialog.
 
==== See Also ====
 
 
WINDOW CLOSE method, [[guides:oi10:presentation_server:create_dialog|Create_Dialog function]], [[guides:oi10:presentation_server:dialog_box|Dialog_Box function]].