company logo

Client :: serverOption - Get value for server option

The function returns the value for an option set in the server environment (server options). Server options are either defined in the server configuration or ini-file.

Server options set by calling setServerOption() belong to the client, i.e. besides common server options (ini-file options) each client has its own set of server options, which are not shared with other clients.

Return value:  Option value ( odaba::String & )

The option value contains the value set (or to be set) for an option.

In order to pass no option value, an empty string ( String() ) has to be passed.

Implementation details

odaba::String Client  :: serverOption ( odaba::String &sOptionName )

The function returns the option value for the server option passed in sOptionName., which is either a common or a client specific server option name.

  • sOptionName - Option name

    The name refers to an option set on the server or client side. Option names may be defined simply as an identifier (main option) or as an option hierarchy path when the option is defined on a lower level of the option hierarchy.

    Option names are NOT case sensitive.

      TRACE - main option

      DATA.Dictionary - Dictionary option in DATA section

      DATA.Database.path - Database path in a Database sub section od the DATA section