Topic       : The ATARI Compendium
Author      : Scott Sanders / JAY Software
Version     : 1.25 (20/6/2003)
Subject     : Documentation
Nodes       : 1117
Index Size  : 32614
HCP-Version : 6
Compiled on : Atari
@charset    : UTF-8
@lang       : en
@default    : 
@help       : %About
@options    : +g -i -t4 +y +z
@width      : 100
View Ref-FileFrename()                                                            GEMDOS

Syntax

LONG Frename( reserved, oldname, newname )
WORD reserved;
char *oldname,*newname;

Function      Frename() renames a standard GEMDOS file. It may also be
              used to move a file in the tree structure of a physical
              drive.

Opcode        86 (0x56)

Availability  All GEMDOS versions.

Parameters    reserved is not currently used and should be 0. oldname is
              the GEMDOS file specification of the file's current
              name/location. newname is the GEMDOS file specification of

              the new name/location of the file.

Binding       pea      newname
              pea      oldname
              move.w   #0,-(sp)
              trap     #1
              move.w   #$56,-(sp)
              lea      12(sp),sp

Return Value  Frename() returns E_OK (0) if the operation was successful
              or a negative GEMDOS error code if not.

Caveats       Prior to GEMDOS version 0.15, this command may not be used
              to rename folders. Also, do not attempt to rename a file
              that is currently open under any version of GEMDOS.