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

# fz_objt_edit_text_get_string_range

Description

Gets a substring of a text object's string. The substring is specified by the inclusive range from start_char to end_char.
max_length characters are copied into str. str must be allocated by the calling function and must be at least max_length*sizeof( fzrt_uni_char) bytes.

Plugin Prototype

fzrt_error_td fz_objt_edit_text_get_string_range(

fzrt_int | windex,
fz_objt_ptr | obj,
fzrt_int | start_char,
fzrt_int | end_char,
fzrt_uni_char * | str,
fzrt_int | max_length )

Parameters

windex [Input]

project window index

obj [Input]

text object

start_char [Input]

the character index to start copying

end_char [Input]

the character index of the last character to copy

str [Result]

the string

max_length [Input]

The maximum number of characters to copy into str

Returns

Error codes

Availability

5.5.0.0

Example Files

util_objt_unistr_text.fsl

Function Set

fz_model_fset

Defined in

fz_objt_text_api.h