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_TryLockMutex</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">OS_TryLockMutex <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>BOOL OS_TryLockMutex( 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 the <CODE>OSMutex</CODE> structure</TD>
28    </TR>
29  </TBODY>
30</TABLE>
31
32<h2>Return Values</h2>
33<p>Returns TRUE when <CODE>mutex</CODE> is locked. Otherwise returns FALSE.</p>
34
35<H2>Description</H2>
36<P>The calling thread attempts to lock <B><I>mutex</I></B>.</P>
37<P>If the mutex cannot be locked, the function returns <code>FALSE</code>. If the thread is able to lock the mutex, this function performs processing conforming to <A href="OS_LockMutex.html"><CODE>OS_LockMutex()</CODE></A>.</P>
38
39<h2>See Also</h2>
40<p><CODE><A href="OS_InitMutex.html">OS_InitMutex</A>, <A href="OS_LockMutex.html">OS_LockMutex</A>, <A href="OS_UnlockMutex.html">OS_UnlockMutex</A></CODE></p>
41
42<H2>Revision History</H2>
43<P>2003/12/01 Initial version.</P>
44<hr><p>CONFIDENTIAL</p></body>
45</html>
46