76 lines
2.9 KiB
Plaintext
76 lines
2.9 KiB
Plaintext
<!-- $XConsortium: close.sgm /main/5 1996/08/30 14:26:29 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.MAN257.rsml.1">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN257.rsml.1">]]>
|
|
<RefMeta>
|
|
<RefEntryTitle>ttdt_close</RefEntryTitle>
|
|
<ManVolNum>library call</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Function>ttdt_close</Function></RefName>
|
|
<RefPurpose>destroy a ToolTalk communication endpoint
|
|
</RefPurpose>
|
|
</RefNameDiv>
|
|
<!-- $XConsortium: close.sgm /main/5 1996/08/30 14:26:29 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 <Tt/tttk.h>
|
|
</FuncSynopsisInfo>
|
|
<FuncDef>Tt_status <Function>ttdt_close</Function></FuncDef>
|
|
<ParamDef>const char *<Parameter>procid</Parameter></ParamDef>
|
|
<ParamDef>const char *<Parameter>new_procid</Parameter></ParamDef>
|
|
<ParamDef>int <Parameter>sendStopped</Parameter></ParamDef>
|
|
</FuncSynopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Function>ttdt_close</Function> function destroys a ToolTalk communication endpoint.
|
|
</Para>
|
|
<Para>If
|
|
<Emphasis>sendStopped</Emphasis> is True, the
|
|
<Function>ttdt_close</Function> function sends a
|
|
<Symbol Role="Message">Stopped</Symbol> notice; otherwise, it sends no notice.
|
|
If
|
|
<Emphasis>procid</Emphasis> is not
|
|
<SystemItem Class="Constant">NULL</SystemItem>, <Function>ttdt_close</Function> calls
|
|
<Function>tt_default_procid_set</Function> with a
|
|
<Emphasis>procid</Emphasis> argument and then calls
|
|
<Function>tt_close</Function>; otherwise, it closes the current default
|
|
procid.
|
|
If
|
|
<Emphasis>new_procid</Emphasis> is not
|
|
<SystemItem Class="Constant">NULL</SystemItem>, <Function>ttdt_close</Function> calls
|
|
<Function>tt_default_procid_set</Function> with a
|
|
<Emphasis>new_procid</Emphasis> argument.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>RETURN VALUE</Title>
|
|
<Para>The
|
|
<Function>ttdt_close</Function> function may return any of the errors returned by
|
|
&cdeman.tt.default.procid.set; and
|
|
&cdeman.tt.close;.</Para>
|
|
<Para>No errors are propagated if sending the
|
|
<Symbol Role="Message">Stopped</Symbol> notice fails.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>&cdeman.Tt.tttk.h;, &cdeman.ttdt.open;, &cdeman.tt.default.procid.set;, &cdeman.tt.close;.</Para>
|
|
</RefSect1>
|
|
</RefEntry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|