RHTTP_SET_DEFAULT Function

Sets a web service interface default by specifying a parameter/value pair. Returns an error string (empty if no error).

As an alternative to many individual function calls, all parameters can be set in a defaults file which is identified in a single call. This simplifies deployment as it requires changing a single file rather than the DataBasic source code.

Syntax

RHTTP_SET_DEFAULT(parameter, value)

Syntax elements

The following table shows the permitted parameter names and the corresponding expected values.

Parameter

Value

proxy-server

DNS name or IP address of a proxy server.

proxy-port

Port number of a proxy server (defaults to 80).

proxy-user

User name to be used on the proxy server (if required).

proxy-password

Password to be used on the proxy server (if required).

version

HTTP version number — either 1.0 (the default) or 1.1.

protocol-log

File name of protocol log. See also note below.

no-translate

Set to 1 to suppress newline to attribute mark translation in retrieved document.

https

Set to 1 to enable encryption on all connections.

timeout

Timeout to be used when waiting for a response (in minutes).

defaults-file

Name of a file to load defaults from. The item is HTTP-DEFAULTS. Each attribute must be of the form parameter=value (that is, with no spaces around the equals sign).

Setting proxy-server to an empty string disables the use of a proxy server (this is the default setting).

Setting protocol-log to an empty string disables logging (this is the default setting).

Note

A protocol-log should only be used for testing and should be disabled in a live environment unless problems are being investigated. When it is set, large amounts of data are returned to the log file, which will quickly have a detrimental effect on your system.