cont_add.sgm 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. <!-- $XConsortium: cont_add.sgm /main/5 1996/08/30 14:11:37 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.MAN191.rsml.1">]]>
  10. <![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN191.rsml.1">]]>
  11. <RefMeta>
  12. <RefEntryTitle>tt_pattern_context_add</RefEntryTitle>
  13. <ManVolNum>library call</ManVolNum>
  14. </RefMeta>
  15. <RefNameDiv>
  16. <RefName><Function>tt_pattern_context_add</Function></RefName>
  17. <RefPurpose>add a string value to the values of this pattern's context
  18. </RefPurpose>
  19. </RefNameDiv>
  20. <!-- $XConsortium: cont_add.sgm /main/5 1996/08/30 14:11:37 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_context_add</Function></FuncDef>
  31. <ParamDef>Tt_pattern <Parameter>p</Parameter></ParamDef>
  32. <ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
  33. <ParamDef>const char *<Parameter>value</Parameter></ParamDef>
  34. </FuncSynopsis>
  35. </RefSynopsisDiv>
  36. <RefSect1>
  37. <Title>DESCRIPTION</Title>
  38. <Para>The
  39. <Function>tt_pattern_context_add</Function> function
  40. adds a string value to the values of this pattern's context.
  41. </Para>
  42. <Para>If the value pointer is
  43. <SystemItem Class="Constant">NULL</SystemItem>, a slot is created with the specified name but
  44. no value is added.
  45. </Para>
  46. <Para>The
  47. <Emphasis>p</Emphasis> argument is the opaque handle for the pattern involved in this operation.
  48. The
  49. <Emphasis>slotname</Emphasis> argument describes the context of this pattern.
  50. The
  51. <Symbol Role="Variable">value</Symbol> argument is the value to be added.
  52. </Para>
  53. </RefSect1>
  54. <RefSect1>
  55. <Title>RETURN VALUE</Title>
  56. <Para>Upon successful completion, the
  57. <Function>tt_pattern_context_add</Function> function returns the status of the operation as one of the following
  58. <StructName Role="typedef">Tt_status</StructName> values:
  59. </Para>
  60. <VariableList>
  61. <VarListEntry>
  62. <Term>TT_OK</Term>
  63. <ListItem>
  64. <Para>The operation completed successfully.
  65. </Para>
  66. </ListItem>
  67. </VarListEntry>
  68. <VarListEntry>
  69. <Term>TT_ERR_UNIMP</Term>
  70. <ListItem>
  71. <Para>The ToolTalk function called is not implemented.
  72. </Para>
  73. </ListItem>
  74. </VarListEntry>
  75. <VarListEntry>
  76. <Term>TT_ERR_NOMP</Term>
  77. <ListItem>
  78. <Para>The
  79. &cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
  80. </Para>
  81. </ListItem>
  82. </VarListEntry>
  83. <VarListEntry>
  84. <Term>TT_ERR_POINTER</Term>
  85. <ListItem>
  86. <Para>The pointer passed does not point to an object of
  87. the correct type for this operation.
  88. </Para>
  89. </ListItem>
  90. </VarListEntry>
  91. <VarListEntry>
  92. <Term>TT_ERR_SLOTNAME</Term>
  93. <ListItem>
  94. <Para>The specified slotname is syntactically invalid.
  95. </Para>
  96. </ListItem>
  97. </VarListEntry>
  98. </VariableList>
  99. </RefSect1>
  100. <RefSect1>
  101. <Title>SEE ALSO</Title>
  102. <Para>&cdeman.Tt.tt.c.h;.</Para>
  103. </RefSect1>
  104. </RefEntry>
  105. <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->