Cancel - cUIObject

Used to terminate the current level of a start_ui or ui_accept

Type: Procedure

Return Data Type: Integer

Parameters: None

Return Value

Return value is msg_Cancel


Syntax
Procedure Cancel Returns Integer

Call: Get msg_Cancel to IntegerVariable


Description

This message is used to terminate the current level of a start_ui or ui_accept with a return value of msg_cancel. An application may use the return value from a ui_accept to inquire as to the reason for termination.

integer iRetVal
ui_accept object to iRetVal
if (iRetVal = msg_Cancel) send operation_aborted