HTTP GET OPTION

Home

4D v16.3

HTTP GET OPTION


HTTP GET OPTION ( option ; value )

Parameter	Type	Description
option	Longint	Code of option to get
value	Longint	Current value of option

Description

The HTTP GET OPTION command returns the current value of the HTTP options (options used by client for next request triggered by the HTTP Get or HTTP Request commands). The current value of an option can be the default value or it can have been modified using the HTTP SET OPTION command.

Note: The options set are local to the current process. In a component, they are local to the component being executed.

In the option parameter, pass the number of the option whose value you want to get. You can use one of the following predefined constants, available in the HTTP Client theme:

Constant	Type	Value	Comment
HTTP compression	Longint	6	value = 0 (do not compress) or 1 (compress). Default value: 0 This option enables or disables the compression mechanism intended to accelerate exchanges for requests between the client and server. When this mechanism is enabled, the HTTP client uses deflate or gzip compression depending on the server response.
HTTP display auth dial	Longint	4	value = 0 (do not display dialogue box) or 1 (display dialogue box). Default value: 0 This option displays the authentication dialog box when the HTTP Get or HTTP Request command is executed. By default, this command never displays the dialog box and you must normally use the HTTP AUTHENTICATE command. However, if you want an authentication dialog box to appear so that users can enter their identifiers, then pass 1 in value. The dialog box only appears when the request requires authentication.
HTTP follow redirect	Longint	2	value = 0 (do not accept redirections) or 1 (accept redirections). Default value = 1
HTTP max redirect	Longint	3	value = Maximum number of redirections accepted Default value = 2
HTTP reset auth settings	Longint	5	value = 0 (do not delete information) or 1 (delete information). Default value: 0 This option indicates to 4D to reset the authentication information of the user (user name, password, method) after each execution of the HTTP Get or HTTP Request command in the same process. By default, this information is kept and reused for each request. Pass 1 in value to delete this information after each call. Note that regardless of the setting, this information is deleted when the process is killed.
HTTP timeout	Longint	1	value = timeout of client request, expressed in seconds. This timeout sets how long the HTTP client waits for the server to respond. After this period of time has passed, the client closes the session and the request is lost. By default, this timeout is 120 seconds. It can be changed because of specific characteristics (network state, request characteristics, etc.).

In the value parameter, pass a variable to receive the current value of the option.