REMOVE.POS Function

Gets the current position of the internal REMOVE pointer.

Syntax

X = REMOVE.POS( string)

Syntax Elements

string

Name of a string, which could be a dynamic array, whose internal REMOVE pointer position is being returned or set.

Operation

This function allows the value of the internal REMOVE pointer to be returned as a character position from the start of the string. If a string or number variable is referenced but has never been operated on by a REMOVE statement since it was assigned, it returns a position of zero - i.e. one before the start of the string. If a string or number variable is referenced that has been operated on by the REMOVE statement since it was assigned, it returns the current position. If the referenced variable cannot be converted into a string, the function will return -1 as the current position.

MultiValue Compatibility

Refer to MultiValue Compatibility.

See Also

REMOVE statement, REMOVE.POS statement, DELIM.POS function.