Return to CURLOPT_PRIVATE.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PRIVATE.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2020, 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 CURLOPT_PRIVATE 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_PRIVATE \- store a private pointer
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRIVATE, void *pointer);
        !            31: .SH DESCRIPTION
        !            32: Pass a void * as parameter, pointing to data that should be associated with
        !            33: this curl handle.  The pointer can subsequently be retrieved using
        !            34: \fIcurl_easy_getinfo(3)\fP with the CURLINFO_PRIVATE option. libcurl itself
        !            35: never does anything with this data.
        !            36: .SH DEFAULT
        !            37: NULL
        !            38: .SH PROTOCOLS
        !            39: All
        !            40: .SH EXAMPLE
        !            41: .nf
        !            42: CURL *curl = curl_easy_init();
        !            43: struct private secrets;
        !            44: if(curl) {
        !            45:   struct private *extracted;
        !            46:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
        !            47: 
        !            48:   /* store a pointer to our private struct */
        !            49:   curl_easy_setopt(curl, CURLOPT_PRIVATE, &secrets);
        !            50: 
        !            51:   curl_easy_perform(curl);
        !            52: 
        !            53:   /* we can extract the private pointer again too */
        !            54:   curl_easy_getinfo(curl, CURLINFO_PRIVATE, &extracted);
        !            55: }
        !            56: .fi
        !            57: .SH AVAILABILITY
        !            58: Added in 7.10.3
        !            59: .SH RETURN VALUE
        !            60: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
        !            61: .SH "SEE ALSO"
        !            62: .BR CURLOPT_VERBOSE "(3), " CURLOPT_STDERR "(3), "