AIPS HELP file for EGETNAME in 31DEC24

As of Thu Oct 10 16:58:19 2024

INPUTS

         $The slot number is given as the immediate argument
         $       Input/output adverb:
INDISK   $     0.0        9.0      Disk drive #.  0 => any
         @       Output adverbs:
INNAME   @                         1st input file (name)
INCLASS  @                         1st input file (class)
INSEQ    @      0.0       9999.0   1st input file (seq #)
INTYPE   @                         1st input file (type)
ERROR    @    -1.0        1.0      > 0 => slot empty, assigned
         @                         to someone else, too high
         $EGETNAME differs from GETNAME in that it returns ERROR
         $to POPS rather than quitting on common errors.
         $The slot number is given as the immediate argument

HELP SECTION

EGETNAME
Type: Verb
Use:  EGETNAME(n) will interpret its immediate argument as a catalog
      slot number and assign adverbs INNAME, INCLASS, INSEQ, and
      INDISK to correspond to that slot.  EGETNAME allows the user to
      handle error conditions rather than having POPS simply abort the
      input line on error.  For example:
            PROC ZAPIT (X, Y)
            FOR I = X TO Y;
               EGETNAME (I)
               IF ^ ERROR THEN ZAP; END
               END
            FINISH
      ZAPs consecutive slots skipping empty ones.

      Example:
         EGETNAME(24) will fill INNAME, INCLASS, and INSEQ with the
         24'th catalog entry on disk INDISK.  If INDISK was zero,
         the first disk with a catalog entry in the 24'th slot will be
         the disk number to which INDISK is set.
Input adverbs:  The immediate argument is a catalog slot number.
  INDISK......The disk the catalog is on.  0 => any
Output adverbs:
  ERROR.......(Output) False (-1) => name parameters set; True (1)
              => slot number too high, slot empty, or slot
              assigned to another user.
  INNAME......First image name (name)
  INCLASS.....First image name (class).
  INSEQ.......First image name (seq. #).
  INTYPE......First image name (type).
  INDISK......Disk drive # of first image

EXPLAIN SECTION