Blame view

3rdparty/curl/share/man/man3/CURLOPT_COOKIESESSION.3 2.4 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
  .\" *
  .\" * This software is licensed as described in the file COPYING, which
  .\" * you should have received as part of this distribution. The terms
  .\" * are also available at https://curl.se/docs/copyright.html.
  .\" *
  .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  .\" * copies of the Software, and permit persons to whom the Software is
  .\" * furnished to do so, under the terms of the COPYING file.
  .\" *
  .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  .\" * KIND, either express or implied.
  .\" *
  .\" **************************************************************************
  .\"
  .TH CURLOPT_COOKIESESSION 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_COOKIESESSION \- start a new cookie session
  .SH SYNOPSIS
  #include <curl/curl.h>
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIESESSION, long init);
  .SH DESCRIPTION
  Pass a long set to 1 to mark this as a new cookie "session". It will force
  libcurl to ignore all cookies it is about to load that are "session cookies"
  from the previous session. By default, libcurl always stores and loads all
  cookies, independent if they are session cookies or not. Session cookies are
  cookies without expiry date and they are meant to be alive and existing for
  this "session" only.
  
  A "session" is usually defined in browser land for as long as you have your
  browser up, more or less.
  .SH DEFAULT
  0
  .SH PROTOCOLS
  HTTP
  .SH EXAMPLE
  .nf
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
  
    /* new "session", don't load session cookies */
    curl_easy_setopt(curl, CURLOPT_COOKIESESSION, 1L);
  
    /* get the (non session) cookies from this file */
    curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "/tmp/cookies.txt");
  
    ret = curl_easy_perform(curl);
  
    curl_easy_cleanup(curl);
  }
  .fi
  .SH AVAILABILITY
  Along with HTTP
  .SH RETURN VALUE
  Returns CURLE_OK
  .SH "SEE ALSO"
  .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIE "(3), "