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="IBM WebSphere Studio Homepage Builder Version 7.0.1.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>OS_InitMutex</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">OS_InitMutex <IMG src="../../image/NTR.gif" align="middle"><IMG src="../../image/TWL.gif" align="middle"></h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;nitro/os.h&gt;</CODE><BR> <BR> <CODE>void OS_InitMutex( OSMutex* mutex );</CODE></dd>
20</dl>
21
22<h2>Arguments</h2>
23<TABLE border="1" width="100%">
24  <TBODY>
25    <TR>
26<TD width="13%"><EM><STRONG>mutex</STRONG></EM></TD>
27<TD width="87%">Pointer to <CODE>OSMutex</CODE> structure to be initialized</TD>
28    </TR>
29  </TBODY>
30</TABLE>
31
32<h2>Return Values</h2>
33<p>None.</p>
34
35<H2>Description</H2>
36<P>This function initializes a <CODE>mutex</CODE>.</P>
37<P>A <CODE>mutex</CODE> is used to synchronize threads. Operations are unpredictable when a <code>mutex</code> in use is initialized.</P>
38<P>You need to initialize the <CODE>mutex</CODE> with this function before it can be locked by the <CODE><A href="OS_LockMutex.html">OS_LockMutex</A></CODE>, <CODE><A href="OS_LockMutexRW.html">OS_LockMutexR</A></CODE>, or <CODE><A href="OS_LockMutexRW.html">OS_LockMutexW</A></CODE> function.</P>
39<h2>See Also</h2>
40<p><CODE><A href="OS_LockMutex.html">OS_LockMutex</A><BR> <A href="OS_UnlockMutex.html">OS_UnlockMutex</A><BR> <A href="OS_TryLockMutex.html">OS_TryLockMutex</A></CODE><BR> <CODE><A href="OS_LockMutexRW.html">OS_LockMutexR</A><BR> <A href="OS_LockMutexRW.html">OS_LockMutexW</A><BR> <A href="OS_UnlockMutexRW.html">OS_UnlocMutexR</A><BR> <A href="OS_UnlockMutexRW.html">OS_UnlocMutexW</A><BR> <A href="OS_TryLockMutexRW.html">OS_TryLockMutexR</A><BR> <A href="OS_TryLockMutexRW.html">OS_TryLockMutexW</A><BR> <A href="OS_LockMutexFromToRW.html">OS_LockMutexFromRToW</A><BR> <A href="OS_LockMutexFromToRW.html">OS_LockMutexFromWToR<BR></A><A href="OS_TryLockMutexFromToRW.html">OS_TryLockMutexFromRToW</A><BR> <A href="OS_TryLockMutexFromToRW.html">OS_TryLockMutexFromWToR</A></CODE></p>
41<H2>Revision History</H2>
42<P>2008/12/17 Added the read/write lock mutex functions to See Also.<BR>2003/12/01 Initial version.</P>
43<hr><p>CONFIDENTIAL</p></body>
44</html>
45