formZ SDK | 4.0 Call Back Reference | Command | Tool

# fz_tool_cbak_redo

Description

Tool Redo (Optional). This function is called by formZ when the user selects the redo menu item from the Edit menu during the execution of the tool. This function is used to move the input up to the state of the previously undone click. If this function is not provided, the tool does not perform redos during the use of the tool. This function is only called immediately after a call to the undo function. Once a click or prompt entry occurs, the redo is reset.
The click_count parameter is the number of clicks which will be one more than the last call to the undo function. The click_wait parameter tells formZ to wait until a specific type of click happens before calling the click function again. The done parameter determines the completion of the tool. A value of TRUE indicates that the tool is done, a value of FALSE indicates that the tool expects more clicks. The default is FALSE.

Plugin Prototype

fzrt_error_td fz_tool_cbak_redo(

fzrt_int | windex,
fzrt_int | click_count,
fz_fuim_click_wait_enum * | click_wait,
fzrt_boolean * | done )

Parameters

windex [Input]

project window index

click_count [Input]

count of clicks for tool (1 for first click, 2 for second etc...)

click_wait [Result]

wait status for next click (default = FZ_FUIM_CLICK_WAIT_NOT)

done [Result]

TRUE for tool complete, FALSE if not complete

Returns

Error codes

Availability

5.0.0.0

See Also

Function Set

fz_tool_cbak_fset

Defined in

fz_tool_api.h