formZ SDK | 4.0 Call Back Reference | Command | Tool

# fz_tool_cbak_cancel

Description

Tool Cancel (Optional). This function is called by formZ if the operation is canceled before the fz_tool_cbak_click_func has returned TRUE for done. A Tool can be cancelled by the user selecting a different tool or pressing the cancel key shortcut.

Plugin Prototype

fzrt_error_td fz_tool_cbak_cancel(

fzrt_int | windex,
fzrt_int | click_count )

Parameters

windex [Input]

project window index

click_count [Input]

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

Returns

Error codes

Availability

5.0.0.0

See Also

fz_tool_cbak_click, fz_tool_cbak_track,fz_tool_cbak_prompt

Function Set

fz_tool_cbak_fset

Defined in

fz_tool_api.h