docs/libcurl/opts/CURLOPT_COOKIESESSION.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_COOKIESESSION 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_COOKIESESSION \- start a new cookie session
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIESESSION, long init);
  30 .SH DESCRIPTION
  31 Pass a long set to 1 to mark this as a new cookie "session". It will force
  32 libcurl to ignore all cookies it is about to load that are "session cookies"
  33 from the previous session. By default, libcurl always stores and loads all
  34 cookies, independent if they are session cookies or not. Session cookies are
  35 cookies without expiry date and they are meant to be alive and existing for
  36 this "session" only.
  37
  38 A "session" is usually defined in browser land for as long as you have your
  39 browser up, more or less.
  40 .SH DEFAULT
  41 0
  42 .SH PROTOCOLS
  43 HTTP
  44 .SH EXAMPLE
  45 TODO
  46 .SH AVAILABILITY
  47 Along with HTTP
  48 .SH RETURN VALUE
  49 Returns CURLE_OK
  50 .SH "SEE ALSO"
  51 .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIE "(3), "