<!-- $XConsortium: f_quit.sgm /main/5 1996/08/30 14:28:37 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.MAN261.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN261.rsml.1">]]>
<RefMeta>
<RefEntryTitle>ttdt_file_quit</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>ttdt_file_quit</Function></RefName>
<RefPurpose>unregister interest in ToolTalk events about a file
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: f_quit.sgm /main/5 1996/08/30 14:28:37 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/tttk.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>ttdt_file_quit</Function></FuncDef>
<ParamDef>Tt_pattern *<Parameter>patterns</Parameter></ParamDef>
<ParamDef>int <Parameter>quit</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>ttdt_file_quit</Function> function
is used to unregister interest in the
<Symbol Role="Variable">pathname</Symbol> that was passed to
&cdeman.ttdt.file.join; when
<Emphasis>patterns</Emphasis> was created.
The
<Function>ttdt_file_quit</Function> function destroys
<Emphasis>patterns</Emphasis> and sets the default file to
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
<Para>If
<Symbol Role="Variable">quit</Symbol> is True,
<Function>ttdt_file_quit</Function> calls
&cdeman.tt.file.quit; with a
<Symbol Role="Variable">pathname</Symbol> argument; otherwise, it returns without quitting.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>ttdt_file_quit</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_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_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_POINTER</Term>
<ListItem>
<Para>The
<Emphasis>patterns</Emphasis> argument was
<SystemItem Class="Constant">NULL</SystemItem> or otherwise invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>The specified process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.ttdt.file.join;, &cdeman.tt.default.file;, &cdeman.tt.file.quit;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
