From 28b698858ca905bb9d1bf6f0b6f1557cbc4a7db5 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Mon, 16 Jun 2014 23:01:12 +0200 Subject: opts docs: 3 more options in their own man pages --- docs/libcurl/opts/CURLOPT_WRITEDATA.3 | 60 +++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 docs/libcurl/opts/CURLOPT_WRITEDATA.3 (limited to 'docs/libcurl/opts/CURLOPT_WRITEDATA.3') diff --git a/docs/libcurl/opts/CURLOPT_WRITEDATA.3 b/docs/libcurl/opts/CURLOPT_WRITEDATA.3 new file mode 100644 index 000000000..8ac355302 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_WRITEDATA.3 @@ -0,0 +1,60 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at http://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_WRITEDATA 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_WRITEDATA \- custom pointer passed to the write callback +.SH SYNOPSIS +#include + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_WRITEDATA, void *pointer); +.SH DESCRIPTION +A data \fIpointer\fP to pass to the write callback. If you use the +\fICURLOPT_WRITEFUNCTION(3)\fP 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 +\fIpointer\fP a 'FILE *' (cast to 'void *') as libcurl will pass this to +\fIfwrite(3)\fP when writing data. + +The internal \fICURLOPT_WRITEFUNCTION(3)\fP will write the data to the FILE * +given with this option, or to stdout if this option hasn't been set. + +If you're using libcurl as a win32 DLL, you \fBMUST\fP use the +\fICURLOPT_WRITEFUNCTION\fP if you set this option or you will experience +crashes. + +This option is also known with the older name \fICURLOPT_FILE\fP, the name +\fICURLOPT_WRITEDATA\fP was introduced in 7.9.7. +.SH DEFAULT +By default, this is a FILE * to stdout. +.SH PROTOCOLS +Used for all protocols. +.SH EXAMPLE +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: http://curl.haxx.se/libcurl/c/getinmemory.html +.SH AVAILABILITY +Available in all libcurl versions +.SH RETURN VALUE +This will return CURLE_OK. +.SH "SEE ALSO" +.BR CURLOPT_WRITEFUNCTION "(3), " CURLOPT_READDATA "(3), " -- cgit v1.2.3