<!-- $XConsortium: fil_dest.sgm /main/5 1996/08/30 12:46:20 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.MAN71.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN71.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_file_destroy</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_file_destroy</Function></RefName>
<RefPurpose>remove objected rooted on a file
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: fil_dest.sgm /main/5 1996/08/30 12:46:20 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_destroy</Function></FuncDef>
<ParamDef>const char *<Parameter>filepath</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_file_destroy</Function> function
removes all objects that exist on the files and directories rooted at
<Emphasis>filepath</Emphasis>. The application must call this function when the application
unlinks a file or removes a directory.
</Para>
<Para>The
<Emphasis>filepath</Emphasis> argument is a pointer to the pathname of the file or directory to be removed.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_file_destroy</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.
<![ %CDE.C.CDE; [It does not appear to exist; administrative action is required.
]]></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.
</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.move;; <![ %CDE.C.CDE; [<Function>unlink</Function>(2), <Command>rmdir</Command>(1). ]]><![ %CDE.C.XO; [<Function>unlink</Function>(2) in the &str-ZK;;
<Command>rmdir</Command>(1), in the &str-ZC;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
