3. curl::option

Call this function to set the various options of the actual curl session.

Usage:

curl::option CURL, "option" [, value]

The various options that the current version of the module supports are listed in the following sections. Note that the documentation is mainly copied from the original CURL lib documentation.

Some of the options require a string as a parameter. The strings usually should not contain zero character. The exception is the option POSTFIELDS, which is handled in a special way to allow the programmer to send arbitrary binary data as HTTP POST parameter.

The option names in the section titles in this document are followed by one of the words string, integer and flag.

• Options followed by the word string need string argument. If the option value is not specified zero length string is used. Because this is nonsense in most cases, you better use a third string argument for these options.
• Options followed by the word flag are yes/no type options. Presenting them without value means switching the option on. To switch such an option off the programmer has to explicitely specify zero value as third argument. In other words omitting the option value in such a case is the same as specifying 1 or TRUE or any other non-zero value. To switch off a flag option you can specify the value as FALSE (which is zero in ScriptBasic) for more readability.

  curl::option CURL,"VERBOSE"
  curl::option CURL,"VERBOSE",TRUE
  curl::option CURL,"VERBOSE",1
  

  are the same as well as the oposit

  curl::option CURL,"VERBOSE",FALSE
  curl::option CURL,"VERBOSE",0
  

  are the same.
• Options followed by the word integer accept integer value. If the value is missing for such an option zero is used. For example:

  curl::option CURL,"RESUME_FROM"
  curl::option CURL,"RESUME_FROM",0
  

  are the same.

The option names are implemented case sensitive in this module, thus you can not use "verbose" instead of "VERBOSE". Also the programmer should type the option names precisely, no mispelling is tolerated by the program.