result-string
OpenVMS usage: char_string
type: character string
access: write only
mechanism: by descriptor
Includes the components of the file specification passed by the
flags argument. The memory for the return string is allocated via
the Run-Time Library routine LIB$SGET1_DD. To deallocate memory
for the string, use the Run-Time Library routine LIB$SFREE1_DD.
flags
OpenVMS usage: longword_unsigned
type: longword (unsigned)
access: read only
mechanism: by reference
Determines what file specification components should be returned.
The following table lists the valid flag values:
Flag(1) Function
TPU$M_NODE Returns the node component of the file
specification.
TPU$M_DEV Returns the device component of the file
specification.
TPU$M_DIR Returns the directory component of the file
specification.
TPU$M_NAME Returns the name component of the file
specification.
TPU$M_TYPE Returns the type component of the file
specification.
TPU$M_VER Returns the version component of the file
specification.
TPU$M_REPARSE Reparses the file specification before
processing. This is intended to be used to
reset the file search.
TPU$M_HEAD Returns NODE, DEVICE, and DIRECTORY components
of the file specification. If the TPU$M_NODE,
TPU$M_DEV or TPU$M_DIR bits are set while
TPU$M_HEAD is set, the routine will signal
the error TPU$_INCKWDCOM and return.
TPU$M_TAIL Returns NAME, TYPE and VERSION components of
the file specification. If the TPU$M_NAME,
TPU$M_TYPE or TPU$M_VER bits are set while
TPU$M_TAIL is set, the routine will signal the
error TPU$_INCKWDCOM and return.
(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
Object file specification.
default-spec
OpenVMS usage: char_string
type: character string
access: read only
mechanism: by descriptor
The default file specification. The default file specification
fields are used to fill in the result-string when fields are
omitted in the filespec argument. Use the related-spec argument
to specify other substitutions.
Use the value 0 when no default-spec is to be applied to the file
specification.
related-spec
OpenVMS usage: char_string
type: character string
access: read only
mechanism: by descriptor
Contains the related file specification. The fields in the
related file specification are used in the result-string for
fields omitted in the filespec and default-spec arguments.
Use the value 0 when no default-spec is to be applied to the file
specification.