formZ SDK | 4.0 Call Back Reference | Command | Tool

# fz_tool_cbak_activate

Description

Tool Activate (Optional). This function is called by formZ when this tool is made the active tool by the user. The user can activate the tool by clicking on an icon or executing a key shortcut.
This tool is a variant of fz_tool_cbak_select which is also called when the tool is made active, however, fz_tool_cbak_select is called before the start of each iteration of the tool, not just when the tool is made active.

Plugin Prototype

fzrt_error_td fz_tool_cbak_activate(

fzrt_int | windex )

Parameters

windex [Input]

project window index

Returns

Error codes

Availability

7.0.0.0

See Also

fz_tool_cbak_deactivate,fz_tool_cbak_select,fz_tool_cbak_deselect

Function Set

fz_tool_cbak_fset

Defined in

fz_tool_api.h