Topic       : TOS - The Operating System
Author      : 
Version     : tos.hyp (December 19, 2008)
Subject     : Programmieren/Atari
Nodes       : 3010
Index Size  : 93790
HCP-Version : 5
Compiled on : Atari
@charset    : atarist
@lang       : 
@default    : Title
@help       : 
@options    : +g -i -s +x +zz -t4
@width      : 70
View Ref-File5.10.25  Frename                                                   TOS

 Name:         »file rename« - Rename a GEMDOS file.

 Opcode:       86

 Syntax:       int32_t Frename ( const int8_t *oldname, const int8_t 
               *newname );

 Description:  The GEMDOS routine Frename serves for renaming files. 
               The new name may also contain a complete access path 
               within the relevant physical drive; in that case the 
               file will be moved. The following apply:

                Parameter  Meaning

                oldname    Pointer to present name
                newname    Pointer to new name

               Note: As of GEMDOS Version 0.15 it is possible to alter 
               the names of directories as well. However, these cannot 
               be moved. One should avoid renaming files that are 
               already open.

               Note about MagiC: It is up to the XFS to decide whether 
               directories may be renamed or moved. The integrated 
               DOS-XFS only allows a moving of directories as of MagiC 
               5.

 Return value: The function returns the following results:

                E_OK :    No error has arisen
                EPTHNF :  Directory not found
                EACCDN :  Access denied (write-protected)
                ENSAME :  Destination not on same drive

 Availability: All GEMDOS versions.

 Group:        File functions

 See Also:     Binding   Fdelete   XFS-concept in MagiC