72 lines
7.4 KiB
HTML
72 lines
7.4 KiB
HTML
<!-- Common Lisp HyperSpec (TM), version 7.0 generated by Kent M. Pitman on Mon, 11-Apr-2005 2:31am EDT -->
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>CLHS: Function RENAME-FILE</TITLE>
|
|
<LINK HREF="../Data/clhs.css" REL="stylesheet" TYPE="text/css" />
|
|
<META HTTP-EQUIV="Author" CONTENT="Kent M. Pitman">
|
|
<META HTTP-EQUIV="Organization" CONTENT="LispWorks Ltd.">
|
|
<LINK REL=TOP HREF="../Front/index.htm">
|
|
<LINK REL=COPYRIGHT HREF="../Front/Help.htm#Legal">
|
|
<LINK REL=DISCLAIMER HREF="../Front/Help.htm#Disclaimer">
|
|
<LINK REL=PREV HREF="f_file_w.htm">
|
|
<LINK REL=UP HREF="c_files.htm">
|
|
<LINK REL=NEXT HREF="f_del_fi.htm">
|
|
</HEAD>
|
|
<BODY>
|
|
<H1><A REV=MADE HREF="http://www.lispworks.com/"><IMG WIDTH=80 HEIGHT=65 ALT="[LISPWORKS]" SRC="../Graphics/LWSmall.gif" ALIGN=Bottom></A><A REL=TOP HREF="../Front/index.htm"><IMG WIDTH=237 HEIGHT=65 ALT="[Common Lisp HyperSpec (TM)]" SRC="../Graphics/CLHS_Sm.gif" ALIGN=Bottom></A> <A REL=PREV HREF="f_file_w.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_files.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_del_fi.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
|
|
|
<HR>
|
|
|
|
<A NAME="rename-file"><I>Function</I> <B>RENAME-FILE</B></A> <P>
|
|
<P><B>Syntax:</B><P>
|
|
<P>
|
|
|
|
<B>rename-file</B> <I>filespec new-name</I> => <I>defaulted-new-name, old-truename, new-truename</I><P>
|
|
<P>
|
|
<P><B>Arguments and Values:</B><P>
|
|
<P>
|
|
<I>filespec</I>---a <A REL=DEFINITION HREF="26_glo_p.htm#pathname_designator"><I>pathname designator</I></A>. <P>
|
|
<I>new-name</I>---a <A REL=DEFINITION HREF="26_glo_p.htm#pathname_designator"><I>pathname designator</I></A> other than a <A REL=DEFINITION HREF="26_glo_s.htm#stream"><I>stream</I></A>. <P>
|
|
<I>defaulted-new-name</I>---a <A REL=DEFINITION HREF="26_glo_p.htm#pathname"><I>pathname</I></A> <P>
|
|
<I>old-truename</I>---a <A REL=DEFINITION HREF="26_glo_p.htm#physical_pathname"><I>physical pathname</I></A>. <P>
|
|
<I>new-truename</I>---a <A REL=DEFINITION HREF="26_glo_p.htm#physical_pathname"><I>physical pathname</I></A>. <P>
|
|
<P><B>Description:</B><P>
|
|
<P>
|
|
<A REL=DEFINITION HREF="#rename-file"><B>rename-file</B></A> modifies the file system in such a way that the file indicated by <I>filespec</I> is renamed to <I>defaulted-new-name</I>. <P>
|
|
It is an error to specify a filename containing a <A REL=DEFINITION HREF="26_glo_w.htm#wild"><I>wild</I></A> component, for <I>filespec</I> to contain a <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A> component where the file system does not permit a <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A> component, or for the result of defaulting missing components of <I>new-name</I> from <I>filespec</I> to contain a <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A> component where the file system does not permit a <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A> component. <P>
|
|
If <I>new-name</I> is a <A REL=DEFINITION HREF="26_glo_l.htm#logical_pathname"><I>logical pathname</I></A>, <A REL=DEFINITION HREF="#rename-file"><B>rename-file</B></A> returns a <A REL=DEFINITION HREF="26_glo_l.htm#logical_pathname"><I>logical pathname</I></A> as its <A REL=DEFINITION HREF="26_glo_p.htm#primary_value"><I>primary value</I></A>. <P>
|
|
<A REL=DEFINITION HREF="#rename-file"><B>rename-file</B></A> returns three values if successful. The <A REL=DEFINITION HREF="26_glo_p.htm#primary_value"><I>primary value</I></A>, <I>defaulted-new-name</I>, is the resulting name which is composed of <I>new-name</I> with any missing components filled in by performing a <A REL=DEFINITION HREF="f_merge_.htm#merge-pathnames"><B>merge-pathnames</B></A> operation using <I>filespec</I> as the defaults. The <A REL=DEFINITION HREF="26_glo_s.htm#secondary_value"><I>secondary value</I></A>, <I>old-truename</I>, is the <A REL=DEFINITION HREF="26_glo_t.htm#truename"><I>truename</I></A> of the <A REL=DEFINITION HREF="26_glo_f.htm#file"><I>file</I></A> before it was renamed. The <A REL=DEFINITION HREF="26_glo_t.htm#tertiary_value"><I>tertiary value</I></A>, <I>new-truename</I>, is the <A REL=DEFINITION HREF="26_glo_t.htm#truename"><I>truename</I></A> of the <A REL=DEFINITION HREF="26_glo_f.htm#file"><I>file</I></A> after it was renamed. <P>
|
|
If the <I>filespec</I> <A REL=DEFINITION HREF="26_glo_d.htm#designator"><I>designator</I></A> is an open <A REL=DEFINITION HREF="26_glo_s.htm#stream"><I>stream</I></A>, then the <A REL=DEFINITION HREF="26_glo_s.htm#stream"><I>stream</I></A> itself and the file associated with it are affected (if the <A REL=DEFINITION HREF="26_glo_f.htm#file_system"><I>file system</I></A> permits). <P>
|
|
<P><B>Examples:</B><P>
|
|
<P>
|
|
<PRE>
|
|
;; An example involving logical pathnames.
|
|
(with-open-file (stream "sys:chemistry;lead.text"
|
|
:direction :output :if-exists :error)
|
|
(princ "eureka" stream)
|
|
(values (pathname stream) (truename stream)))
|
|
=> #P"SYS:CHEMISTRY;LEAD.TEXT.NEWEST", #P"Q:>sys>chem>lead.text.1"
|
|
(rename-file "sys:chemistry;lead.text" "gold.text")
|
|
=> #P"SYS:CHEMISTRY;GOLD.TEXT.NEWEST",
|
|
#P"Q:>sys>chem>lead.text.1",
|
|
#P"Q:>sys>chem>gold.text.1"
|
|
</PRE>
|
|
</TT> <P>
|
|
<P><B>Affected By:</B> None.
|
|
<P>
|
|
<P><B>Exceptional Situations:</B><P>
|
|
<P>
|
|
If the renaming operation is not successful, an error of <A REL=DEFINITION HREF="26_glo_t.htm#type"><I>type</I></A> <A REL=DEFINITION HREF="e_file_e.htm#file-error"><B>file-error</B></A> is signaled. <P>
|
|
An error of <A REL=DEFINITION HREF="26_glo_t.htm#type"><I>type</I></A> <A REL=DEFINITION HREF="e_file_e.htm#file-error"><B>file-error</B></A> might be signaled if <I>filespec</I> is <A REL=DEFINITION HREF="26_glo_w.htm#wild"><I>wild</I></A>. <P>
|
|
<P><B>See Also:</B><P>
|
|
<P>
|
|
<A REL=DEFINITION HREF="f_tn.htm#truename"><B>truename</B></A>, <A REL=DEFINITION HREF="t_pn.htm#pathname"><B>pathname</B></A>, <A REL=DEFINITION HREF="t_logica.htm#logical-pathname"><B>logical-pathname</B></A>, <A REL=CHILD HREF="20_a.htm">Section 20.1 (File System Concepts)</A>, <A REL=CHILD HREF="19_ab.htm">Section 19.1.2 (Pathnames as Filenames)</A> <P>
|
|
<P><B>Notes:</B> None.
|
|
<P>
|
|
<P><HR>The following <A REL=META HREF="../Front/X3J13Iss.htm">X3J13 cleanup issues</A>, <I>not part of the specification</I>, apply to this section:<P><UL><LI> <A REL=CHILD HREF="../Issues/iss157.htm">FILE-OPEN-ERROR:SIGNAL-FILE-ERROR</A><LI> <A REL=CHILD HREF="../Issues/iss267.htm">PATHNAME-WILD:NEW-FUNCTIONS</A><LI> <A REL=CHILD HREF="../Issues/iss259.htm">PATHNAME-LOGICAL:ADD</A><P></UL><HR>
|
|
|
|
<A REL=NAVIGATOR HREF="../Front/StartPts.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Starting Points]" SRC="../Graphics/StartPts.gif" ALIGN=Bottom></A><A REL=TOC HREF="../Front/Contents.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Contents]" SRC="../Graphics/Contents.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Master.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Index]" SRC="../Graphics/Index.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Symbol.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Symbols]" SRC="../Graphics/Symbols.gif" ALIGN=Bottom></A><A REL=GLOSSARY HREF="../Body/26_a.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Glossary]" SRC="../Graphics/Glossary.gif" ALIGN=Bottom></A><A HREF="../Front/X3J13Iss.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Issues]" SRC="../Graphics/Issues.gif" ALIGN=Bottom></A><BR>
|
|
|
|
<A REL=COPYRIGHT HREF="../Front/Help.htm#Legal"><I>Copyright 1996-2005, LispWorks Ltd. All rights reserved.</I></A><P>
|
|
</BODY>
|
|
</HTML>
|