Git init
[external/curl.git] / docs / libcurl / curl_share_init.html
1 <html><head>
2 <title>curl_share_init man page</title>
3 <meta name="generator" content="roffit 0.7">
4 <STYLE type="text/css">
5 P.level0 {
6  padding-left: 2em;
7 }
8
9 P.level1 {
10  padding-left: 4em;
11 }
12
13 P.level2 {
14  padding-left: 6em;
15 }
16
17 span.emphasis {
18  font-style: italic;
19 }
20
21 span.bold {
22  font-weight: bold;
23 }
24
25 span.manpage {
26  font-weight: bold;
27 }
28
29 h2.nroffsh {
30  background-color: #e0e0e0;
31 }
32
33 span.nroffip {
34  font-weight: bold;
35  font-size: 120%;
36  font-family: monospace;
37 }
38
39 p.roffit {
40  text-align: center;
41  font-size: 80%;
42 }
43 </STYLE>
44 </head><body>
45
46 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
47 <p class="level0">curl_share_init - Create a shared object <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
48 <p class="level0"><span Class="bold">#include &lt;curl/curl.h&gt;</span> 
49 <p class="level0"><span Class="bold">CURLSH *curl_share_init( );</span> 
50 <p class="level0"><a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
51 <p class="level0">This function returns a CURLSH handle to be used as input to all the other share-functions, sometimes referred to as a share handle in some places in the documentation. This init call MUST have a corresponding call to <span Class="emphasis">curl_share_cleanup</span> when all operations using the share are complete. 
52 <p class="level0">This <span Class="emphasis">share handle</span> is what you pass to curl using the <span Class="emphasis">CURLOPT_SHARE</span> option with <a class="emphasis" href="./curl_easy_setopt.html">curl_easy_setopt(3)</a>, to make that specific curl handle use the data in this share. <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
53 <p class="level0">If this function returns NULL, something went wrong (out of memory, etc.) and therefore the share object was not created. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
54 <p class="level0"><a class="manpage" href="./curl_share_cleanup.html">curl_share_cleanup (3)</a> <a class="manpage" href="./curl_share_setopt.html">  curl_share_setopt (3)</a> 
55 <p class="level0"><p class="roffit">
56  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
57 </body></html>