HELPLIB.HLB  —  RTL Routines, LIB$  LIB$RENAME_FILE, Arguments
 old-filespec

    OpenVMS usage:char_string
    type:         character string
    access:       read only
    mechanism:    by descriptor

    File specification of the files to be renamed. The old-filespec
    argument is the address of a descriptor pointing to the old file
    specification. The specification may include wildcards, in which
    case each file that matches the specification will be renamed.
    If running on Alpha or I64 and flag LIB$M_FIL_LONG_NAMES is set,
    the string must not contain more characters than specified by
    NAML$C_MAXRSS, otherwise the string must not contain more than
    255 characters. Any string class is supported.

 new-filespec

    OpenVMS usage:char_string
    type:         character string
    access:       read only
    mechanism:    by descriptor

    File specification for the new file names. The new-filespec
    argument is the address of a descriptor pointing to the new file
    specification.

    This specification need not be complete; fields omitted or
    specified by using the wildcard character (*)  will be filled in
    from the existing file's name using the same rules as for the DCL
    command RENAME. If running on Alpha or I64 and flag LIB$M_FIL_
    LONG_NAMES is set, the string must not contain more characters
    than specified by NAML$C_MAXRSS, otherwise the string must not
    contain more than 255 characters. Any string class is supported.

 default-filespec

    OpenVMS usage:char_string
    type:         character string
    access:       read only
    mechanism:    by descriptor

    Default file specification of the files to be renamed. The
    default-filespec argument is the address of a descriptor pointing
    to the default file specification.

    This is an optional argument; if omitted, the default is the
    null string. See the OpenVMS Record Management Services Reference
    Manual for information on default file specifications. If running
    on Alpha or I64 and flag LIB$M_FIL_LONG_NAMES is set, the string
    must not contain more characters than specified by NAML$C_MAXRSS,
    otherwise the string must not contain more than 255 characters.
    Any string class is supported.

 related-filespec

    OpenVMS usage:char_string
    type:         character string
    access:       read only
    mechanism:    by descriptor

    Related file specification of the files to be renamed. The
    related-filespec argument is the address of a descriptor pointing
    to the related file specification. This is an optional argument;
    if omitted, the default is the null string. Any string class is
    supported.

    Input file parsing is used. (See the OpenVMS Record Management
    Services Reference Manual for information on related file
    specifications and input file parsing.)

    The related file specification is useful when you are processing
    lists of file specifications. Unspecified portions of the file
    specification are inherited from the last file processed. Any
    string class is supported. This is an optional argument.

 flags

    OpenVMS usage:mask_longword
    type:         longword (unsigned)
    access:       read only
    mechanism:    by reference

    Longword of flag bits designating optional behavior. The flags
    argument is the address of an unsigned longword containing the
    flag bits. This is an optional argument; if omitted, the default
    is that all flags are clear.

    The bit number and its meaning are as follows:

    Bit  Symbol             Description

    0    LIB$M_FIL_CUR_VER  If new-filespec does not specify a
                            version number, this flag controls
                            whether a new version number for the
                            output file is to be assigned. If this
                            bit is set, the current version number of
                            the file is used.

                            If this bit is clear, the file is given
                            a version number 1 higher than any
                            previously existing file of the same file
                            name and file type. This is the default
                            action.

 If a file already exists with the same file name, type and version
 number, the error RMS$_FEX is given. This flag is equivalent to the
Additional Information: explode extract

/NONEW_VERSION qualifier of the DCL command RENAME.)
Close Help