VMS Help  —  DECTPU  TPU$FILE_PARSE, Arguments
 result-string

    OpenVMS usage: char_string
    type:          character string
    access:        write only
    mechanism:     by descriptor
    Includes the components of the file specification specified by
    the flags argument. The memory for the return string is allocated
    via the Run-Time Library routine LIB$SGET1_DD. Use the Run-Time
    Library routine LIB$SFREE1_DD to deallocate the memory for the
    return string.

 flags

    OpenVMS usage: longword_unsigned
    type:          longword (unsigned)
    access:        read only
    mechanism:     by reference
    Determine what file specification components should be returned.
    The following table shows the valid values for the flags
    argument:

    Flag Bit(1)       Description

    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_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 signals the
                      error TPU$_INCKWDCOM and returns control to the
                      caller.
    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 signals the
                      error TPU$_INCKWDCOM and returns control to the
                      caller.

    (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
    Contains the default file specification. The default file
    specification fields are used in the result string as substitutes
    for fields omitted in the filespec argument. You can also
    make substitutions in the result string using the related-spec
    argument.

    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 substituted in the result-string
    if a particular field is missing from both the filespec and
    default-spec arguments.

    Use the value 0 when no default-spec is to be applied to the file
    specification.
Close Help