icon_add.sgm 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. <!-- $XConsortium: icon_add.sgm /main/5 1996/08/30 14:15:01 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. <![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN197.rsml.1">]]>
  10. <![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN197.rsml.1">]]>
  11. <RefMeta>
  12. <RefEntryTitle>tt_pattern_icontext_add</RefEntryTitle>
  13. <ManVolNum>library call</ManVolNum>
  14. </RefMeta>
  15. <RefNameDiv>
  16. <RefName><Function>tt_pattern_icontext_add</Function></RefName>
  17. <RefPurpose>add an integer value to the values of this pattern's context
  18. </RefPurpose>
  19. </RefNameDiv>
  20. <!-- $XConsortium: icon_add.sgm /main/5 1996/08/30 14:15:01 rws $-->
  21. <!-- CDE Common Source Format, Version 1.0.0-->
  22. <!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
  23. <!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
  24. <!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
  25. <!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
  26. <RefSynopsisDiv>
  27. <FuncSynopsis Remap="ANSI">
  28. <FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
  29. </FuncSynopsisInfo>
  30. <FuncDef>Tt_status <Function>tt_pattern_icontext_add</Function></FuncDef>
  31. <ParamDef>Tt_pattern <Parameter>p</Parameter></ParamDef>
  32. <ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
  33. <ParamDef>int <Parameter>value</Parameter></ParamDef>
  34. </FuncSynopsis>
  35. </RefSynopsisDiv>
  36. <RefSect1>
  37. <Title>DESCRIPTION</Title>
  38. <Para>The
  39. <Function>tt_pattern_icontext_add</Function> function
  40. adds an integer value to the values of this pattern's context.
  41. </Para>
  42. <Para>The
  43. <Emphasis>p</Emphasis> argument is the opaque handle for the pattern involved in this operation.
  44. The
  45. <Emphasis>slotname</Emphasis> argument describes the slotname in this pattern.
  46. The
  47. <Symbol Role="Variable">value</Symbol> argument is the value to be added.
  48. </Para>
  49. </RefSect1>
  50. <RefSect1>
  51. <Title>RETURN VALUE</Title>
  52. <Para>Tt_status
  53. Upon successful completion, the
  54. <Function>tt_pattern_icontext_add</Function> function returns the status of the operation as one of the following
  55. <StructName Role="typedef">Tt_status</StructName> values:
  56. </Para>
  57. <VariableList>
  58. <VarListEntry>
  59. <Term>TT_OK</Term>
  60. <ListItem>
  61. <Para>The operation completed successfully.
  62. </Para>
  63. </ListItem>
  64. </VarListEntry>
  65. <VarListEntry>
  66. <Term>TT_ERR_UNIMP</Term>
  67. <ListItem>
  68. <Para>The ToolTalk function called is not implemented.
  69. </Para>
  70. </ListItem>
  71. </VarListEntry>
  72. <VarListEntry>
  73. <Term>TT_ERR_NOMP</Term>
  74. <ListItem>
  75. <Para>The
  76. &cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
  77. </Para>
  78. </ListItem>
  79. </VarListEntry>
  80. <VarListEntry>
  81. <Term>TT_ERR_POINTER</Term>
  82. <ListItem>
  83. <Para>The pointer passed does not point to an object of
  84. the correct type for this operation.
  85. </Para>
  86. </ListItem>
  87. </VarListEntry>
  88. <VarListEntry>
  89. <Term>TT_ERR_SLOTNAME</Term>
  90. <ListItem>
  91. <Para>The specified slotname is syntactically invalid.
  92. </Para>
  93. </ListItem>
  94. </VarListEntry>
  95. </VariableList>
  96. </RefSect1>
  97. <RefSect1>
  98. <Title>SEE ALSO</Title>
  99. <Para>&cdeman.Tt.tt.c.h;.</Para>
  100. </RefSect1>
  101. </RefEntry>
  102. <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->