docs/libcurl/opts/CURLINFO_PRIVATE.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 CURLINFO_PRIVATE 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24 .SH NAME
  25 CURLINFO_PRIVATE \- get the private pointer
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIVATE, char **private);
  30 .SH DESCRIPTION
  31 Pass a pointer to a char pointer to receive the pointer to the private data
  32 associated with the curl handle (set with the \fICURLOPT_PRIVATE(3)\fP).
  33 Please note that for internal reasons, the value is returned as a char
  34 pointer, although effectively being a 'void *'.
  35 .SH PROTOCOLS
  36 All
  37 .SH EXAMPLE
  38 TODO
  39 .SH AVAILABILITY
  40 Added in 7.10.3
  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 curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  45 .BR CURLOPT_PRIVATE "(3), "