formZ SDK | 5.0 API Reference | System | Script Only
Description
Copies a range of characters from one string to the range of characters of another.
The range is defined by a starting character for each string and the number of subsequent
characters to copy from and to. The function returns an error, if the
starting character position for either string is not valid. If the number of
characters to be copied is less than the number of characters in either
range, only the number of characters in the range are copied.
If the terminate argument is TRUE, the destination string will end after
the copied characters. If FALSE, the original characters in the destination string
following the copied range, will remain.
Note, that it is important for this function, that the destination string contains
valid characters (i.e. it must be initialized).
Parameters
dst_str [Input, Result]
the destination string.
dst_start [Input]
the starting character in the destination string (0 based).
Range: 0 <= dst_start <= 255
src_str [Input]
the source string.
src_start [Input]
the starting character in the source string (0 based).
Range: 0 <= src_start <= 255
num_chars [Input]
the number of characters to copy.
Range: 1 <= num_chars <= 255
terminate [Input]
set to TRUE to terminate the destination string after the copied characters.
Returns
Error codes
Availability
5.5.0.0