── REMAININGCHARS ── ( ──<pointer expression>── ) ─────────────────────┤

The REMAININGCHARS function returns, as an integer value, the number of characters between the character position referenced by the pointer expression and the end of the array row, including the character designated by the pointer expression. The returned value is in terms of the character size of the pointer expression. If the pointer expression is a word pointer, the value returned is in terms of 8-bit characters. If the pointer expression points to a paged (segmented) array, the REMAININGCHARS function returns the number of characters left in the entire array row.

If an uninitialized pointer is passed to the REMAININGCHARS function, the program is terminated with a fault. This fault can be trapped with an ON ANYFAULT statement or an ON INVALIDOP statement to prevent termination.

For a function that returns the number of characters between the character position referenced by a pointer expression and the beginning of the array row, see OFFSET Function.