# GetParam function

Retrieves router processor configuration.

## Syntax

Delphi
C++

    function GetParam(
      St: DWORD;
      Value: Pointer;
      Size: DWORD;
      var outLength: DWORD
    ): Bool; stdcall;

    BOOL WINAPI GetParam(
      _In_   DWORD St,
      _Out_  LPVOID Value,
      _In_   DWORD Size,
      _Out_  DWORD *outLength
    );

## Parameters

St [in]

  The setting index, specifies a parameter to be retrieved.

  Value | Meaning
  --- | ---
  stEnableDebug 0 | Is debug logging enabled or disabled. Value will be a pointer to BOOL.
  stDebugVerbosity 1 | Logging verbosity level. Value will be a pointer to BYTE.
  stWriteLogCallback 2 | Pointer to the WriteLog callback procedure. Value will be a pointer to the procedure start address. NULL also can be returned if the callback function is not specified.
  stSetTableDataCallback 3 | Pointer to the SetTableData callback procedure. Value will be a pointer to the procedure start address. NULL also can be returned if the callback function is not specified.
  stUserAgent 4 | Default User-Agent string for HTTP client. Value will be a pointer to null-terminated string.
  stUseCustomPage 5 | Is custom page used for detection. Value will be a pointer to BOOL.
  stCustomPage 6 | Path to the custom detection page. Value will be a pointer to null-terminated string.
  stDualAuthCheck 7 | Is dual authentication checking enabled for Basic Authentication. Value will be a pointer to BOOL.
  stPairsBasic 8 | A string with Basic Authentication pairs. Each pair separated by \r\n chars and username separated from password by \t char. Value will be a pointer to null-terminated string.
  stPairsDigest 9 | A string with Digest Authentication pairs. Each pair separated by \r\n chars and username separated from password by \t char. Value will be a pointer to null-terminated string.
  stUseProxy 10 | Is proxy server usage enabled. Value will be a pointer to BOOL.
  stProxyIP 11 | Proxy server IP address. Value will be a pointer to null-terminated string.
  stProxyPort 12 | Proxy server port. Value will be a pointer to WORD.
  stUseCredentials 13 | Is custom authentication credentials used. Value will be a pointer to BOOL.
  stCredentialsUsername 14 | Custom authentication user name. Value will be a pointer to null-terminated string.
  stCredentialsPassword 15 | Custom authentication password. Value will be a pointer to null-terminated string.
  stReserved 16 | Reserved for future use.
  stFilterRules 17 | A string with filter rules. A filter rule consists of place, mode and check string. Possible places: "body" - response body. "serv" - server name. "relm" - realm name. Possible modes: "eq" - string is equal to check string. "neq" - string is not equal to check string. "cnt" - string contains check string. "ncnt" - string doesn't contain check string. Each rule separated by \r\n chars and the fields are separated by \t char. Value will be a pointer to null-terminated string.

Value [out]

  A pointer to the value buffer. The type depends on specified setting index.

Size [in]

  Buffer size before call, in bytes.

outLength [out]

  Required buffer size after call, in bytes.

## Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.