--- freem/doc/freem.texi 2025/05/05 14:26:59 1.51 +++ freem/doc/freem.texi 2025/05/05 15:46:50 1.52 @@ -1115,7 +1115,7 @@ See @emph{https://wiki.osdev.org/Target_ * $ZLSD():: Compute Levenshtein distance between two arguments. * $ZM():: Unknown. * $ZNAME():: Unknown. -* $ZNEXT():: Unknown. +* $ZNEXT():: Return glvn of next numeric subscript following given glvn. * $ZORDER():: Unknown. * $ZPIECE():: Unknown. * $ZPREVIOUS():: Unknown. @@ -1313,6 +1313,28 @@ The optional second argument indicates t @cindex intrinsic functions, $NEXT Deprecated. Use @code{$ORDER} instead. +Returns the next numeric subscript of the specified glvn. + +@emph{Syntax} + +@example +$NEXT(@emph{glvn}) +@end example + +@emph{Example} + +Assume the following array: + +@example +^foo(1)="" +^foo(2)="" +@end example + +And the following code: + +@example + W $ZNEXT(^foo(1)) ; => 2 +@end example @node $ORDER() @section $ORDER @@ -1723,13 +1745,38 @@ Purpose unknown. Purpose unknown. +This function relies on the value of @code{$VIEW(71)} being @code{0} (this is not the default). + @node $ZNEXT() @section $ZNEXT @cindex $ZNEXT @cindex intrinsic functions, $ZNEXT @cindex intrinsic functions, implementation-specific -Purpose unknown. +Returns a fully-formed variable reference of the next numeric subscript of the specified glvn. + +@emph{Syntax} + +@example +$ZNEXT(@emph{glvn}) +@end example + +@emph{Example} + +Assume the following array: + +@example +^foo(1)="" +^foo(2)="" +@end example + +And the following code: + +@example + W $ZNEXT(^foo(1)) ; => ^foo(2) +@end example + +This function relies on the value of @code{$VIEW(71)} being @code{1} (this is the default). @node $ZORDER() @section $ZORDER