Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_HTTPGET (3)

Name

CURLOPT_HTTPGET - ask for an HTTP GET request

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPGET, long useget);

Description

CURLOPT_HTTPGET(3)         curl_easy_setopt options         CURLOPT_HTTPGET(3)



NAME
       CURLOPT_HTTPGET - ask for an HTTP GET request

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPGET, long useget);

DESCRIPTION
       Pass  a  long. If useget is 1, this forces the HTTP request to get back
       to using GET. Usable if a POST, HEAD, PUT, etc has been used previously
       using the same curl handle.

       When  setting  CURLOPT_HTTPGET(3)  to 1, it will automatically set CUR-
       LOPT_NOBODY(3) to 0 and CURLOPT_UPLOAD(3) to 0.

       Setting this option to zero has no effect. Applications need to explic-
       itly  select  which  HTTP request method to use, they cannot deselect a
       method.   To   reset   a   handle   to   default    method,    consider
       curl_easy_reset(3).

DEFAULT
       0

PROTOCOLS
       HTTP(S)

EXAMPLE
       curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");

         /* use a GET to fetch this */
         curl_easy_setopt(curl, CURLOPT_HTTPGET, 1L);

         /* Perform the request */
         curl_easy_perform(curl);
       }

AVAILABILITY
       Along with HTTP

RETURN VALUE
       Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_NOBODY(3),          CURLOPT_UPLOAD(3),         CURLOPT_POST(3),
       curl_easy_reset(3)



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    17 Jun 2014               CURLOPT_HTTPGET(3)