Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_WRITEDATA.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLOPT_WRITEDATA 3 "February 03, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_WRITEDATA \- custom pointer passed to the write callback
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_WRITEDATA, void *pointer);
31 .SH DESCRIPTION
32 A data \fIpointer\fP to pass to the write callback. If you use the
33 \fICURLOPT_WRITEFUNCTION(3)\fP option, this is the pointer you'll get in that
34 callback's 4th argument. If you don't use a write callback, you must make
35 \fIpointer\fP a 'FILE *' (cast to 'void *') as libcurl will pass this to
36 \fIfwrite(3)\fP when writing data.
37
38 The internal \fICURLOPT_WRITEFUNCTION(3)\fP will write the data to the FILE *
39 given with this option, or to stdout if this option hasn't been set.
40
41 If you're using libcurl as a win32 DLL, you \fBMUST\fP use the
42 \fICURLOPT_WRITEFUNCTION(3)\fP if you set this option or you will experience
43 crashes.
44 .SH DEFAULT
45 By default, this is a FILE * to stdout.
46 .SH PROTOCOLS
47 Used for all protocols.
48 .SH EXAMPLE
49 A common technique is to use the write callback to store the incoming data
50 into a dynamically growing allocated buffer, and then this
51 \fICURLOPT_WRITEDATA(3)\fP is used to point to a struct or the buffer to store
52 data in. Like in the getinmemory example:
53 https://curl.haxx.se/libcurl/c/getinmemory.html
54 .SH AVAILABILITY
55 Available in all libcurl versions. This option was formerly known as
56 \fICURLOPT_FILE\fP, the name \fICURLOPT_WRITEDATA(3)\fP was introduced in
57 7.9.7.
58 .SH RETURN VALUE
59 This will return CURLE_OK.
60 .SH "SEE ALSO"
61 .BR CURLOPT_WRITEFUNCTION "(3), " CURLOPT_READDATA "(3), "