Imported Upstream version 5.3.21
[platform/upstream/libdb.git] / docs / api_reference / STL / stldbstl_global_functionsunlock_mutex.html
1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4   <head>
5     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6     <title>unlock_mutex</title>
7     <link rel="stylesheet" href="apiReference.css" type="text/css" />
8     <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
9     <link rel="start" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
10     <link rel="up" href="dbstl_global_functions.html" title="Chapter 1.  Dbstl Global Public Functions" />
11     <link rel="prev" href="stldbstl_global_functionslock_mutex.html" title="lock_mutex" />
12     <link rel="next" href="stldbstl_global_functionsfree_mutex.html" title="free_mutex" />
13   </head>
14   <body>
15     <div xmlns="" class="navheader">
16       <div class="libver">
17         <p>Library Version 11.2.5.3</p>
18       </div>
19       <table width="100%" summary="Navigation header">
20         <tr>
21           <th colspan="3" align="center">unlock_mutex</th>
22         </tr>
23         <tr>
24           <td width="20%" align="left"><a accesskey="p" href="stldbstl_global_functionslock_mutex.html">Prev</a> </td>
25           <th width="60%" align="center">Chapter 1. 
26  Dbstl Global Public Functions  </th>
27           <td width="20%" align="right"> <a accesskey="n" href="stldbstl_global_functionsfree_mutex.html">Next</a></td>
28         </tr>
29       </table>
30       <hr />
31     </div>
32     <div class="sect1" lang="en" xml:lang="en">
33       <div class="titlepage">
34         <div>
35           <div>
36             <h2 class="title" style="clear: both"><a id="stldbstl_global_functionsunlock_mutex"></a>unlock_mutex</h2>
37           </div>
38         </div>
39       </div>
40       <div class="sect2" lang="en" xml:lang="en">
41         <div class="titlepage">
42           <div>
43             <div>
44               <h3 class="title"><a id="stldbstl_global_functionsunlock_mutex_details"></a>Function Details</h3>
45             </div>
46           </div>
47         </div>
48         <pre class="programlisting">
49  int unlock_mutex(db_mutex_t mtx)
50  </pre>
51         <p>Unlock a mutex, and return immediately. </p>
52         <div class="sect3" lang="en" xml:lang="en">
53           <div class="titlepage">
54             <div>
55               <div>
56                 <h4 class="title"><a id="idm885536"></a>Parameters</h4>
57               </div>
58             </div>
59           </div>
60           <div class="sect4" lang="en" xml:lang="en">
61             <div class="titlepage">
62               <div>
63                 <div>
64                   <h5 class="title"><a id="idm876216"></a>mtx</h5>
65                 </div>
66               </div>
67             </div>
68             <p>The mutex handle to unlock. </p>
69           </div>
70         </div>
71         <div class="sect3" lang="en" xml:lang="en">
72           <div class="titlepage">
73             <div>
74               <div>
75                 <h4 class="title"><a id="idm873200"></a>Return Value</h4>
76               </div>
77             </div>
78           </div>
79           <p>0 if succeed, non-zero otherwise, call db_strerror to get message. </p>
80         </div>
81       </div>
82       <div class="sect2" lang="en" xml:lang="en">
83         <div class="titlepage">
84           <div>
85             <div>
86               <h3 class="title"><a id="idm654520"></a>Group: Mutex API based on Berkeley DB mutex.</h3>
87             </div>
88           </div>
89         </div>
90         <p>These functions are in-process mutex support which uses Berkeley DB mutex mechanisms.</p>
91         <p>You can call these functions to do portable synchronization for your code. </p>
92       </div>
93       <div class="sect2" lang="en" xml:lang="en">
94         <div class="titlepage">
95           <div>
96             <div>
97               <h3 class="title"><a id="idm843184"></a>Class</h3>
98             </div>
99           </div>
100         </div>
101         <p>
102   <a class="link" href="dbstl_global_functions.html" title="Chapter 1.  Dbstl Global Public Functions">dbstl_global_functions</a>
103      </p>
104       </div>
105     </div>
106     <div class="navfooter">
107       <hr />
108       <table width="100%" summary="Navigation footer">
109         <tr>
110           <td width="40%" align="left"><a accesskey="p" href="stldbstl_global_functionslock_mutex.html">Prev</a> </td>
111           <td width="20%" align="center">
112             <a accesskey="u" href="dbstl_global_functions.html">Up</a>
113           </td>
114           <td width="40%" align="right"> <a accesskey="n" href="stldbstl_global_functionsfree_mutex.html">Next</a></td>
115         </tr>
116         <tr>
117           <td width="40%" align="left" valign="top">lock_mutex </td>
118           <td width="20%" align="center">
119             <a accesskey="h" href="index.html">Home</a>
120           </td>
121           <td width="40%" align="right" valign="top"> free_mutex</td>
122         </tr>
123       </table>
124     </div>
125   </body>
126 </html>