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

# fz_objt_text_search_get_srch_unistr

Description

Gets the search string of model text search parameters. text must be allocated by the calling function. The text_len parameter serves 2 purposes. First it tells this function how many characters to copy into text. Second, it is filled with the number of characters in the replace text. So, this function can be called with text set to NULL to get the size of the text. Then text can be allocated to that size and this function called again to fill text.

Plugin Prototype

fzrt_error_td fz_objt_text_search_get_srch_unistr(

fz_text_search_parm_ptr | srch_parms,
fzrt_uni_char * | text,
fzrt_int * | text_len,
fzrt_boolean * | select )

Parameters

srch_parms [Input]

Search parameters.

text [Result, Optional]

The text to search for. This must be preallocated by the caller.

text_len [Input, Result, Optional]

The number of characters in text.

select [Result, Optional]

This will be set to TRUE if the text is selected as a search 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