cancelEnterFun
cancelEnterFun(
[ g_form ]
)
=> t / nil
Description
Cancels the enterfunction in the current window.
In SKILL code, when an enterfunction is currently active, do not use cancelEnterFun before invoking a new enterfunction or you might get unexpected behavior; use changeNextEnterFun instead.
Argument
|
g_form
|
Form handle used to locate the enterfunction to cancel. Normally the enterfunction that is canceled is the one active in the current window. If you want to cancel a specific enterfunction, whether or not it is in the current window, there is no way to tell which window is the correct one. So you pass the same form that was originally supplied to the enterfunction to cancelEnterFun, and it cancels that specific enterfunction regardless of whether it is in the current window or not.
|
Values Returned
|
t
|
The enterfunction is canceled.
|
|
nil
|
There is no active enterfunction in the current window.
|
Examples
Displays the prompt First in the CIW:
enterSegment( ?prompts list("First" "Second" )
Terminates the enterfunction and the prompt goes away. nil is returned.
cancelEnterFun( )
Related Topics
User Entry Functions
Return to top
