Arguments

 

result-string

   OpenVMS usage: char_string
   type:          character string
   access:        write only
   mechanism:     by descriptor
   Return value for the built-in procedure FILE_SEARCH. Your program
   should fill in this descriptor with a dynamic string allocated
   by the string routines such as the Run-Time Library routine
   LIB$SGET1_DD. TPU frees this string when necessary.

   The TPU$M_REPARSE bit is set in the flags longword if the result-
   string has a length of zero. The bit is intended to reset the
   file search when wildcard searches are performed.
 

flags

   OpenVMS usage: longword_unsigned
   type:          longword (unsigned)
   access:        read only
   mechanism:     by reference
   The following table shows the flags used for specifying the file
   components:

   Flag(1)           Function

   TPU$M_NODE        Requests for the node component of the file
                     specification.
   TPU$M_DEV         Requests for the device component of the file
                     specification.
   TPU$M_DIR         Requests for the directory component of the
                     file specification.
   TPU$M_NAME        Requests for the name component of the file
                     specification.
   TPU$M_TYPE        Requests for the type component of the file
                     specification.
   TPU$M_VER         Requests for the version component of the file
                     specification.
   TPU$M_REPARSE     Reparses the file specification before
                     processing. This is intended as a way to
                     restart the file search. This flag will
                     automatically be set by TPU if on a previous
                     call to the FILE_SEARCH user routine the
                     result-string has a zero length or the routine
                     returns a odd (noneven) status.
   TPU$M_HEAD        Requests for the NODE, DEVICE, and DIRECTORY
                     components of the file specification.
   TPU$M_TAIL        Requests for the NAME, TYPE, and VERSION
                     component of the file specification.

   (1) TPU$M... indicates a mask. There is a corresponding value for
   each mask in the form TPU$V...
 

filespec

   OpenVMS usage: char_string
   type:          character string
   access:        read only
   mechanism:     by descriptor
   The object file specification.
 

default-spec

   OpenVMS usage: char_string
   type:          character string
   access:        read only
   mechanism:     by descriptor
   The default-spec argument contains the default file
   specification.

   The value 0 is passed if there is no default-spec.
 

related-spec

   OpenVMS usage: char_string
   type:          character string
   access:        read only
   mechanism:     by descriptor
   The related-spec argument contains the related file
   specification.

   The value 0 is passed if there is no related-spec.