<!-- $XConsortium: disposit.sgm /main/5 1996/08/30 13:37:53 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.MAN117.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN117.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_disposition</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_disposition</Function></RefName>
<RefPurpose>retrieve the disposition attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: disposit.sgm /main/5 1996/08/30 13:37:53 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_disposition <Function>tt_message_disposition</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_disposition</Function> function
retrieves the disposition attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_disposition</Function> function returns a value that indicates whether an instance of the
receiving process should be started to receive the message immediately,
or whether the message is to be queued until the receiving process is
started at a later time.
The
<Function>tt_message_disposition</Function> function returns one of the following
<StructName Role="typedef">Tt_disposition</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DISCARD</Term>
<ListItem>
<Para>There is no receiver for this message.
The message will be returned to the sender with the
<StructName Role="typedef">Tt_status</StructName> field containing
<SystemItem Class="Constant">TT_FAILED</SystemItem>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_QUEUE</Term>
<ListItem>
<Para>Queue the message until a process of the proper
ptype
receives the message.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_START</Term>
<ListItem>
<Para>Attempt to start a process of the proper
ptype
if none is running.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_QUEUE+TT_START</Term>
<ListItem>
<Para>Queue the message and attempt to start a process of the proper
ptype
if none is running.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the
<StructName Role="typedef">Tt_disposition</StructName> integer:
</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>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
