Return to CURLINFO_PRIVATE.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_PRIVATE.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2017, 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 "May 05, 2017" "libcurl 7.70.0" "curl_easy_getinfo options"
                     24: 
                     25: .SH NAME
                     26: CURLINFO_PRIVATE \- get the private pointer
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIVATE, char **private);
                     31: .SH DESCRIPTION
                     32: Pass a pointer to a char pointer to receive the pointer to the private data
                     33: associated with the curl handle (set with the \fICURLOPT_PRIVATE(3)\fP).
                     34: Please note that for internal reasons, the value is returned as a char
                     35: pointer, although effectively being a 'void *'.
                     36: .SH PROTOCOLS
                     37: All
                     38: .SH EXAMPLE
                     39: .nf
                     40: CURL *curl = curl_easy_init();
                     41: if(curl) {
                     42:   void *pointer = 0x2345454;
                     43:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
                     44: 
                     45:   /* set the private pointer */
                     46:   curl_easy_setopt(curl, CURLOPT_PRIVATE, pointer);
                     47:   ret = curl_easy_perform(curl);
                     48: 
                     49:   /* extract the private pointer again */
                     50:   ret = curl_easy_getinfo(curl, CURLINFO_PRIVATE, &pointer);
                     51: 
                     52:   curl_easy_cleanup(curl);
                     53: }
                     54: .fi
                     55: .SH AVAILABILITY
                     56: Added in 7.10.3
                     57: .SH RETURN VALUE
                     58: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     59: .SH "SEE ALSO"
                     60: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
                     61: .BR CURLOPT_PRIVATE "(3), "