CDE/cde/doc/C/guides/man/m3_tt_pattern/stat_add.sgm

<!-- $XConsortium: stat_add.sgm /main/5 1996/08/30 14:20:46 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.MAN208.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN208.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_pattern_state_add</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_pattern_state_add</Function></RefName>
<RefPurpose>add a value to the state field for a pattern
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: stat_add.sgm /main/5 1996/08/30 14:20:46 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_pattern_state_add</Function></FuncDef>
<ParamDef>Tt_pattern <Parameter>p</Parameter></ParamDef>
<ParamDef>Tt_state <Parameter>s</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_pattern_state_add</Function> function
adds a value to the state field for the specified pattern.
</Para>
<Para>The
<Emphasis>p</Emphasis> argument is a unique handle for a message pattern.
This handle is returned after
&cdeman.tt.pattern.create; is called.
The
<Symbol Role="Variable">s</Symbol> argument indicates the current delivery state of a message.
The following values are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_CREATED</Term>
<ListItem>
<Para>The message has been created, but not yet sent.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_SENT</Term>
<ListItem>
<Para>The message has been sent, but not yet handled.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_HANDLED</Term>
<ListItem>
<Para>The message has been handled; return values are valid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_FAILED</Term>
<ListItem>
<Para>The message could not be delivered to a handler.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_QUEUED</Term>
<ListItem>
<Para>The message has been queued for delivery.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_STARTED</Term>
<ListItem>
<Para>The ToolTalk service is attempting to start a process to handle the message.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_REJECTED</Term>
<ListItem>
<Para>The message has been rejected by a possible handler.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_pattern_state_add</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>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.pattern.create;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->