NAME

       position-list -  (linked-list)

PURPOSE

       Set current element in a linked list.

SYNTAX

           position-list <list> \
               [ first | last | end | previous | next | \
               [ status <status> ]

DESCRIPTION

       position-list  changes  the  current  element of linked <list>. A current element is the one that is read
       with read-list. A newly added element is written with write-list by inserting it just before the  current
       element,  thus  becoming  a new current element. Reading from <list> does not change its current element;
       use position-list to explicitly change it.

       To position to the first element, use "first" clause. Use "last" clause to  make  the  last  element  the
       current one. Use "previous" and "next" to change the current element to just before or just after it.

       A  position just beyond the last element in <list> is considered the "end" of it; in this case write-list
       will append an element to <list> and this element becomes its last, which is equivalent to  using  write-
       list statement with "append" clause.

       Use  "end"  clause  to set current element to <list>'s end. Note that "end" clause is equivalent to using
       "next" clause on the last element in <list>.

       If you attempt to position prior to the first element, after the end of <list>, or anywhere in  an  empty
       list,  then  <status> number (in "status" clause") is GG_ERR_EXIST, otherwise it is GG_OKAY. Note that if
       <status> is GG_ERR_EXIST, the current element will not change.

EXAMPLES

       Position to the next element in list:

           position-list mylist next status st
           if-true st equal GG_ERR_EXIST
               @Beyond the end of list
           end-if

       Position to the first element in list:

           position-list mylist first

SEE ALSO

        Linked list

       delete-list get-list new-list position-list purge-list read-list write-list See all documentation

$DATE                                               $VERSION                                           GOLF(2gg)