cde/doc/C/guides/man/m3_tt_message/send.sgm

   1 <!-- $XConsortium: send.sgm /main/5 1996/08/30 13:43:28 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.MAN144.rsml.1">]]>
  11 <![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN144.rsml.1">]]>
  12 <RefMeta>
  13 <RefEntryTitle>tt_message_send</RefEntryTitle>
  14 <ManVolNum>library call</ManVolNum>
  15 </RefMeta>
  16 <RefNameDiv>
  17 <RefName><Function>tt_message_send</Function></RefName>
  18 <RefPurpose>send a message
  19 </RefPurpose>
  20 </RefNameDiv>
  21 <!-- $XConsortium: send.sgm /main/5 1996/08/30 13:43:28 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_message_send</Function></FuncDef>
  32 <ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
  33 </FuncSynopsis>
  34 </RefSynopsisDiv>
  35 <RefSect1>
  36 <Title>DESCRIPTION</Title>
  37 <Para>The
  38 <Function>tt_message_send</Function> function
  39 sends the specified message.
  40 </Para>
  41 <Para>The
  42 <Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
  43 </Para>
  44 </RefSect1>
  45 <RefSect1>
  46 <Title>RETURN VALUE</Title>
  47 <Para>Upon successful completion, the
  48 <Function>tt_message_send</Function> function returns the status of the operation as one of the following
  49 <StructName Role="typedef">Tt_status</StructName> values:
  50 </Para>
  51 <VariableList>
  52 <VarListEntry>
  53 <Term>TT_OK</Term>
  54 <ListItem>
  55 <Para>The operation completed successfully.
  56 </Para>
  57 </ListItem>
  58 </VarListEntry>
  59 <VarListEntry>
  60 <Term>TT_ERR_ADDRESS</Term>
  61 <ListItem>
  62 <Para>The specified
  63 <StructName Role="typedef">Tt_address</StructName> is invalid.
  64 </Para>
  65 </ListItem>
  66 </VarListEntry>
  67 <VarListEntry>
  68 <Term>TT_ERR_CLASS</Term>
  69 <ListItem>
  70 <Para>The specified
  71 <StructName Role="typedef">Tt_class</StructName> is invalid.
  72 </Para>
  73 </ListItem>
  74 </VarListEntry>
  75 <VarListEntry>
  76 <Term>TT_ERR_FILE</Term>
  77 <ListItem>
  78 <Para>The specified file does not exist or it is inaccessible.
  79 </Para>
  80 </ListItem>
  81 </VarListEntry>
  82 <VarListEntry>
  83 <Term>TT_ERR_NOMP</Term>
  84 <ListItem>
  85 <Para>The
  86 &cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
  87 </Para>
  88 </ListItem>
  89 </VarListEntry>
  90 <VarListEntry>
  91 <Term>TT_ERR_OBJID</Term>
  92 <ListItem>
  93 <Para>The
  94 objid
  95 passed to the ToolTalk service does not reference an existing object spec.
  96 </Para>
  97 </ListItem>
  98 </VarListEntry>
  99 <VarListEntry>
 100 <Term>TT_ERR_OTYPE</Term>
 101 <ListItem>
 102 <Para>The specified object type is not the name of an installed object type.
 103 </Para>
 104 </ListItem>
 105 </VarListEntry>
 106 <VarListEntry>
 107 <Term>TT_ERR_OVERFLOW</Term>
 108 <ListItem>
 109 <Para>The ToolTalk service has more active messages than it can handle.
 110 (The maximum number of active messages is implementation specific,
 111 but is at least 2000.)
 112 </Para>
 113 </ListItem>
 114 </VarListEntry>
 115 <VarListEntry>
 116 <Term>TT_ERR_POINTER</Term>
 117 <ListItem>
 118 <Para>The pointer passed does not point to an object of
 119 the correct type for this operation.
 120 </Para>
 121 </ListItem>
 122 </VarListEntry>
 123 <VarListEntry>
 124 <Term>TT_ERR_PROCID</Term>
 125 <ListItem>
 126 <Para>The specified process identifier is out of date or invalid.
 127 </Para>
 128 </ListItem>
 129 </VarListEntry>
 130 <VarListEntry>
 131 <Term>TT_ERR_SESSION</Term>
 132 <ListItem>
 133 <Para>The specified ToolTalk session is out of date or invalid.
 134 </Para>
 135 </ListItem>
 136 </VarListEntry>
 137 <VarListEntry>
 138 <Term>TT_WRN_STALE_OBJID</Term>
 139 <ListItem>
 140 <Para>The object attribute in the message has been replaced with a newer one.
 141 </Para>
 142 </ListItem>
 143 </VarListEntry>
 144 </VariableList>
 145 </RefSect1>
 146 <RefSect1>
 147 <Title>SEE ALSO</Title>
 148 <Para>&cdeman.Tt.tt.c.h;.</Para>
 149 </RefSect1>
 150 </RefEntry>
 151 <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->