<!-- $XConsortium: m_destro.sgm /main/5 1996/08/30 14:03:28 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.MAN277.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN277.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tttk_message_destroy</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tttk_message_destroy</Function></RefName>
<RefPurpose>destroy a message conforming to the &str-XZ; conventions
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: m_destro.sgm /main/5 1996/08/30 14:03:28 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>tttk_message_destroy</Function></FuncDef>
<ParamDef>Tt_message <Parameter>msg</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tttk_message_destroy</Function> function
can be used in place of
&cdeman.tt.message.destroy;. It destroys any patterns that may have been stored on
<Emphasis>msg</Emphasis> by
&cdeman.ttdt.message.accept; or
&cdeman.ttdt.subcontract.manage;. Then it passes
<Emphasis>msg</Emphasis> to
&cdeman.tt.message.destroy;.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tttk_message_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_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 pointer passed does not point to an object of
the correct type for this operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_WRN_STOPPED</Term>
<ListItem>
<Para>The message is not actually destroyed.
(A message is not destroyed if it is in a non-final state;
for example, a request for which the reply has not been received.)
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.tt.message.create;, &cdeman.tt.message.destroy;, &cdeman.ttdt.file.notice;, &cdeman.ttdt.file.request;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
