| 123456789101112131415161718192021222324252627282930313233343536373839404142434445 |
- .\" generated by cd2nroff 0.1 from CURLOPT_USERAGENT.md
- .TH CURLOPT_USERAGENT 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_USERAGENT \- HTTP user\-agent header
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERAGENT, char *ua);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a null\-terminated string as parameter. It is used to set the
- User\-Agent: header field in the HTTP request sent to the remote server. You
- can also set any custom header with \fICURLOPT_HTTPHEADER(3)\fP.
- The application does not have to keep the string around after setting this
- option.
- .SH DEFAULT
- NULL, no User\-Agent: header is used.
- .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");
- curl_easy_setopt(curl, CURLOPT_USERAGENT, "Dark Secret Ninja/1.0");
- curl_easy_perform(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.1
- .SH RETURN VALUE
- Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLE_OUT_OF_MEMORY if there was insufficient heap space.
- .SH SEE ALSO
- .BR CURLOPT_CUSTOMREQUEST (3),
- .BR CURLOPT_HTTPHEADER (3),
- .BR CURLOPT_REFERER (3),
- .BR CURLOPT_REQUEST_TARGET (3)
|
