formZ SDK | 5.0 API Reference | System | User Interface (FUIM)

# fz_fuim_prompt_name

Description

Sets the command name in the prompts palette. This function can be called from the fz_tool_cbak_select function from a tool command plugin to set the name of the tool at the top of the prompts palette. If this function is not called then the tool's name is used as the name at the top of the prompts palette.
Note: this function can only be called from within tool extensions.

Plugin Prototype

fzrt_error_td fz_fuim_prompt_name(

char * | name )

Parameters

name [Input]

name string to be placed at the top of the prompts palette

Returns

error codes

Availability

5.0.0.0

See Also

fz_tool_cbak_select, fz_tool_cbak_name

Function Set

fz_fuim_fset

Defined in

fz_fuim_api.h