CURLOPT_USERAGENT man page

CURLOPT_USERAGENT — set HTTP user-agent header

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERAGENT, char *ua);

Description

Pass a pointer to a zero terminated string as parameter. It will be used to set the User-Agent: header in the HTTP request sent to the remote server. This can be used to fool servers or scripts. You can also set any custom header with CURLOPT_HTTPHEADER(3).

Default

NULL, no User-Agent: header is used by default.

Protocols

HTTP, HTTPS

Example

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

  curl_easy_setopt(curl, CURLOPT_USERAGENT, "Dark Secret Ninja/1.0");

  curl_easy_perform(curl);
}

Availability

As long as HTTP is supported

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.

See Also

CURLOPT_REFERER(3), CURLOPT_HTTPHEADER(3),

Referenced By

curl_easy_setopt(3), CURLOPT_HTTPHEADER(3), CURLOPT_REFERER(3), libcurl-tutorial(3).

17 Jun 2014 libcurl 7.37.0 curl_easy_setopt options