newlib/libc/stdio/rename.c

   1 /*
   2  * Copyright (c) 1990 The Regents of the University of California.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms are permitted
   6  * provided that the above copyright notice and this paragraph are
   7  * duplicated in all such forms and that any documentation,
   8  * and/or other materials related to such
   9  * distribution and use acknowledge that the software was developed
  10  * by the University of California, Berkeley.  The name of the
  11  * University may not be used to endorse or promote products derived
  12  * from this software without specific prior written permission.
  13  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  14  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  16  */
  17
  18 /*
  19 FUNCTION
  20 <<rename>>---rename a file
  21
  22 INDEX
  23         rename
  24
  25 SYNOPSIS
  26         #include <stdio.h>
  27         int rename(const char *<[old]>, const char *<[new]>);
  28
  29 DESCRIPTION
  30 Use <<rename>> to establish a new name (the string at <[new]>) for a
  31 file now known by the string at <[old]>.  After a successful
  32 <<rename>>, the file is no longer accessible by the string at <[old]>.
  33
  34 If <<rename>> fails, the file named <<*<[old]>>> is unaffected.  The
  35 conditions for failure depend on the host operating system.
  36
  37 RETURNS
  38 The result is either <<0>> (when successful) or <<-1>> (when the file
  39 could not be renamed).
  40
  41 PORTABILITY
  42 ANSI C requires <<rename>>, but only specifies that the result on
  43 failure be nonzero.  The effects of using the name of an existing file
  44 as <<*<[new]>>> may vary from one implementation to another.
  45
  46 Supporting OS subroutines required: <<link>>, <<unlink>>, or <<rename>>.
  47 */
  48
  49 #include <_ansi.h>
  50 #include <reent.h>
  51 #include <stdio.h>
  52 #include <sys/unistd.h>
  53
  54 #ifndef _REENT_ONLY
  55
  56 int
  57 rename (const char *old,
  58        const char *new)
  59 {
  60   return _rename_r (_REENT, old, new);
  61 }
  62
  63 #endif