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>OSTryLockMutex</title>
10</head>
11
12<body>
13
14<h1>OSTryLockMutex</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/os.h&gt;
19
20BOOL OSTryLockMutex(OSMutex* mutex);
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25  <tr>
26<TH><STRONG><EM><CODE>mutex</CODE></EM></STRONG></TH>
27<TD>Pointer to mutex.</TD>
28  </tr>
29</TABLE>
30
31<h2>Return Values</h2>
32<p>Returns <code>TRUE</code> if the mutex is successfully locked. Otherwise, returns <code>FALSE</code>.</p>
33
34<h2>Description</h2>
35<p>The calling thread tries to lock the mutex. Returns <code>FALSE</code> if the mutex is already locked.</p>
36
37<h2>See Also</h2>
38<P class="reference">
39<A href="../toc.html#Thread" target="contents">Thread Functions</A>,
40<A href="../toc.html#ThreadSynchronization" target="contents">Thread Synchronization Functions</A>,
41<a href="OSInitCond.html">OSInitCond</a>,
42<a href="OSInitMutex.html">OSInitMutex</a>,
43<a href="OSLockMutex.html">OSLockMutex</a>,
44<a href="OSSignalCond.html">OSSignalCond</a>,
45<a href="OSUnlockMutex.html">OSUnlockMutex</a>,
46<a href="OSWaitCond.html">OSWaitCond</a>
47</p>
48
49<h2>Revision History</h2>
50<p>
512006/03/01 Initial version.<br>
52</p>
53
54<hr><p>CONFIDENTIAL</p></body>
55</html>