<!-- $XConsortium: fil_move.sgm /main/5 1996/08/30 12:46:39 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN73.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN73.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_file_move</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_file_move</Function></RefName>
<RefPurpose>move objects from one file to another
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: fil_move.sgm /main/5 1996/08/30 12:46:39 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_file_move</Function></FuncDef>
<ParamDef>const char *<Parameter>oldfilepath</Parameter></ParamDef>
<ParamDef>const char *<Parameter>newfilepath</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_file_move</Function> function
destroys all objects that exist on the files and directories rooted at
<Emphasis>newfilepath</Emphasis>, then moves all objects that exist on
<Emphasis>oldfilepath</Emphasis> to
<Emphasis>newfilepath</Emphasis>.</Para>
<Para>If
<Emphasis>oldfilepath</Emphasis> and
<Emphasis>newfilepath</Emphasis> reside in the same file system,
<Function>tt_file_move</Function> replaces
<Emphasis>oldfilepath</Emphasis> with
<Emphasis>newfilepath</Emphasis> in the path associated with every object in
that file system; that is, all the objects in the directory tree rooted at
<Emphasis>oldfilepath</Emphasis> are overlaid onto
<Emphasis>newfilepath</Emphasis>. In this mode, the behavior of
<Function>tt_file_move</Function> is similar to
<Function>rename</Function>(2).</Para>
<Para>If
<Emphasis>oldfilepath</Emphasis> and
<Emphasis>newfilepath</Emphasis> reside in different file systems, neither can be a directory.
</Para>
<Para>The
<Emphasis>oldfilepath</Emphasis> argument is the name of the file or directory whose objects are to be moved.
The
<Emphasis>newfilepath</Emphasis> argument is the name of the file or directory to which the objects
are to be moved.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_file_move</Function> function returns the status of the operation as one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_ACCESS</Term>
<ListItem>
<Para>The user does not have the necessary access to the object and/or the process.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBAVAIL</Term>
<ListItem>
<Para>The ToolTalk service could not access the
ToolTalk database needed for this operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBEXIST</Term>
<ListItem>
<Para>The ToolTalk service could not access the
specified ToolTalk database in the expected place.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_FILE</Term>
<ListItem>
<Para>The specified file does not exist or it is inaccessible.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PATH</Term>
<ListItem>
<Para>The specified pathname included an unsearchable directory,
or
<Emphasis>oldfilepath</Emphasis> and
<Emphasis>newfilepath</Emphasis> reside in different file systems, and either is a directory.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_POINTER</Term>
<ListItem>
<Para>The pointer passed does not point to an object of
the correct type for this operation.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.file.copy;, &cdeman.tt.file.destroy;; <![ %CDE.C.CDE; [<Function>rename</Function>(2). ]]><![ %CDE.C.XO; [<Function>rename</Function>(2) in the &str-ZK;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
