| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 |
- .\" generated by cd2nroff 0.1 from CURLOPT_HTTPGET.md
- .TH CURLOPT_HTTPGET 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_HTTPGET \- ask for an HTTP GET request
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPGET, long useget);
- .fi
- .SH DESCRIPTION
- Pass a long. If \fIuseget\fP 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 \fIhandle\fP.
- When setting \fICURLOPT_HTTPGET(3)\fP to 1, libcurl automatically sets
- \fICURLOPT_NOBODY(3)\fP to 0 and \fICURLOPT_UPLOAD(3)\fP 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 \fIcurl_easy_reset(3)\fP.
- .SH DEFAULT
- 0
- .SH PROTOCOLS
- This functionality affects http only
- .SH EXAMPLE
- .nf
- 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);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.8.1
- .SH RETURN VALUE
- Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR CURLOPT_NOBODY (3),
- .BR CURLOPT_POST (3),
- .BR CURLOPT_UPLOAD (3),
- .BR curl_easy_reset (3)
|
