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

<!-- $XConsortium: arg_add.sgm /main/6 1996/08/30 14:07: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.MAN184.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN184.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_pattern_arg_add</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_pattern_arg_add</Function></RefName>
<RefPurpose>add an argument to a pattern
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: arg_add.sgm /main/6 1996/08/30 14:07: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/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_pattern_arg_add</Function></FuncDef>
<ParamDef>Tt_pattern <Parameter>p</Parameter></ParamDef>
<ParamDef>Tt_mode <Parameter>n</Parameter></ParamDef>
<ParamDef>const char *<Parameter>vtype</Parameter></ParamDef>
<ParamDef>const char *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_pattern_arg_add</Function> function
adds an argument to a pattern.
The application must
add pattern arguments before it registers
the pattern with the ToolTalk service.
</Para>
<Para>The
<Emphasis>p</Emphasis> argument is the opaque handle for the pattern involved in this operation
The
<Symbol Role="Variable">n</Symbol> argument specifies who
(sender, handler, observers) writes and reads a message argument.
The following modes are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_IN</Term>
<ListItem>
<Para>The argument is written by the sender and read by the
handler and any observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_OUT</Term>
<ListItem>
<Para>The argument is written by the handler and read by the
sender and any reply observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_INOUT</Term>
<ListItem>
<Para>The argument is written by the sender and the
handler and read by all.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
<Emphasis>vtype</Emphasis> argument describes the type of argument data being added.
The type
<SystemItem Class="Constant">ALL</SystemItem> matches any argument value type.
The
<Symbol Role="Variable">value</Symbol> argument is the value to fill in.
This value must be an unsigned character string.
A
<SystemItem Class="Constant">NULL</SystemItem> matches any value.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_pattern_arg_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.register;, &cdeman.tt.pattern.barg.add;, &cdeman.tt.pattern.iarg.add;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->