formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Text Object
Description
Gets the replace string of model text search parameters. Matching text will be replaced by this string if the action was set to FZ_TEXT_SRCH_ACTION_REPLACE in fz_objt_text_search_init. 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_repl_unistr(
srch_parms, | |
text, | |
fzrt_int * | text_len, |
select ) |
Parameters
srch_parms [Input]
Search parameters.
text [Result, Optional]
The text to replace matching text with.
text_len [Input, Result, Optional]
The number of characters in text.
select [Result, Optional]
This will be set to TRUE if the text replacement is selected as a search parameter.
Returns
Error codes
Availability
6.0.0.0
Example Files
See Also
Function Set
Defined in