|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
2 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
3 <head> |
|
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
5 <title>TB9.2 Example Applications: examples/PIPS/opencmessagequeuelibraryex/engine/inc/msgqlib.h File Reference</title> |
|
6 <link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
7 <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
8 </head> |
|
9 <body> |
|
10 <!-- Generated by Doxygen 1.6.2 --> |
|
11 <div class="contents"> |
|
12 <h1>examples/PIPS/opencmessagequeuelibraryex/engine/inc/msgqlib.h File Reference</h1> |
|
13 <p><a href="msgqlib_8h_source.html">Go to the source code of this file.</a></p> |
|
14 <table border="0" cellpadding="0" cellspacing="0"> |
|
15 <tr><td colspan="2"><h2>Defines</h2></td></tr> |
|
16 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51d90ea93d4b55e086cb490f7478e684"></a><!-- doxytag: member="msgqlib.h::MAX_MSG_LEN" ref="a51d90ea93d4b55e086cb490f7478e684" args="" --> |
|
17 #define </td><td class="memItemRight" valign="bottom"><b>MAX_MSG_LEN</b> 2048</td></tr> |
|
18 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac3b870d7fae5f0d40c33124523b9e95c"></a><!-- doxytag: member="msgqlib.h::MSGQ_TBL_SZ" ref="ac3b870d7fae5f0d40c33124523b9e95c" args="" --> |
|
19 #define </td><td class="memItemRight" valign="bottom"><b>MSGQ_TBL_SZ</b> 101</td></tr> |
|
20 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1db87020c9dbe6a919b24901d284249c"></a><!-- doxytag: member="msgqlib.h::MSG_Q_READY" ref="a1db87020c9dbe6a919b24901d284249c" args="" --> |
|
21 #define </td><td class="memItemRight" valign="bottom"><b>MSG_Q_READY</b> 0</td></tr> |
|
22 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a907a8ef515d861288914c75ef7292451"></a><!-- doxytag: member="msgqlib.h::MSG_Q_CLEANING" ref="a907a8ef515d861288914c75ef7292451" args="" --> |
|
23 #define </td><td class="memItemRight" valign="bottom"><b>MSG_Q_CLEANING</b> 1</td></tr> |
|
24 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3507cbe64443191d510ae7e093d37036"></a><!-- doxytag: member="msgqlib.h::NO_WAIT" ref="a3507cbe64443191d510ae7e093d37036" args="" --> |
|
25 #define </td><td class="memItemRight" valign="bottom"><b>NO_WAIT</b> 0</td></tr> |
|
26 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac89d2c332821be06166c210249b671e7"></a><!-- doxytag: member="msgqlib.h::WAIT_FOREVER" ref="ac89d2c332821be06166c210249b671e7" args="" --> |
|
27 #define </td><td class="memItemRight" valign="bottom"><b>WAIT_FOREVER</b> 0xFFFF</td></tr> |
|
28 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac75179b84d855ba43aa4eb8f276f9220"></a><!-- doxytag: member="msgqlib.h::KMsgQLibErr" ref="ac75179b84d855ba43aa4eb8f276f9220" args="" --> |
|
29 #define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibErr</b> 0x100</td></tr> |
|
30 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acdb35527989a60cd392b232797d7b020"></a><!-- doxytag: member="msgqlib.h::KMsgQLibNoMemoryErr" ref="acdb35527989a60cd392b232797d7b020" args="" --> |
|
31 #define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibNoMemoryErr</b> (KMsgQLibErr | 1)</td></tr> |
|
32 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20fbdf79a5c79226aee7f10892eebb70"></a><!-- doxytag: member="msgqlib.h::KMsgQLibQIdErr" ref="a20fbdf79a5c79226aee7f10892eebb70" args="" --> |
|
33 #define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibQIdErr</b> (KMsgQLibErr | 2)</td></tr> |
|
34 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0d88606bdb681324866d980da344e96"></a><!-- doxytag: member="msgqlib.h::KMsgQLibParamErr" ref="ab0d88606bdb681324866d980da344e96" args="" --> |
|
35 #define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibParamErr</b> (KMsgQLibErr | 3)</td></tr> |
|
36 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9722dcaa37f6bf1ec0384ae7e7425f5d"></a><!-- doxytag: member="msgqlib.h::KMsgQLibQFlushErr" ref="a9722dcaa37f6bf1ec0384ae7e7425f5d" args="" --> |
|
37 #define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibQFlushErr</b> (KMsgQLibErr | 4)</td></tr> |
|
38 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f86ac9f04d8759c799c16e6c91b60f1"></a><!-- doxytag: member="msgqlib.h::KMsgQLibQShortErr" ref="a2f86ac9f04d8759c799c16e6c91b60f1" args="" --> |
|
39 #define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibQShortErr</b> (KMsgQLibErr | 5)</td></tr> |
|
40 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0e86afdef9251809bfff8f7e82e062d"></a><!-- doxytag: member="msgqlib.h::MSG_Q_FIFO" ref="ab0e86afdef9251809bfff8f7e82e062d" args="" --> |
|
41 #define </td><td class="memItemRight" valign="bottom"><b>MSG_Q_FIFO</b> 1</td></tr> |
|
42 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a826ed7a139e7afecffd01d5b454779ce"></a><!-- doxytag: member="msgqlib.h::MSG_Q_PRIORITY" ref="a826ed7a139e7afecffd01d5b454779ce" args="" --> |
|
43 #define </td><td class="memItemRight" valign="bottom"><b>MSG_Q_PRIORITY</b> 2</td></tr> |
|
44 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26c24177b7689d9c0dd3104926169dff"></a><!-- doxytag: member="msgqlib.h::MSG_PRI_NORMAL" ref="a26c24177b7689d9c0dd3104926169dff" args="" --> |
|
45 #define </td><td class="memItemRight" valign="bottom"><b>MSG_PRI_NORMAL</b> 3</td></tr> |
|
46 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a387c2708adea6b9641abc2226f196a2d"></a><!-- doxytag: member="msgqlib.h::MSG_PRI_URGENT" ref="a387c2708adea6b9641abc2226f196a2d" args="" --> |
|
47 #define </td><td class="memItemRight" valign="bottom"><b>MSG_PRI_URGENT</b> 4</td></tr> |
|
48 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb5136c141cca4780f6fbb942f06b1ba"></a><!-- doxytag: member="msgqlib.h::SEM_Q_FIFO" ref="adb5136c141cca4780f6fbb942f06b1ba" args="" --> |
|
49 #define </td><td class="memItemRight" valign="bottom"><b>SEM_Q_FIFO</b> 5</td></tr> |
|
50 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afadcd4ace04ef2c9806ed2dd763f8ec2"></a><!-- doxytag: member="msgqlib.h::SEM_Q_PRIORITY" ref="afadcd4ace04ef2c9806ed2dd763f8ec2" args="" --> |
|
51 #define </td><td class="memItemRight" valign="bottom"><b>SEM_Q_PRIORITY</b> 6</td></tr> |
|
52 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba51915c87d64af47fb1cc59348961c9"></a><!-- doxytag: member="msgqlib.h::OK" ref="aba51915c87d64af47fb1cc59348961c9" args="" --> |
|
53 #define </td><td class="memItemRight" valign="bottom"><b>OK</b> 0</td></tr> |
|
54 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fe83ac76edc595f6b98cd4a4127aed5"></a><!-- doxytag: member="msgqlib.h::ERROR" ref="a8fe83ac76edc595f6b98cd4a4127aed5" args="" --> |
|
55 #define </td><td class="memItemRight" valign="bottom"><b>ERROR</b> -1</td></tr> |
|
56 <tr><td colspan="2"><h2>Typedefs</h2></td></tr> |
|
57 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af632da489ebc3708ec3ab6791ee53fa4"></a><!-- doxytag: member="msgqlib.h::ULONG" ref="af632da489ebc3708ec3ab6791ee53fa4" args="" --> |
|
58 typedef unsigned long </td><td class="memItemRight" valign="bottom"><b>ULONG</b></td></tr> |
|
59 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad32f74eab70f4b87dac7fa0c0508ce29"></a><!-- doxytag: member="msgqlib.h::ushort_t" ref="ad32f74eab70f4b87dac7fa0c0508ce29" args="" --> |
|
60 typedef unsigned short </td><td class="memItemRight" valign="bottom"><b>ushort_t</b></td></tr> |
|
61 <tr><td colspan="2"><h2>Functions</h2></td></tr> |
|
62 <tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="msgqlib_8h.html#acc58bf2bd8d3b904069d8d604ccea5b1">MsgQCreate</a> (ULONG qName, ULONG maxMsgs, ULONG qOptions, int *err)</td></tr> |
|
63 <tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="msgqlib_8h.html#ae9435d91016cacef90a4d92db16a6fe1">MsgQDelete</a> (ULONG qName, int *err)</td></tr> |
|
64 <tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="msgqlib_8h.html#a5272782967b922604e4f47e8bc67a468">MsgQSend</a> (ULONG qName, char *msg, ULONG nBytes, ULONG priority, int timeout, int *err)</td></tr> |
|
65 <tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="msgqlib_8h.html#a92645de66865355158589ff1dd7bc28d">MsgQReceive</a> (ULONG qName, char *msg, ULONG maxNBytes, int timeout, int *err)</td></tr> |
|
66 <tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="msgqlib_8h.html#a6539cca974e31b9571caae1a93576b21">MsgQCheck</a> (ULONG qName, int *err)</td></tr> |
|
67 <tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="msgqlib_8h.html#ac3714b7e3c9e3eafb7375ca1fe5d5ad7">MsgQMaxCheck</a> (ULONG qName, int *err)</td></tr> |
|
68 <tr><td class="memItemLeft" align="right" valign="top">IMPORT_C int </td><td class="memItemRight" valign="bottom"><a class="el" href="msgqlib_8h.html#af100b3206a8771a0b599a1ba5a4c8cb8">MsgQClean</a> (ULONG qName, int *err)</td></tr> |
|
69 </table> |
|
70 <hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
71 <p>Description: Header file for MsgQLib Copyright (c) 2007 Nokia Corporation. This material, including documentation and any related computer programs, is protected by copyright controlled by Nokia Corporation. </p> |
|
72 |
|
73 <p>Definition in file <a class="el" href="msgqlib_8h_source.html">msgqlib.h</a>.</p> |
|
74 <hr/><h2>Function Documentation</h2> |
|
75 <a class="anchor" id="acc58bf2bd8d3b904069d8d604ccea5b1"></a><!-- doxytag: member="msgqlib.h::MsgQCreate" ref="acc58bf2bd8d3b904069d8d604ccea5b1" args="(ULONG qName, ULONG maxMsgs, ULONG qOptions, int *err)" --> |
|
76 <div class="memitem"> |
|
77 <div class="memproto"> |
|
78 <table class="memname"> |
|
79 <tr> |
|
80 <td class="memname">IMPORT_C int MsgQCreate </td> |
|
81 <td>(</td> |
|
82 <td class="paramtype">ULONG </td> |
|
83 <td class="paramname"> <em>qName</em>, </td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td class="paramkey"></td> |
|
87 <td></td> |
|
88 <td class="paramtype">ULONG </td> |
|
89 <td class="paramname"> <em>maxMsgs</em>, </td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td class="paramkey"></td> |
|
93 <td></td> |
|
94 <td class="paramtype">ULONG </td> |
|
95 <td class="paramname"> <em>qOptions</em>, </td> |
|
96 </tr> |
|
97 <tr> |
|
98 <td class="paramkey"></td> |
|
99 <td></td> |
|
100 <td class="paramtype">int * </td> |
|
101 <td class="paramname"> <em>err</em></td><td> </td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td></td> |
|
105 <td>)</td> |
|
106 <td></td><td></td><td></td> |
|
107 </tr> |
|
108 </table> |
|
109 </div> |
|
110 <div class="memdoc"> |
|
111 <p>Creates a message queue with the argument passed</p> |
|
112 <dl><dt><b>Parameters:</b></dt><dd> |
|
113 <table border="0" cellspacing="2" cellpadding="0"> |
|
114 <tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr> |
|
115 <tr><td valign="top"></td><td valign="top"><em>maxMsgs</em> </td><td>- max messages in the queue </td></tr> |
|
116 <tr><td valign="top"></td><td valign="top"><em>qOptions</em> </td><td>- message queue options MSG_Q_FIFO MSG_Q_PRIORITY </td></tr> |
|
117 <tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr> |
|
118 </table> |
|
119 </dd> |
|
120 </dl> |
|
121 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl> |
|
122 |
|
123 <p>Definition at line <a class="el" href="msgqcreate_8c_source.html#l00023">23</a> of file <a class="el" href="msgqcreate_8c_source.html">msgqcreate.c</a>.</p> |
|
124 |
|
125 </div> |
|
126 </div> |
|
127 <a class="anchor" id="ae9435d91016cacef90a4d92db16a6fe1"></a><!-- doxytag: member="msgqlib.h::MsgQDelete" ref="ae9435d91016cacef90a4d92db16a6fe1" args="(ULONG qName, int *err)" --> |
|
128 <div class="memitem"> |
|
129 <div class="memproto"> |
|
130 <table class="memname"> |
|
131 <tr> |
|
132 <td class="memname">IMPORT_C int MsgQDelete </td> |
|
133 <td>(</td> |
|
134 <td class="paramtype">ULONG </td> |
|
135 <td class="paramname"> <em>qName</em>, </td> |
|
136 </tr> |
|
137 <tr> |
|
138 <td class="paramkey"></td> |
|
139 <td></td> |
|
140 <td class="paramtype">int * </td> |
|
141 <td class="paramname"> <em>err</em></td><td> </td> |
|
142 </tr> |
|
143 <tr> |
|
144 <td></td> |
|
145 <td>)</td> |
|
146 <td></td><td></td><td></td> |
|
147 </tr> |
|
148 </table> |
|
149 </div> |
|
150 <div class="memdoc"> |
|
151 <p>This function deletes a message queue</p> |
|
152 <dl><dt><b>Parameters:</b></dt><dd> |
|
153 <table border="0" cellspacing="2" cellpadding="0"> |
|
154 <tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr> |
|
155 <tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr> |
|
156 </table> |
|
157 </dd> |
|
158 </dl> |
|
159 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl> |
|
160 |
|
161 <p>Definition at line <a class="el" href="msgqdelete_8c_source.html#l00021">21</a> of file <a class="el" href="msgqdelete_8c_source.html">msgqdelete.c</a>.</p> |
|
162 |
|
163 </div> |
|
164 </div> |
|
165 <a class="anchor" id="a5272782967b922604e4f47e8bc67a468"></a><!-- doxytag: member="msgqlib.h::MsgQSend" ref="a5272782967b922604e4f47e8bc67a468" args="(ULONG qName, char *msg, ULONG nBytes, ULONG priority, int timeout, int *err)" --> |
|
166 <div class="memitem"> |
|
167 <div class="memproto"> |
|
168 <table class="memname"> |
|
169 <tr> |
|
170 <td class="memname">IMPORT_C int MsgQSend </td> |
|
171 <td>(</td> |
|
172 <td class="paramtype">ULONG </td> |
|
173 <td class="paramname"> <em>qName</em>, </td> |
|
174 </tr> |
|
175 <tr> |
|
176 <td class="paramkey"></td> |
|
177 <td></td> |
|
178 <td class="paramtype">char * </td> |
|
179 <td class="paramname"> <em>msg</em>, </td> |
|
180 </tr> |
|
181 <tr> |
|
182 <td class="paramkey"></td> |
|
183 <td></td> |
|
184 <td class="paramtype">ULONG </td> |
|
185 <td class="paramname"> <em>nBytes</em>, </td> |
|
186 </tr> |
|
187 <tr> |
|
188 <td class="paramkey"></td> |
|
189 <td></td> |
|
190 <td class="paramtype">ULONG </td> |
|
191 <td class="paramname"> <em>priority</em>, </td> |
|
192 </tr> |
|
193 <tr> |
|
194 <td class="paramkey"></td> |
|
195 <td></td> |
|
196 <td class="paramtype">int </td> |
|
197 <td class="paramname"> <em>timeout</em>, </td> |
|
198 </tr> |
|
199 <tr> |
|
200 <td class="paramkey"></td> |
|
201 <td></td> |
|
202 <td class="paramtype">int * </td> |
|
203 <td class="paramname"> <em>err</em></td><td> </td> |
|
204 </tr> |
|
205 <tr> |
|
206 <td></td> |
|
207 <td>)</td> |
|
208 <td></td><td></td><td></td> |
|
209 </tr> |
|
210 </table> |
|
211 </div> |
|
212 <div class="memdoc"> |
|
213 <p>This function sends a message with internal copy</p> |
|
214 <dl><dt><b>Parameters:</b></dt><dd> |
|
215 <table border="0" cellspacing="2" cellpadding="0"> |
|
216 <tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr> |
|
217 <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>- message to send </td></tr> |
|
218 <tr><td valign="top"></td><td valign="top"><em>nBytes</em> </td><td>- length of message </td></tr> |
|
219 <tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>- message priority </td></tr> |
|
220 <tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>- milliseconds to wait </td></tr> |
|
221 <tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr> |
|
222 </table> |
|
223 </dd> |
|
224 </dl> |
|
225 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl> |
|
226 |
|
227 <p>Definition at line <a class="el" href="msgqsend_8c_source.html#l00022">22</a> of file <a class="el" href="msgqsend_8c_source.html">msgqsend.c</a>.</p> |
|
228 |
|
229 </div> |
|
230 </div> |
|
231 <a class="anchor" id="a92645de66865355158589ff1dd7bc28d"></a><!-- doxytag: member="msgqlib.h::MsgQReceive" ref="a92645de66865355158589ff1dd7bc28d" args="(ULONG qName, char *msg, ULONG maxNBytes, int timeout, int *err)" --> |
|
232 <div class="memitem"> |
|
233 <div class="memproto"> |
|
234 <table class="memname"> |
|
235 <tr> |
|
236 <td class="memname">IMPORT_C int MsgQReceive </td> |
|
237 <td>(</td> |
|
238 <td class="paramtype">ULONG </td> |
|
239 <td class="paramname"> <em>qName</em>, </td> |
|
240 </tr> |
|
241 <tr> |
|
242 <td class="paramkey"></td> |
|
243 <td></td> |
|
244 <td class="paramtype">char * </td> |
|
245 <td class="paramname"> <em>msg</em>, </td> |
|
246 </tr> |
|
247 <tr> |
|
248 <td class="paramkey"></td> |
|
249 <td></td> |
|
250 <td class="paramtype">ULONG </td> |
|
251 <td class="paramname"> <em>maxNBytes</em>, </td> |
|
252 </tr> |
|
253 <tr> |
|
254 <td class="paramkey"></td> |
|
255 <td></td> |
|
256 <td class="paramtype">int </td> |
|
257 <td class="paramname"> <em>timeout</em>, </td> |
|
258 </tr> |
|
259 <tr> |
|
260 <td class="paramkey"></td> |
|
261 <td></td> |
|
262 <td class="paramtype">int * </td> |
|
263 <td class="paramname"> <em>err</em></td><td> </td> |
|
264 </tr> |
|
265 <tr> |
|
266 <td></td> |
|
267 <td>)</td> |
|
268 <td></td><td></td><td></td> |
|
269 </tr> |
|
270 </table> |
|
271 </div> |
|
272 <div class="memdoc"> |
|
273 <p>This function receives a message with internal copy</p> |
|
274 <dl><dt><b>Parameters:</b></dt><dd> |
|
275 <table border="0" cellspacing="2" cellpadding="0"> |
|
276 <tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr> |
|
277 <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>- buffer for received message </td></tr> |
|
278 <tr><td valign="top"></td><td valign="top"><em>maxNBytes</em> </td><td>- length of buffer </td></tr> |
|
279 <tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>- milliseconds to wait </td></tr> |
|
280 <tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr> |
|
281 </table> |
|
282 </dd> |
|
283 </dl> |
|
284 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl> |
|
285 |
|
286 <p>Definition at line <a class="el" href="msgqrecv_8c_source.html#l00024">24</a> of file <a class="el" href="msgqrecv_8c_source.html">msgqrecv.c</a>.</p> |
|
287 |
|
288 </div> |
|
289 </div> |
|
290 <a class="anchor" id="a6539cca974e31b9571caae1a93576b21"></a><!-- doxytag: member="msgqlib.h::MsgQCheck" ref="a6539cca974e31b9571caae1a93576b21" args="(ULONG qName, int *err)" --> |
|
291 <div class="memitem"> |
|
292 <div class="memproto"> |
|
293 <table class="memname"> |
|
294 <tr> |
|
295 <td class="memname">IMPORT_C int MsgQCheck </td> |
|
296 <td>(</td> |
|
297 <td class="paramtype">ULONG </td> |
|
298 <td class="paramname"> <em>qName</em>, </td> |
|
299 </tr> |
|
300 <tr> |
|
301 <td class="paramkey"></td> |
|
302 <td></td> |
|
303 <td class="paramtype">int * </td> |
|
304 <td class="paramname"> <em>err</em></td><td> </td> |
|
305 </tr> |
|
306 <tr> |
|
307 <td></td> |
|
308 <td>)</td> |
|
309 <td></td><td></td><td></td> |
|
310 </tr> |
|
311 </table> |
|
312 </div> |
|
313 <div class="memdoc"> |
|
314 <p>This function checks how many messages are in a queue</p> |
|
315 <dl><dt><b>Parameters:</b></dt><dd> |
|
316 <table border="0" cellspacing="2" cellpadding="0"> |
|
317 <tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr> |
|
318 <tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr> |
|
319 </table> |
|
320 </dd> |
|
321 </dl> |
|
322 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl> |
|
323 |
|
324 <p>Definition at line <a class="el" href="msgqcheck_8c_source.html#l00021">21</a> of file <a class="el" href="msgqcheck_8c_source.html">msgqcheck.c</a>.</p> |
|
325 |
|
326 </div> |
|
327 </div> |
|
328 <a class="anchor" id="ac3714b7e3c9e3eafb7375ca1fe5d5ad7"></a><!-- doxytag: member="msgqlib.h::MsgQMaxCheck" ref="ac3714b7e3c9e3eafb7375ca1fe5d5ad7" args="(ULONG qName, int *err)" --> |
|
329 <div class="memitem"> |
|
330 <div class="memproto"> |
|
331 <table class="memname"> |
|
332 <tr> |
|
333 <td class="memname">IMPORT_C int MsgQMaxCheck </td> |
|
334 <td>(</td> |
|
335 <td class="paramtype">ULONG </td> |
|
336 <td class="paramname"> <em>qName</em>, </td> |
|
337 </tr> |
|
338 <tr> |
|
339 <td class="paramkey"></td> |
|
340 <td></td> |
|
341 <td class="paramtype">int * </td> |
|
342 <td class="paramname"> <em>err</em></td><td> </td> |
|
343 </tr> |
|
344 <tr> |
|
345 <td></td> |
|
346 <td>)</td> |
|
347 <td></td><td></td><td></td> |
|
348 </tr> |
|
349 </table> |
|
350 </div> |
|
351 <div class="memdoc"> |
|
352 <p>This function checks the maximum number of messages in a queue</p> |
|
353 <dl><dt><b>Parameters:</b></dt><dd> |
|
354 <table border="0" cellspacing="2" cellpadding="0"> |
|
355 <tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr> |
|
356 <tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr> |
|
357 </table> |
|
358 </dd> |
|
359 </dl> |
|
360 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl> |
|
361 |
|
362 <p>Definition at line <a class="el" href="msgqmaxcheck_8c_source.html#l00019">19</a> of file <a class="el" href="msgqmaxcheck_8c_source.html">msgqmaxcheck.c</a>.</p> |
|
363 |
|
364 </div> |
|
365 </div> |
|
366 <a class="anchor" id="af100b3206a8771a0b599a1ba5a4c8cb8"></a><!-- doxytag: member="msgqlib.h::MsgQClean" ref="af100b3206a8771a0b599a1ba5a4c8cb8" args="(ULONG qName, int *err)" --> |
|
367 <div class="memitem"> |
|
368 <div class="memproto"> |
|
369 <table class="memname"> |
|
370 <tr> |
|
371 <td class="memname">IMPORT_C int MsgQClean </td> |
|
372 <td>(</td> |
|
373 <td class="paramtype">ULONG </td> |
|
374 <td class="paramname"> <em>qName</em>, </td> |
|
375 </tr> |
|
376 <tr> |
|
377 <td class="paramkey"></td> |
|
378 <td></td> |
|
379 <td class="paramtype">int * </td> |
|
380 <td class="paramname"> <em>err</em></td><td> </td> |
|
381 </tr> |
|
382 <tr> |
|
383 <td></td> |
|
384 <td>)</td> |
|
385 <td></td><td></td><td></td> |
|
386 </tr> |
|
387 </table> |
|
388 </div> |
|
389 <div class="memdoc"> |
|
390 <p>This function empties the specified queue</p> |
|
391 <dl><dt><b>Parameters:</b></dt><dd> |
|
392 <table border="0" cellspacing="2" cellpadding="0"> |
|
393 <tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr> |
|
394 <tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr> |
|
395 </table> |
|
396 </dd> |
|
397 </dl> |
|
398 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl> |
|
399 |
|
400 <p>Definition at line <a class="el" href="msgqclean_8c_source.html#l00020">20</a> of file <a class="el" href="msgqclean_8c_source.html">msgqclean.c</a>.</p> |
|
401 |
|
402 </div> |
|
403 </div> |
|
404 </div> |
|
405 <hr size="1"/><address style="text-align: right;"><small>Generated by |
|
406 <a href="http://www.doxygen.org/index.html"> |
|
407 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> |
|
408 </body> |
|
409 </html> |