docs/libcurl/opts/CURLOPT_HTTPGET.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 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_HTTPGET 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_HTTPGET \- ask for a HTTP GET request
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPGET, long useget);
  30 .SH DESCRIPTION
  31 Pass a long. If \fIuseget\fP is 1, this forces the HTTP request to get back to
  32 using GET. Usable if a POST, HEAD, PUT, etc has been used previously using the
  33 same curl \fIhandle\fP.
  34
  35 When setting \fICURLOPT_HTTPGET(3)\fP to 1, it will automatically set
  36 \fICURLOPT_NOBODY(3)\fP to 0 and \fICURLOPT_UPLOAD(3)\fP to 0.
  37 .SH DEFAULT
  38 0
  39 .SH PROTOCOLS
  40 HTTP(S)
  41 .SH EXAMPLE
  42 .nf
  43 curl = curl_easy_init();
  44 if(curl) {
  45   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  46
  47   /* use a GET to fetch this */
  48   curl_easy_setopt(curl, CURLOPT_HTTPGET, 1L);
  49
  50   /* Perform the request */
  51   curl_easy_perform(curl);
  52 }
  53 .fi
  54 .SH AVAILABILITY
  55 Along with HTTP
  56 .SH RETURN VALUE
  57 Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  58 .SH "SEE ALSO"
  59 .BR CURLOPT_NOBODY "(3), " CURLOPT_UPLOAD "(3), "