vendor/voclient/libsamp/doc/html/sampMsg_8c.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>SAMP Client Library: sampMsg.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>sampMsg.c File Reference</h1>(Internal) Interface to Message objects.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;stdlib.h&gt;</code><br>
<code>#include &lt;stdio.h&gt;</code><br>
<code>#include &lt;unistd.h&gt;</code><br>
<code>#include &lt;string.h&gt;</code><br>
<code>#include &quot;<a class="el" href="samp_8h_source.html">samp.h</a>&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sampMsg_8c.html#d6dfdab2715ea070713515754dd499dd">samp_newMsg</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new Msg object.  <a href="#d6dfdab2715ea070713515754dd499dd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sampMsg_8c.html#adf2979a5fad0c9a855740330b7fd9ce">samp_freeMsg</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Free the given Msg object.  <a href="#adf2979a5fad0c9a855740330b7fd9ce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34c9e29fa57216f19a70764df8e5826b"></a><!-- doxytag: member="sampMsg.c::samp_msgMType" ref="34c9e29fa57216f19a70764df8e5826b" args="(Msg msg, String mtype)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>samp_msgMType</b> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b6887edd7c0924460bcee0282544c82f"></a><!-- doxytag: member="sampMsg.c::samp_msgTag" ref="b6887edd7c0924460bcee0282544c82f" args="()" -->
char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>samp_msgTag</b> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sampMsg_8c.html#281c8f7f8b21a74704dd200d5aaed481">samp_msgParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> param)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a parameter to the Msg.  <a href="#281c8f7f8b21a74704dd200d5aaed481"></a><br></td></tr>
</table>
<hr><h2>Detailed Description</h2>
(Internal) Interface to Message objects. 
<p>
SAMPMSG.C -- (Internal) Interface to Message objects.<p>
msg = samp_newMsg () samp_msgMType (Msg msg, String mtype) samp_msgParam (Msg msg, Param param) samp_msgTag () samp_freeMsg (Msg msg)<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl>
<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/11 </dd></dl>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="adf2979a5fad0c9a855740330b7fd9ce"></a><!-- doxytag: member="sampMsg.c::samp_freeMsg" ref="adf2979a5fad0c9a855740330b7fd9ce" args="(Msg msg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void samp_freeMsg           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a>&nbsp;</td>
          <td class="paramname"> <em>msg</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Free the given Msg object. 
<p>
SAMP_FREEMSG -- Free the given Msg object<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>Msg object to free </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>

<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p>

</div>
</div><p>
<a class="anchor" name="281c8f7f8b21a74704dd200d5aaed481"></a><!-- doxytag: member="sampMsg.c::samp_msgParam" ref="281c8f7f8b21a74704dd200d5aaed481" args="(Msg msg, Param param)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void samp_msgParam           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a>&nbsp;</td>
          <td class="paramname"> <em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a>&nbsp;</td>
          <td class="paramname"> <em>param</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a parameter to the Msg. 
<p>
SAMP_MSGPARAM -- Add a parameter to the Msg.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>handle to Msg object </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>keyw</em>&nbsp;</td><td>map keyword </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>param</em>&nbsp;</td><td>parameter map </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl>

<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p>

</div>
</div><p>
<a class="anchor" name="d6dfdab2715ea070713515754dd499dd"></a><!-- doxytag: member="sampMsg.c::samp_newMsg" ref="d6dfdab2715ea070713515754dd499dd" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> samp_newMsg           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a new Msg object. 
<p>
SAMP_NEWMSG -- Create a new Msg object<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to new Msg </dd></dl>

<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p>

</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>