cde/doc/C/guides/man/m3_tt_pattern/op_add.sgm

   1 <!-- $XConsortium: op_add.sgm /main/5 1996/08/30 14:16:13 rws $ -->
   2 <!-- (c) Copyright 1995 Digital Equipment Corporation. -->
   3 <!-- (c) Copyright 1995 Hewlett-Packard Company. -->
   4 <!-- (c) Copyright 1995 International Business Machines Corp. -->
   5 <!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
   6 <!-- (c) Copyright 1995 Novell, Inc. -->
   7 <!-- (c) Copyright 1995 FUJITSU LIMITED. -->
   8 <!-- (c) Copyright 1995 Hitachi. -->
   9
  10 <![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN199.rsml.1">]]>
  11 <![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN199.rsml.1">]]>
  12 <RefMeta>
  13 <RefEntryTitle>tt_pattern_op_add</RefEntryTitle>
  14 <ManVolNum>library call</ManVolNum>
  15 </RefMeta>
  16 <RefNameDiv>
  17 <RefName><Function>tt_pattern_op_add</Function></RefName>
  18 <RefPurpose>add a value to the operation field of a pattern
  19 </RefPurpose>
  20 </RefNameDiv>
  21 <!-- $XConsortium: op_add.sgm /main/5 1996/08/30 14:16:13 rws $-->
  22 <!-- CDE Common Source Format, Version 1.0.0-->
  23 <!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
  24 <!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
  25 <!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
  26 <!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
  27 <RefSynopsisDiv>
  28 <FuncSynopsis Remap="ANSI">
  29 <FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
  30 </FuncSynopsisInfo>
  31 <FuncDef>Tt_status <Function>tt_pattern_op_add</Function></FuncDef>
  32 <ParamDef>Tt_pattern <Parameter>p</Parameter></ParamDef>
  33 <ParamDef>const char *<Parameter>opname</Parameter></ParamDef>
  34 </FuncSynopsis>
  35 </RefSynopsisDiv>
  36 <RefSect1>
  37 <Title>DESCRIPTION</Title>
  38 <Para>The
  39 <Function>tt_pattern_op_add</Function> function
  40 adds a value to the operation field of the specified pattern.
  41 </Para>
  42 <Para>The
  43 <Emphasis>p</Emphasis> argument is a unique handle for a message pattern.
  44 This handle is returned after
  45 &cdeman.tt.pattern.create; is called.
  46 The
  47 <Emphasis>opname</Emphasis> argument is the name of the operation the process can perform.
  48 </Para>
  49 </RefSect1>
  50 <RefSect1>
  51 <Title>RETURN VALUE</Title>
  52 <Para>Upon successful completion, the
  53 <Function>tt_pattern_op_add</Function> function returns the status of the operation as one of the following
  54 <StructName Role="typedef">Tt_status</StructName> values:
  55 </Para>
  56 <VariableList>
  57 <VarListEntry>
  58 <Term>TT_OK</Term>
  59 <ListItem>
  60 <Para>The operation completed successfully.
  61 </Para>
  62 </ListItem>
  63 </VarListEntry>
  64 <VarListEntry>
  65 <Term>TT_ERR_NOMP</Term>
  66 <ListItem>
  67 <Para>The
  68 &cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
  69 </Para>
  70 </ListItem>
  71 </VarListEntry>
  72 <VarListEntry>
  73 <Term>TT_ERR_POINTER</Term>
  74 <ListItem>
  75 <Para>The pointer passed does not point to an object of
  76 the correct type for this operation.
  77 </Para>
  78 </ListItem>
  79 </VarListEntry>
  80 </VariableList>
  81 </RefSect1>
  82 <RefSect1>
  83 <Title>SEE ALSO</Title>
  84 <Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.pattern.create;.</Para>
  85 </RefSect1>
  86 </RefEntry>
  87 <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->