Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

CURL.SetOptionUserAgent

The user agent text string.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
CURL 2.5 Yes Yes Yes Yes Yes

MBS( "CURL.SetOptionUserAgent"; Handle; Value { ; Encoding } )

Parameters

Parameter Description Example value
Handle The CURL session handle. $curl
Value The user agent string. "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0)"
Encoding Optional
The text encoding for text parameter.
Default is UTF-8.
Possible encoding names: ANSI, Arabic-Mac, Arabic-Win, Baltic-Win, CentralEurope-Mac, ChineseSimp-Mac, ChineseSimp-Win, ChineseTrad-Mac, ChineseTrad-Win, Cyrillic-Mac, Cyrillic-Win, EasternEurope-Win, Greek-Mac, Greek-Win, Hebrew-Mac, Hebrew-Win, ISO-8859-1, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, ISO-8859-15, Korean-Johab, Korean-Mac, Korean-Win, Latin1, Mac, Native, ShiftJIS-Mac, ShiftJIS-Win, Turkish-Mac, Turkish-Win, UTF-8, DOS or Windows. Pass native to use the native encoding of the current platform.
"UTF8"

Result

Returns "OK" on success.

Description

The user agent text string.
It will be used for 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 CURL.SetOptionHTTPHeader.

Examples

Set IE 6 user agent:

MBS( "CURL.SetOptionUserAgent"; $curl; "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0)" )

See also


CURL.SetOptionUseSSL   -   CURL.SetOptionUsername

Feedback: Report problem or ask question.




Links
MBS Xojo Plugins