finishEnterFun

finishEnterFun(
[ g_form ]
) 
=> t / nil 

Description

Completes an enterfunction if possible.

Some commands cannot be finished until you enter all the required points. When finishEnterFun is called in such a situation, the enterfunction is canceled even though finishEnterFun returns t.

Do not call finishEnterFun from within an enterfunction callback procedure.

Argument

g_form

Form handle used to locate the enterfunction to finish. Normally the enterfunction finished is the one active in the current window. If you want to finish a specific enterfunction, whether or not it is 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 finishEnterFun, and it finishes that specific enterfunction regardless of whether it is in the current window or not.

Values Returned

t	The enterfunction in the current window was terminated.
nil	Could not terminate the enterfunction.

Examples

Displays the prompt First is displayed in the CIW.

enterPoints(?prompts list("First" "Next")

Enter points p1, p2, and p3. Now type

finishEnterFun( )

The enterfunction is terminated, the prompt goes away, and ( p1 p2 p3 ) is returned.

Related Topics

User Entry Functions

Enterfunction Flags

Return to top