Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: examples/PIPS/opencmessagequeuelibraryex/engine/inc/msgqlib.h 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.6.2 -->
<div class="contents">
<h1>examples/PIPS/opencmessagequeuelibraryex/engine/inc/msgqlib.h File Reference</h1>
<p><a href="msgqlib_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51d90ea93d4b55e086cb490f7478e684"></a><!-- doxytag: member="msgqlib.h::MAX_MSG_LEN" ref="a51d90ea93d4b55e086cb490f7478e684" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MAX_MSG_LEN</b> 2048</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac3b870d7fae5f0d40c33124523b9e95c"></a><!-- doxytag: member="msgqlib.h::MSGQ_TBL_SZ" ref="ac3b870d7fae5f0d40c33124523b9e95c" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MSGQ_TBL_SZ</b> 101</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1db87020c9dbe6a919b24901d284249c"></a><!-- doxytag: member="msgqlib.h::MSG_Q_READY" ref="a1db87020c9dbe6a919b24901d284249c" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MSG_Q_READY</b> 0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a907a8ef515d861288914c75ef7292451"></a><!-- doxytag: member="msgqlib.h::MSG_Q_CLEANING" ref="a907a8ef515d861288914c75ef7292451" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MSG_Q_CLEANING</b> 1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3507cbe64443191d510ae7e093d37036"></a><!-- doxytag: member="msgqlib.h::NO_WAIT" ref="a3507cbe64443191d510ae7e093d37036" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>NO_WAIT</b> 0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac89d2c332821be06166c210249b671e7"></a><!-- doxytag: member="msgqlib.h::WAIT_FOREVER" ref="ac89d2c332821be06166c210249b671e7" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>WAIT_FOREVER</b> 0xFFFF</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac75179b84d855ba43aa4eb8f276f9220"></a><!-- doxytag: member="msgqlib.h::KMsgQLibErr" ref="ac75179b84d855ba43aa4eb8f276f9220" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibErr</b> 0x100</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acdb35527989a60cd392b232797d7b020"></a><!-- doxytag: member="msgqlib.h::KMsgQLibNoMemoryErr" ref="acdb35527989a60cd392b232797d7b020" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibNoMemoryErr</b> (KMsgQLibErr | 1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20fbdf79a5c79226aee7f10892eebb70"></a><!-- doxytag: member="msgqlib.h::KMsgQLibQIdErr" ref="a20fbdf79a5c79226aee7f10892eebb70" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibQIdErr</b> (KMsgQLibErr | 2)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0d88606bdb681324866d980da344e96"></a><!-- doxytag: member="msgqlib.h::KMsgQLibParamErr" ref="ab0d88606bdb681324866d980da344e96" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibParamErr</b> (KMsgQLibErr | 3)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9722dcaa37f6bf1ec0384ae7e7425f5d"></a><!-- doxytag: member="msgqlib.h::KMsgQLibQFlushErr" ref="a9722dcaa37f6bf1ec0384ae7e7425f5d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibQFlushErr</b> (KMsgQLibErr | 4)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f86ac9f04d8759c799c16e6c91b60f1"></a><!-- doxytag: member="msgqlib.h::KMsgQLibQShortErr" ref="a2f86ac9f04d8759c799c16e6c91b60f1" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>KMsgQLibQShortErr</b> (KMsgQLibErr | 5)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0e86afdef9251809bfff8f7e82e062d"></a><!-- doxytag: member="msgqlib.h::MSG_Q_FIFO" ref="ab0e86afdef9251809bfff8f7e82e062d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MSG_Q_FIFO</b> 1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a826ed7a139e7afecffd01d5b454779ce"></a><!-- doxytag: member="msgqlib.h::MSG_Q_PRIORITY" ref="a826ed7a139e7afecffd01d5b454779ce" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MSG_Q_PRIORITY</b> 2</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26c24177b7689d9c0dd3104926169dff"></a><!-- doxytag: member="msgqlib.h::MSG_PRI_NORMAL" ref="a26c24177b7689d9c0dd3104926169dff" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MSG_PRI_NORMAL</b> 3</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a387c2708adea6b9641abc2226f196a2d"></a><!-- doxytag: member="msgqlib.h::MSG_PRI_URGENT" ref="a387c2708adea6b9641abc2226f196a2d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MSG_PRI_URGENT</b> 4</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb5136c141cca4780f6fbb942f06b1ba"></a><!-- doxytag: member="msgqlib.h::SEM_Q_FIFO" ref="adb5136c141cca4780f6fbb942f06b1ba" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SEM_Q_FIFO</b> 5</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afadcd4ace04ef2c9806ed2dd763f8ec2"></a><!-- doxytag: member="msgqlib.h::SEM_Q_PRIORITY" ref="afadcd4ace04ef2c9806ed2dd763f8ec2" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>SEM_Q_PRIORITY</b> 6</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba51915c87d64af47fb1cc59348961c9"></a><!-- doxytag: member="msgqlib.h::OK" ref="aba51915c87d64af47fb1cc59348961c9" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>OK</b> 0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fe83ac76edc595f6b98cd4a4127aed5"></a><!-- doxytag: member="msgqlib.h::ERROR" ref="a8fe83ac76edc595f6b98cd4a4127aed5" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>ERROR</b> -1</td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af632da489ebc3708ec3ab6791ee53fa4"></a><!-- doxytag: member="msgqlib.h::ULONG" ref="af632da489ebc3708ec3ab6791ee53fa4" args="" -->
typedef unsigned long </td><td class="memItemRight" valign="bottom"><b>ULONG</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad32f74eab70f4b87dac7fa0c0508ce29"></a><!-- doxytag: member="msgqlib.h::ushort_t" ref="ad32f74eab70f4b87dac7fa0c0508ce29" args="" -->
typedef unsigned short </td><td class="memItemRight" valign="bottom"><b>ushort_t</b></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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>
<p>Definition in file <a class="el" href="msgqlib_8h_source.html">msgqlib.h</a>.</p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="acc58bf2bd8d3b904069d8d604ccea5b1"></a><!-- doxytag: member="msgqlib.h::MsgQCreate" ref="acc58bf2bd8d3b904069d8d604ccea5b1" args="(ULONG qName, ULONG maxMsgs, ULONG qOptions, int *err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int MsgQCreate </td>
<td>(</td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>qName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>maxMsgs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>qOptions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>err</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a message queue with the argument passed</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxMsgs</em> </td><td>- max messages in the queue </td></tr>
<tr><td valign="top"></td><td valign="top"><em>qOptions</em> </td><td>- message queue options MSG_Q_FIFO MSG_Q_PRIORITY </td></tr>
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl>
<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>
</div>
</div>
<a class="anchor" id="ae9435d91016cacef90a4d92db16a6fe1"></a><!-- doxytag: member="msgqlib.h::MsgQDelete" ref="ae9435d91016cacef90a4d92db16a6fe1" args="(ULONG qName, int *err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int MsgQDelete </td>
<td>(</td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>qName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>err</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function deletes a message queue</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl>
<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>
</div>
</div>
<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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int MsgQSend </td>
<td>(</td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>qName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>nBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>priority</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>timeout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>err</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function sends a message with internal copy</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>- message to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nBytes</em> </td><td>- length of message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>- message priority </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>- milliseconds to wait </td></tr>
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl>
<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>
</div>
</div>
<a class="anchor" id="a92645de66865355158589ff1dd7bc28d"></a><!-- doxytag: member="msgqlib.h::MsgQReceive" ref="a92645de66865355158589ff1dd7bc28d" args="(ULONG qName, char *msg, ULONG maxNBytes, int timeout, int *err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int MsgQReceive </td>
<td>(</td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>qName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>maxNBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>timeout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>err</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function receives a message with internal copy</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>- buffer for received message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxNBytes</em> </td><td>- length of buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>- milliseconds to wait </td></tr>
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl>
<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>
</div>
</div>
<a class="anchor" id="a6539cca974e31b9571caae1a93576b21"></a><!-- doxytag: member="msgqlib.h::MsgQCheck" ref="a6539cca974e31b9571caae1a93576b21" args="(ULONG qName, int *err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int MsgQCheck </td>
<td>(</td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>qName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>err</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function checks how many messages are in a queue</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl>
<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>
</div>
</div>
<a class="anchor" id="ac3714b7e3c9e3eafb7375ca1fe5d5ad7"></a><!-- doxytag: member="msgqlib.h::MsgQMaxCheck" ref="ac3714b7e3c9e3eafb7375ca1fe5d5ad7" args="(ULONG qName, int *err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int MsgQMaxCheck </td>
<td>(</td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>qName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>err</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function checks the maximum number of messages in a queue</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl>
<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>
</div>
</div>
<a class="anchor" id="af100b3206a8771a0b599a1ba5a4c8cb8"></a><!-- doxytag: member="msgqlib.h::MsgQClean" ref="af100b3206a8771a0b599a1ba5a4c8cb8" args="(ULONG qName, int *err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IMPORT_C int MsgQClean </td>
<td>(</td>
<td class="paramtype">ULONG </td>
<td class="paramname"> <em>qName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>err</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function empties the specified queue</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>qName</em> </td><td>- queue name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>- error code to be returned</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns status and error code </dd></dl>
<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>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>