docs/libcurl/opts/CURLINFO_SCHEME.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2016, 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_SCHEME 3 "23 November 2016" "libcurl 7.52.0" "curl_easy_getinfo options"
  24 .SH NAME
  25 CURLINFO_SCHEME \- get the URL scheme (sometimes called protocol) used in the connection
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SCHEME, long *p);
  30 .SH DESCRIPTION
  31 Pass a pointer to a char pointer to receive the pointer to a zero-terminated
  32 string holding the URL scheme used for the most recent connection done with this
  33 \fBcurl\fP handle.
  34
  35 The \fBid\fP pointer will be NULL or pointing to private read-only memory you
  36 MUST NOT free or modify.
  37 .SH PROTOCOLS
  38 All
  39 .SH EXAMPLE
  40 .nf
  41 CURL *curl = curl_easy_init();
  42 if(curl) {
  43   CURLcode res;
  44   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  45   res = curl_easy_perform(curl);
  46   if(res == CURLE_OK) {
  47     char * scheme;
  48     curl_easy_getinfo(curl, CURLINFO_SCHEME, &scheme);
  49   }
  50   curl_easy_cleanup(curl);
  51 }
  52 .fi
  53 .SH AVAILABILITY
  54 Added in 7.52.0
  55 .SH RETURN VALUE
  56 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  57 .SH "SEE ALSO"
  58 .BR CURLINFO_RESPONSE_CODE "(3), "
  59 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "