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

fz_fuim_prompt_line

Description

Sets the current prompt in the prompts palette. The provided string is placed on the specified line of the prompts palette. The line parameter indicates which line the string should be placed on.

Note: this function can only be called from within tool extensions in the click, track and prompt callback functions.

Plugin Prototype

fzrt_error_td fz_fuim_prompt_line(

char *

string,

fz_fuim_prompt_line_enum

line,

fz_fuim_prompt_edit_enum

edit_type )

Parameters

string [Input]

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

line [Input]

indicates what line to place the prompt

edit_type [Input]

indicates the type of prompt input

Returns

error codes

Availability

5.0.0.0

See Also

Function Set

fz_fuim_fset


Defined in

fz_fuim_api.h