ANYCNTRL Function

Searches a character string for a control character and returns the first position at which it is found

Category: Character

Syntax

ANYCNTRL ( string <, start >)

Arguments

string

• is the character constant, variable, or expression to search.

start

• is an optional integer that specifies the position at which the search should start and the direction in which to search.

Details

The ANYCNTRL function searches a string for the first occurrence of a control character. If such a character is found, ANYCNTRL returns the position in the string of that character. If no such character is found, ANYCNTRL returns a value of 0.

If you use only one argument, ANYCNTRL begins the search at the beginning of the string. If you use two arguments, the absolute value of the second argument, start , specifies the position at which to begin the search. The direction in which to search is determined in the following way:

• If the value of start is positive, the search proceeds to the right.

• If the value of start is negative, the search proceeds to the left.

• If the value of start is less than the negative length of the string, the search begins at the end of the string.

ANYCNTRL returns a value of zero when

• the character that you are searching for is not found

• the value of start is greater than the length of the string

• the value of start =0.

Comparisons

The ANYCNTRL function searches a character string for a control character. The NOTCNTRL function searches a character string for a character that is not a control character.

See Also

Function:

• 'NOTCNTRL Function' on page 669