1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="Microsoft FrontPage 5.0">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
9<title>OSInitMessageQueue</title>
10</head>
11
12<body>
13
14<h1>OSInitMessageQueue</h1>
15
16
17<h2>C Specification</h2>
18
19<dl>
20  <dd><pre><code>#include &lt;revolution/os.h&gt;</code></pre>
21  </dd>
22  <dd><pre><code>void OSInitMessageQueue(
23    OSMessageQueue* mq,
24    OSMessage*      msgArray,
25    s32             msgCount);</code></pre>
26  </dd>
27</dl>
28
29<h2>Arguments</h2>
30<TABLE border="1" cellpadding="3" cellspacing="0.1">
31  <tr>
32<TD width="120" bgcolor="#ffffe8"><i><b><code><STRONG><EM><CODE>mq</CODE></EM></STRONG></code></b></i></TD>
33<TD width="520">Pointer to message queue.</TD>
34    </tr>
35  <tr>
36<TD width="120" bgcolor="#ffffe8"><i><b><code><STRONG><EM><CODE>msgArray</CODE></EM></STRONG></code></b></i></TD>
37<TD width="520">Pointer to array that will hold the messages.</TD>
38    </tr>
39  <tr>
40<TD width="120" bgcolor="#ffffe8"><i><b><code><STRONG><EM><CODE>msgCount</CODE></EM></STRONG></code></b></i></TD>
41<TD width="520">The number of messages that the array can hold.</TD>
42    </tr>
43</TABLE>
44<h2>Return Values</h2>
45
46<p>None.</p>
47
48<h2>Description</h2>
49
50<p>Initializes the message queue structure <i><b><code>mq</code></b></i>.&nbsp;The <em><strong><code>msgArray</code></strong></em> argument is a pointer to the array that holds queue messages, and <em><strong><code>msgCount</code></strong></em> is the number of messages that the queue can hold (i.e., the array size).</p>
51
52
53
54<h2>See Also</h2>
55
56<p><a href="../toc.html#Thread" target="contents">Thread Functions</a>, <a href="../toc.html#ThreadSynchronization" target="contents">Thread Synchronization Functions</a>, <a href="OSJamMessage.html"><code>OSJamMessage</code></a>, <a href="OSReceiveMessage.html"><code>OSReceiveMessage</code></a>, <a href="OSSendMessage.html"><code>OSSendMessage</code></a></p>
57
58<h2>Revision History</h2><p></p>
59
60<P>2006/03/01 Initial version.</p>
61
62<hr>
63<P>CONFIDENTIAL</p>
64</BODY>
65</HTML>