formZ SDK | 5.0 API Reference | System | Script Only

# fz_std_strcmp_range

Description

Compares the ranges of two strings to be equal. The range is defined by a starting character position for each string and the number of subsequent characters to compare.

Parameters

str1 [Input]

the first string.

start1 [Input]

the starting character in the first string (0 based).

Range: 0 <= start1 <= 255

str2 [Input]

the second string.

start2 [Input]

the starting character in the second string (0 based).

Range: 0 <= start2 <= 255

num_chars [Input]

the number of characters to compare.

Range: 1 <= num_chars <= 255

Returns

The function returns 0 if the string ranges are equal, less than 0 if str1 is less than str2 and greater than 0 if str1 is greater than str2. If the starting character position of either string is invalid, -1 is returned.

Availability

5.5.0.0