Arguments

 

fab

   OpenVMS usage:fab
   type:         unspecified
   access:       read only
   mechanism:    by reference

   File Access Block (FAB) referencing a valid NAM block or NAML
   block. The fab argument is the address of the FAB that contains
   the address and length of the file specification being searched
   for by LIB$FILE_SCAN. On Alpha and I64 systems, NAML blocks
   support the use of file specifications with a maximum length
   of NAML$C_MAXRSS. See the OpenVMS Record Management Services
   Reference Manual for information on NAML blocks.
 

user-success-procedure

   OpenVMS usage:procedure
   type:         procedure value
   access:       function call (before return)
   mechanism:    by value

   User-supplied success routine that LIB$FILE_SCAN calls when
   a file is found. The success routine is invoked with the FAB
   address that was passed to LIB$FILE_SCAN. The user context may be
   pased to this routine using the FAB$L_CTX field in the FAB.
 

user-error-procedure

   OpenVMS usage:procedure
   type:         procedure value
   access:       function call (before return)
   mechanism:    by value

   User-supplied error routine that LIB$FILE_SCAN calls when it
   encounters an error. The error routine is called with the FAB
   argument that was passed to LIB$FILE_SCAN.
 

context

   OpenVMS usage:context
   type:         longword (unsigned)
   access:       modify
   mechanism:    by reference

   Default file context used in processing file specifications for
   multiple input files. The context argument is the address of
   a longword, which must be initialized to zero by your program
   before the first call to LIB$FILE_SCAN. After the first call,
   LIB$FILE_SCAN maintains this longword. You must not change the
   value of context in subsequent calls to LIB$FILE_SCAN.

   Name blocks and file specification strings are allocated by
   LIB$FILE_SCAN, and context is used to retain their addresses
   so they may be deallocated later. If the context argument is not
   passed, unspecified portions of the file specification will be
   inherited from the previous file specification processed, rather
   than from multiple input file specifications.