formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Text Object

# fz_objt_text_search_text_parm_get

Description

Gets model text parameters. This allows several text construction parameters to be used as search parameters. These can only be used as search parameters. The values of these parameters on text objects can not be changed using the FZ_TEXT_SRCH_ACTION_REPLACE action. Some of the parameters have a slightly different interpretation than when used for text object construction/editing: These differences are as follows:
FZ_OBJT_TEXT_PARM_FRND_FRNT_TYPE, FZ_OBJT_TEXT_PARM_FRND_BACK_TYPE: These are bitwise or's of facetted rounding type bits (since more than one type can be used as a search parameter).
FZ_OBJT_TEXT_PARM_SRND_FRNT_TYPE, FZ_OBJT_TEXT_PARM_SRND_BACK_TYPE: These are bitwise or's of smooth rounding type bits (since more than one type can be used as a search parameter).
FZ_OBJT_TEXT_PARM_STRING: Not used in this function. Use to get the search string and to get the replace string.
FZ_OBJT_TEXT_PARM_PATH_OBJ1: Not used in this function.
FZ_OBJT_TEXT_PARM_PATH_OBJ2: Not used in this function.
FZ_OBJT_TEXT_PARM_MODEL_TYPE: Not used in this function.
FZ_OBJT_TEXT_PARM_ORIGIN: Not used in this function.
FZ_OBJT_TEXT_PARM_FRND_FRNT_TYPE: Not used in this function. Use with FZ_OBJT_TEXT_PARM_FRND_FRNT_TYPE_NORM, FZ_OBJT_TEXT_PARM_FRND_FRNT_TYPE_RND, or FZ_OBJT_TEXT_PARM_FRND_FRNT_TYPE_BEVL parameters selection.
FZ_OBJT_TEXT_PARM_BACK_FRNT_TYPE: Not used in this function. Use with FZ_OBJT_TEXT_PARM_FRND_BACK_TYPE_NORM, FZ_OBJT_TEXT_PARM_FRND_BACK_TYPE_RND, or FZ_OBJT_TEXT_PARM_FRND_BACK_TYPE_BEVL parameters selection.

Plugin Prototype

fzrt_error_td fz_objt_text_search_text_parm_get(

fz_text_search_parm_ptr | srch_parms,
fz_objt_text_parm_enum | which,
fz_text_search_range_enum | min_max,
fzrt_boolean * | select,
fz_type_td * | val )

Parameters

srch_parms [Input]

Search parameters.

which [Input]

Parameter identifier.

min_max [Input]

Specified whether the minimum or maximum of the search range is being set.

select [Result]

This will be set to TRUE if the parameter is selected as a search parameter.

val [Result]

The value of the parameter

Returns

Error codes

Availability

6.0.0.0

Example Files

util_objt_text_search.fsl

See Also

fz_objt_text_search_init

Function Set

fz_model_fset

Defined in

fz_objt_text_api.h