docs/libcurl/opts/CURLOPT_READDATA.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 http://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_READDATA 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_READDATA \- custom pointer passed to the read callback
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_READDATA, void *pointer);
  30 .SH DESCRIPTION
  31 Data \fIpointer\fP to pass to the file read function. If you use the
  32 \fICURLOPT_READFUNCTION(3)\fP option, this is the pointer you'll get as
  33 input in the 4th argument to the callback.
  34
  35 If you don't specify a read callback but instead rely on the default internal
  36 read function, this data must be a valid readable FILE * (cast to 'void *').
  37
  38 If you're using libcurl as a win32 DLL, you MUST use a
  39 \fICURLOPT_READFUNCTION(3)\fP if you set this option.
  40 .SH DEFAULT
  41 By default, this is a FILE * to stdin.
  42 .SH PROTOCOLS
  43 This is used for all protocols when sending data.
  44 .SH EXAMPLE
  45 .nf
  46 CURL *curl = curl_easy_init();
  47 struct MyData this;
  48 if(curl) {
  49   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  50
  51   /* pass pointer that gets passed in to the
  52      CURLOPT_READFUNCTION callback */
  53   curl_easy_setopt(curl, CURLOPT_READDATA, &this);
  54
  55   curl_easy_perform(curl);
  56 }
  57 .fi
  58 .SH AVAILABILITY
  59 This option was once known by the older name \fICURLOPT_INFILE\fP, the name
  60 \fICURLOPT_READDATA\fP was introduced in 7.9.7.
  61 .SH RETURN VALUE
  62 This will return CURLE_OK.
  63 .SH "SEE ALSO"
  64 .BR CURLOPT_READFUNCTION "(3), " CURLOPT_WRITEDATA "(3), "