Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/msgqclean_8c_source.html
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/src/msgqclean.c Source File</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 -->
<h1>examples/PIPS/opencmessagequeuelibraryex/engine/src/msgqclean.c</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00010"></a>00010 <span class="preprocessor">#include <errno.h></span>
<a name="l00011"></a>00011 <span class="preprocessor">#include <sys/msg.h></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include "<a class="code" href="msgqinternal_8h.html">MsgQInternal.h</a>"</span>
<a name="l00013"></a>00013
<a name="l00014"></a>00014
<a name="l00015"></a>00015 <span class="comment">/****************************************************************************</span>
<a name="l00016"></a>00016 <span class="comment">* MsgQClean (qName, err)</span>
<a name="l00017"></a>00017 <span class="comment">* Description: Function that empties the specified queue</span>
<a name="l00018"></a>00018 <span class="comment">*****************************************************************************/</span>
<a name="l00019"></a>00019
<a name="l00020"></a><a class="code" href="msgqlib_8h.html#af100b3206a8771a0b599a1ba5a4c8cb8">00020</a> EXPORT_C <span class="keywordtype">int</span> <a class="code" href="msgqlib_8h.html#af100b3206a8771a0b599a1ba5a4c8cb8">MsgQClean</a>(ULONG qName, <span class="keywordtype">int</span>* err) {
<a name="l00021"></a>00021 <a class="code" href="struct_msg_q_info.html">MSGQ_INFO</a>* pMsgQInfo = NULL;
<a name="l00022"></a>00022 <span class="keywordtype">char</span> msg[MAX_MSG_LEN];
<a name="l00023"></a>00023 <span class="keywordtype">int</span> rcv_err;
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="keywordflow">if</span> ((pMsgQInfo = MsgQTableLookup(qName)) != NULL) {
<a name="l00026"></a>00026 <span class="comment">// sending a message is not allowed</span>
<a name="l00027"></a>00027 pMsgQInfo->sendState = MSG_Q_CLEANING;
<a name="l00028"></a>00028 <span class="comment">// empty out the queue </span>
<a name="l00029"></a>00029 <span class="keywordflow">while</span>(<a class="code" href="msgqlib_8h.html#a92645de66865355158589ff1dd7bc28d">MsgQReceive</a>(qName, msg, MAX_MSG_LEN, IPC_NOWAIT, &rcv_err) != ERROR) {};
<a name="l00030"></a>00030 <span class="keywordflow">if</span> (rcv_err == ENOMSG) {
<a name="l00031"></a>00031 *err = OK;
<a name="l00032"></a>00032 <span class="keywordflow">return</span> (OK);
<a name="l00033"></a>00033 }
<a name="l00034"></a>00034 <span class="keywordflow">else</span>
<a name="l00035"></a>00035 *err = rcv_err;
<a name="l00036"></a>00036 <span class="comment">// sending a message is allowed</span>
<a name="l00037"></a>00037 pMsgQInfo->sendState = MSG_Q_READY;
<a name="l00038"></a>00038 }
<a name="l00039"></a>00039 <span class="keywordflow">else</span>
<a name="l00040"></a>00040 *err = KMsgQLibQIdErr;
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="keywordflow">return</span>(ERROR);
<a name="l00043"></a>00043 }
<a name="l00044"></a>00044
<a name="l00045"></a>00045
</pre></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>