manpagez: man pages & more
man CURLOPT_HTTPGET(3)
Home | html | info | man
CURLOPT_HTTPGET(3)         Library Functions Manual         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, libcurl automatically sets
       CURLOPT_NOBODY(3) to 0 and CURLOPT_UPLOAD(3) to 0.

       Setting this option to zero has no effect. Applications need to
       explicitly 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

       This functionality affects http only


EXAMPLE

       int main(void)
       {
         CURL *curl = curl_easy_init();
         if(curl) {
           curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

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

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


AVAILABILITY

       Added in curl 7.8.1


RETURN VALUE

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


SEE ALSO

       CURLOPT_NOBODY(3), CURLOPT_POST(3), CURLOPT_UPLOAD(3),
       curl_easy_reset(3)

libcurl                           2024-08-05                CURLOPT_HTTPGET(3)

curl 8.9.1 - Generated Tue Aug 13 18:20:39 CDT 2024
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.