WebGetOption Function

Action

Allows you to retrieve the values of the options that have been set with the function WebSetOption().

Note: The topic WebSetOption Function provides a list of all options that can be set.

Include file

WebAPI.bdh

Syntax

WebGetOption( in  nOption : number, 
              out uValue  : union ): boolean;

Return value

  • true if successful

  • false otherwise

Parameter Description
nOption Refer to WebSetOption Function for a list of all available options.
uValue Variable that receives the value of the selected option.

Example

dcltrans
  transaction TMain 
  var
    nSize: number;
  begin
    // enable link checking
    WebSetOption(WEB_OPT_LINK_CHECK, 1);
    WebPageUrl("http://purple/");
    //check history size
    WebGetOption(WEB_OPT_HISTORY_SIZE, nSize);
    Print(string(nSize));
  end TMain;