Return to CURLOPT_COOKIESESSION.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_COOKIESESSION.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 CURLOPT_COOKIESESSION 3 "May 05, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_COOKIESESSION \- start a new cookie session
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIESESSION, long init);
                     31: .SH DESCRIPTION
                     32: Pass a long set to 1 to mark this as a new cookie "session". It will force
                     33: libcurl to ignore all cookies it is about to load that are "session cookies"
                     34: from the previous session. By default, libcurl always stores and loads all
                     35: cookies, independent if they are session cookies or not. Session cookies are
                     36: cookies without expiry date and they are meant to be alive and existing for
                     37: this "session" only.
                     38: 
                     39: A "session" is usually defined in browser land for as long as you have your
                     40: browser up, more or less.
                     41: .SH DEFAULT
                     42: 0
                     43: .SH PROTOCOLS
                     44: HTTP
                     45: .SH EXAMPLE
                     46: .nf
                     47: CURL *curl = curl_easy_init();
                     48: if(curl) {
                     49:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
                     50: 
                     51:   /* new "session", don't load session cookies */
                     52:   curl_easy_setopt(curl, CURLOPT_COOKIESESSION, 1L);
                     53: 
                     54:   /* get the (non session) cookies from this file */
                     55:   curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "/tmp/cookies.txt");
                     56: 
                     57:   ret = curl_easy_perform(curl);
                     58: 
                     59:   curl_easy_cleanup(curl);
                     60: }
                     61: .fi
                     62: .SH AVAILABILITY
                     63: Along with HTTP
                     64: .SH RETURN VALUE
                     65: Returns CURLE_OK
                     66: .SH "SEE ALSO"
                     67: .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIE "(3), "