docs/libcurl/opts/CURLOPT_OPENSOCKETDATA.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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_OPENSOCKETDATA 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_OPENSOCKETDATA \- custom pointer passed to open socket callback
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_OPENSOCKETDATA, void *pointer);
  30 .SH DESCRIPTION
  31 Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first
  32 argument in the opensocket callback set with \fICURLOPT_OPENSOCKETFUNCTION(3)\fP.
  33 .SH DEFAULT
  34 The default value of this parameter is NULL.
  35 .SH PROTOCOLS
  36 All
  37 .SH EXAMPLE
  38 TODO
  39 .SH AVAILABILITY
  40 Added in 7.17.1
  41 .SH RETURN VALUE
  42 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  43 .SH "SEE ALSO"
  44 .BR CURLOPT_OPENSOCKETFUNCTION "(3), " CURLOPT_SOCKOPTFUNCTION "(3), "