docs/libcurl/opts/CURLOPT_WRITEDATA.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2  "http://www.w3.org/TR/html4/loose.dtd">
   3 <html><head>
   4 <title>CURLOPT_WRITEDATA man page</title>
   5 <meta name="generator" content="roffit">
   6 <STYLE type="text/css">
   7 P.level0 {
   8  padding-left: 2em;
   9 }
  10
  11 P.level1 {
  12  padding-left: 4em;
  13 }
  14
  15 P.level2 {
  16  padding-left: 6em;
  17 }
  18
  19 span.emphasis {
  20  font-style: italic;
  21 }
  22
  23 span.bold {
  24  font-weight: bold;
  25 }
  26
  27 span.manpage {
  28  font-weight: bold;
  29 }
  30
  31 h2.nroffsh {
  32  background-color: #e0e0e0;
  33 }
  34
  35 span.nroffip {
  36  font-weight: bold;
  37  font-size: 120%;
  38  font-family: monospace;
  39 }
  40
  41 p.roffit {
  42  text-align: center;
  43  font-size: 80%;
  44 }
  45 </STYLE>
  46 </head><body>
  47
  48 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  49 <p class="level0">CURLOPT_WRITEDATA - custom pointer passed to the write callback <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  50 <p class="level0">#include &lt;curl/curl.h&gt;
  51 <p class="level0">CURLcode curl_easy_setopt(CURL *handle, CURLOPT_WRITEDATA, void *pointer); <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  52 <p class="level0">A data <span Class="emphasis">pointer</span> to pass to the write callback. If you use the <a Class="emphasis" href="./CURLOPT_WRITEFUNCTION.html">CURLOPT_WRITEFUNCTION</a> option, this is the pointer you'll get in that callback's 4th argument. If you don't use a write callback, you must make <span Class="emphasis">pointer</span> a 'FILE *' (cast to 'void *') as libcurl will pass this to <span Class="emphasis">fwrite(3)</span> when writing data.
  53 <p class="level0">The internal <a Class="emphasis" href="./CURLOPT_WRITEFUNCTION.html">CURLOPT_WRITEFUNCTION</a> will write the data to the FILE * given with this option, or to stdout if this option hasn't been set.
  54 <p class="level0">If you're using libcurl as a win32 DLL, you <span Class="bold">MUST</span> use the <a Class="emphasis" href="./CURLOPT_WRITEFUNCTION.html">CURLOPT_WRITEFUNCTION</a> if you set this option or you will experience crashes. <a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
  55 <p class="level0">By default, this is a FILE * to stdout. <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
  56 <p class="level0">Used for all protocols. <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
  57 <p class="level0">A common technique is to use the write callback to store the incoming data into a dynamically growing allocated buffer, and then this CURLOPT_WRITEDATA is used to point to a struct or the buffer to store data in. Like in the getinmemory example: <a href="http://curl.haxx.se/libcurl/c/getinmemory.html">http://curl.haxx.se/libcurl/c/getinmemory.html</a> <a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
  58 <p class="level0">Available in all libcurl versions. This option was formerly known as <span Class="emphasis">CURLOPT_FILE</span>, the name <span Class="emphasis">CURLOPT_WRITEDATA</span> was introduced in 7.9.7. <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
  59 <p class="level0">This will return CURLE_OK. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
  60 <p class="level0"><a Class="manpage" href="./CURLOPT_WRITEFUNCTION.html">CURLOPT_WRITEFUNCTION</a>, <a Class="manpage" href="./CURLOPT_READDATA.html">CURLOPT_READDATA</a>, <span Class="manpage"> </span> <p class="roffit">
  61  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
  62 </body></html>