A subsidiary class to specify an object with options. More...

#include <SQLAPI.h>

Inherited by SACommand, SAConnection, SAField, SAParam, and SAPI.

Public Member Functions

 SAOptions ()
 Defaut constructor.
 
virtual SAStringsetOption (const SAString &sOptionName)
 Sets a string value of a specific option. More...
 
virtual SAString Option (const SAString &sOptionName) const
 Returns a string value of a specific option.
 
virtual int TotalOptions () const
 Returns the count of options.
 
virtual SAString OptionName (int nIndex) const
 Returns the string value of an option.
 

Detailed Description

A subsidiary class to specify an object with options.

Member Function Documentation

◆ setOption()

SAString & SAOptions::setOption ( const SAString sOptionName)
virtual

Sets a string value of a specific option.

Parameters
sOptionNameA string key of the option.
Remarks
Call this method to set value(s) of server specific API, connection, command, parameter o field options. See Server Specific Guide for available options description.
If an option is not specified in SQLAPI object, the Library takes the default option value.
setOption method is safe to use in cross-server applications. An option related to a particular server does not affect others.