GETREM function

Syntax

 GETREM (dynamic.array)

Description

Use the GETREM function after the execution of a REMOVE statement, a REMOVE function, or a REVREMOVE statement, to return the numeric value for the character position of the pointer associated with dynamic.array.

dynamic.array evaluates to the name of a variable containing a dynamic array.

The returned value is an integer. The integer returned is one-based, not zero-based. If no REMOVE statements have been executed on dynamic.array, 1 is returned. At the end of dynamic.array, GETREM returns the length of dynamic array plus 1. The offset returned by GETREM indicates the first character of the next dynamic array element to be removed.

Example

DYN = "THIS":@FM:"HERE":@FM:"STRING"
REMOVE VAR FROM DYN SETTING X
PRINT GETREM(DYN)

This is the program output:

5