VMS Help RMS, $RENAME  *Conan The Librarian (sorry for the slow response - running on an old VAX)

    You can use this service to change the name, type, or version of
    a file, or to move a file to another directory by changing its
    directory specification. However, note that you cannot use this
    service to move a file to another device.

    Format

      SYS$RENAME  old-fab ,[err] ,[suc] ,new-fab

1 - Returns

    OpenVMS usage:cond_value
    type:         longword
    access:       write only
    mechanism:    by value

    The value is returned in symbolic offset FAB$L_STS. Symbolic
    offset FAB$L_STV may contain additional status information.

2 - Arguments

 old-fab

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

    FAB control block whose contents are to be used as indirect
    arguments for the Rename service call. The old-fab argument is
    the address of the FAB control block that specifies the old file
    name.

 err

    OpenVMS usage:ast_procedure
    type:         procedure value
    access:       call without stack unwinding
    mechanism:    by reference

    AST-level error completion routine that the service invokes if
    the operation is unsuccessful. The err argument is the address of
    the entry mask of this user-written completion routine.

 suc

    OpenVMS usage:ast_procedure
    type:         procedure value
    access:       call without stack unwinding
    mechanism:    by reference

    AST-level success completion routine that the service invokes if
    the operation is successful. The suc argument is the address of
    the entry mask of this user-written completion routine.

 new-fab

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

    The new-fab argument is the address of the FAB control block that
    specifies the new file name.

                                   NOTE

       If you invoke the Rename service using the $RENAME macro
       and if you do not specify arguments, you must construct an
       additional field within your argument list to contain the
       address of the FAB that specifies the new file name. This
       additional field is placed in the argument list following
       the field for the success completion routine and the
       argument count is set to 4.

3 - Condition Values Returned

 The following condition values can be returned. Use the Help Message
 utility to access online message descriptions.