\documentclass{article}
\usepackage{docxx}
\begin{document}
\pagebreak
\sloppy
\begin{cxxContents}
\cxxContentsEntry{1}{sqlxx}{}
\cxxContentsEntry{2}{CSQLResult::\cxxtilde CSQLResult}{SQL Result Destructor.}
\cxxContentsEntry{3}{CSQLResult::close}{Closes database connection.}
\cxxContentsEntry{4}{CSQLResult::getError}{Returns last error message.}
\cxxContentsEntry{5}{CSQLResult::query}{Query Database.}
\cxxContentsEntry{6}{CSQLResult::getNumCols}{Return number of columns.}
\cxxContentsEntry{7}{CSQLResult::getNumRows}{Return number of rows.}
\cxxContentsEntry{8}{CSQLResult::getColName}{Returns column name.}
\cxxContentsEntry{9}{CSQLResult::getColType}{Returns column type.}
\cxxContentsEntry{10}{CSQLResult::fetch}{Fetch a row of data.}
\cxxContentsEntry{11}{CSQLResult::get}{Returns column value as string.}
\cxxContentsEntry{12}{CSQLResult::get}{Returns column value as string.}
\cxxContentsEntry{13}{CSQLResult::getInt}{Returns column value as long integer.}
\cxxContentsEntry{14}{CSQLResult::getInt}{Returns column value as long integer.}
\cxxContentsEntry{15}{CSQLResult::getFloat}{Returns column value as float.}
\cxxContentsEntry{16}{CSQLResult::getFloat}{Returns column value as float.}
\cxxContentsEntry{17}{CSQLResult::isNull}{Determine if column value is NULL.}
\cxxContentsEntry{18}{CSQLResult::isNull}{Determine if column value is NULL.}
\cxxContentsEntry{19}{CSQL::CSQL}{SQL Constructor.}
\cxxContentsEntry{20}{CSQL::\cxxtilde CSQL}{SQL Destructor.}
\cxxContentsEntry{21}{CSQL::getError}{Get last error message.}
\cxxContentsEntry{22}{CSQL::addResult}{Connects a CSQLResult to this CSQL object.}
\cxxContentsEntry{23}{CSQL::delResult}{Disconnects a CSQLResult from this CSQL object.}
\cxxContentsEntry{24}{CSQL::setDSN}{Sets DSN.}
\cxxContentsEntry{25}{CSQL::setHostname}{Sets Hostname.}
\cxxContentsEntry{26}{CSQL::setSocket}{Sets Socket.}
\cxxContentsEntry{27}{CSQL::setPort}{Sets Port.}
\cxxContentsEntry{28}{CSQL::setPort}{Sets Port.}
\cxxContentsEntry{29}{CSQL::setDatabase}{Sets database name.}
\cxxContentsEntry{30}{CSQL::setDriver}{Sets ODBC driver.}
\cxxContentsEntry{31}{CSQL::setUsername}{Sets database username.}
\cxxContentsEntry{32}{CSQL::setPassword}{Sets database password.}
\cxxContentsEntry{33}{CSQL::setOptions}{Sets database options.}
\cxxContentsEntry{34}{CSQL::setType}{Sets database type.}
\cxxContentsEntry{35}{CSQL::getDSN}{Returns DSN.}
\cxxContentsEntry{36}{CSQL::getHostname}{Returns Hostname.}
\cxxContentsEntry{37}{CSQL::getSocket}{Returns Socket.}
\cxxContentsEntry{38}{CSQL::getPort}{Returns Port.}
\cxxContentsEntry{39}{CSQL::getPortN}{Returns Port.}
\cxxContentsEntry{40}{CSQL::getDatabase}{Returns database name.}
\cxxContentsEntry{41}{CSQL::getDriver}{Returns ODBC driver.}
\cxxContentsEntry{42}{CSQL::getUsername}{Returns database username.}
\cxxContentsEntry{43}{CSQL::getPassword}{Returns database password.}
\cxxContentsEntry{44}{CSQL::getOptions}{Returns ODBC options.}
\cxxContentsEntry{45}{CSQL::getType}{Returns database type.}
\cxxContentsEntry{46}{CSQL::connect}{Connect to database.}
\cxxContentsEntry{47}{CSQL::disconnect}{Disconnects from database.}
\cxxContentsEntry{48}{CSQL::isConnected}{Determine if connected.}
\cxxContentsEntry{49}{CSQL::openQuery}{Opens an SQL Query.}
\cxxContentsEntry{50}{CSQL::execQuery}{Execute SQL query.}
\cxxContentsEntry{51}{CSQL::closeQuery}{Closes SQL query.}
\cxxContentsEntry{52}{CSQL::getNewID}{Returns next available Primary key.}
\cxxContentsEntry{53}{CSQL::getQueries}{Returns vector with active queries.}
\cxxContentsEntry{54}{CSQL::countQueries}{Count active queries.}
\cxxContentsEntry{55}{quote}{Quotes a string.}
\end{cxxContents}
\begin{cxxentry}
{}
        {sqlxx}
        {}
        {}
        {1}
\cxxAuthor{
Klaus Reimer $<$k@ailis.de$>$\strut}
\cxxVersion{
2.1.0
\strut}
\begin{cxxdoc}
This library contains C++ classes for easy database access via ODBC using
libiodbc2 or via native access. Currently the native access to mysql and
postgresql databases is implemented.

\end{cxxdoc}
\end{cxxentry}
\begin{cxxfunction}
{}
        {CSQLResult::\cxxtilde CSQLResult}
        {(void)}
        {SQL Result Destructor.}
        {2}
\begin{cxxdoc}
SQL Result Destructor.
This is the destructor of the SQL Result. It calls CSQL::close() to
close the database connection.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQLResult::close}
        {(void)}
        {Closes database connection.}
        {3}
\begin{cxxdoc}
Closes database connection.
This method closes the database connection and frees all allocated
memory.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQLResult::getError}
        {(void)}
        {Returns last error message.}
        {4}
\begin{cxxdoc}
Returns last error message.
This method returns the last error message of the SQL Result.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQLResult::query}
        {(const\ string\ \&sQuery)}
        {Query Database.}
        {5}
\begin{cxxdoc}
Query Database.
This method sends the SQL query {\bf sQuery} to the database.  You
don't need to use this method on your own. Use CSQL::openQuery()
instead.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{unsigned\ int}
        {CSQLResult::getNumCols}
        {(void)}
        {Return number of columns.}
        {6}
\begin{cxxdoc}
Return number of columns.
This method returns the number of columns of the current SQL Result.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{unsigned\ long}
        {CSQLResult::getNumRows}
        {(void)}
        {Return number of rows.}
        {7}
\begin{cxxdoc}
Return number of rows.
This method returns the number of rows of the current SQL Result.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQLResult::getColName}
        {(const\ unsigned\ int\ iIndex)}
        {Returns column name.}
        {8}
\begin{cxxdoc}
Returns column name.
Return the name of the column with the index {\bf iIndex}.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{int}
        {CSQLResult::getColType}
        {(const\ unsigned\ int\ iIndex)}
        {Returns column type.}
        {9}
\begin{cxxdoc}
Returns column type.
Returns the type of the column with index {\bf iIndex}.
The meaning of the type is database dependent.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{bool}
        {CSQLResult::fetch}
        {(void)}
        {Fetch a row of data.}
        {10}
\begin{cxxdoc}
Fetch a row of data.
This method fetches a row of data from the current SQL Result.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQLResult::get}
        {(const\ unsigned\ int\ iIndex)}
        {Returns column value as string.}
        {11}
\begin{cxxdoc}
Returns column value as string.
Returns the value of the column with index {\bf iIndex} as string.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQLResult::get}
        {(const\ string\ sField)}
        {Returns column value as string.}
        {12}
\begin{cxxdoc}
Returns column value as string.
Returns the value of the column named {\bf sField} as string.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{long}
        {CSQLResult::getInt}
        {(const\ unsigned\ int\ iIndex)}
        {Returns column value as long integer.}
        {13}
\begin{cxxdoc}
Returns column value as long integer.
Returns the value of the column with index {\bf iIndex} as long integer.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{long}
        {CSQLResult::getInt}
        {(const\ string\ sField)}
        {Returns column value as long integer.}
        {14}
\begin{cxxdoc}
Returns column value as long integer.
Returns the value of the column named {\bf sField} as long integer.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{float}
        {CSQLResult::getFloat}
        {(const\ unsigned\ int\ iIndex)}
        {Returns column value as float.}
        {15}
\begin{cxxdoc}
Returns column value as float.
Returns the value of the column with index {\bf iIndex} as long float.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{float}
        {CSQLResult::getFloat}
        {(const\ string\ sField)}
        {Returns column value as float.}
        {16}
\begin{cxxdoc}
Returns column value as float.
Returns the value of the column named {\bf sField} as long float.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{bool}
        {CSQLResult::isNull}
        {(const\ unsigned\ int\ iIndex)}
        {Determine if column value is NULL.}
        {17}
\begin{cxxdoc}
Determine if column value is NULL.
Returns true if the value of the column with index {\bf iIndex} is NULL.
Returns false if not.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{bool}
        {CSQLResult::isNull}
        {(const\ string\ sField)}
        {Determine if column value is NULL.}
        {18}
\begin{cxxdoc}
Determine if column value is NULL.
Returns true if the value of the column named {\bf sField} is NULL.
Returns false if not.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{}
        {CSQL::CSQL}
        {(void)}
        {SQL Constructor.}
        {19}
\begin{cxxdoc}
SQL Constructor.
This is the constructor of the class CSQL. It initializes the SQL
object with empty values.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{}
        {CSQL::\cxxtilde CSQL}
        {(void)}
        {SQL Destructor.}
        {20}
\begin{cxxdoc}
SQL Destructor.
This is the destructor of the CSQL class. It automatically disconnects
all open database connections and frees all allocated memories of all
connected CSQLResult objects.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQL::getError}
        {(void*\ Result)}
        {Get last error message.}
        {21}
\begin{cxxdoc}
Get last error message.
This method returns the last error message. If no parameter is given the
last database related error message is returned. If a Pointer to a CSQLResult 
object is specified, the last error message of this SQLResult-Object is
returned.
Don't use this method if possible. Catch the sqlxx\_error exceptions which
already contains the complete error message. 
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::addResult}
        {(CSQLResult*\ Result)}
        {Connects a CSQLResult to this CSQL object.}
        {22}
\begin{cxxdoc}
Connects a CSQLResult to this CSQL object.
This method is used internally to connect a CSQLResult object to this
CSQL object. THe connected CSQLResult objects are freed automatically
by the CSQL destructor.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::delResult}
        {(CSQLResult*\ Result)}
        {Disconnects a CSQLResult from this CSQL object.}
        {23}
\begin{cxxdoc}
Disconnects a CSQLResult from this CSQL object.
This method is used internally to disconnect a CSQLResult object from 
this CSQL object. THe connected CSQLResult objects are freed 
automatically by the CSQL destructor.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::setDSN}
        {(const\ string\ \&sNewDSN)}
        {Sets DSN.}
        {24}
\begin{cxxdoc}
Sets DSN.
Sets the DSN to {\bf sNewDSN}. The DSN is only used by ODBC connections.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::setHostname}
        {(const\ string\ \&sNewHostname)}
        {Sets Hostname.}
        {25}
\begin{cxxdoc}
Sets Hostname.
Sets Hostname to {\bf sNewHostname}.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::setSocket}
        {(const\ string\ \&sNewSocket)}
        {Sets Socket.}
        {26}
\begin{cxxdoc}
Sets Socket.
Sets Socket to {\bf sNewSocket}.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::setPort}
        {(const\ string\ \&sNewPort)}
        {Sets Port.}
        {27}
\begin{cxxdoc}
Sets Port.
Sets Ports to {\bf sNewPort}. Use this method if you want to
specify the port address as a string.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::setPort}
        {(const\ unsigned\ int\ iNewPort)}
        {Sets Port.}
        {28}
\begin{cxxdoc}
Sets Port.
Sets Ports to {\bf sNewPort}. Use this method if you want to
specify the port address as an integer.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::setDatabase}
        {(const\ string\ \&sNewDatabase)}
        {Sets database name.}
        {29}
\begin{cxxdoc}
Sets database name.
Sets database name to {\bf sNewDatabase}.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::setDriver}
        {(const\ string\ \&sNewDriver)}
        {Sets ODBC driver.}
        {30}
\begin{cxxdoc}
Sets ODBC driver.
Sets odbc driver to {\bf sNewDriver}. This value is only used for
ODBC connections
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::setUsername}
        {(const\ string\ \&sNewUsername)}
        {Sets database username.}
        {31}
\begin{cxxdoc}
Sets database username.
Sets database username to {\bf sNewUsername}.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::setPassword}
        {(const\ string\ \&sNewPassword)}
        {Sets database password.}
        {32}
\begin{cxxdoc}
Sets database password.
Sets database password to {\bf sNewPassword}.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::setOptions}
        {(const\ string\ \&sNewOptions)}
        {Sets database options.}
        {33}
\begin{cxxdoc}
Sets database options.
Sets database options to {\bf sNewOptions}. These options are only
used by ODBC connections. Your ODBC driver documentation will tell you
what options are possible.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::setType}
        {(const\ unsigned\ short\ iNewType)}
        {Sets database type.}
        {34}
\begin{cxxdoc}
Sets database type.
Sets database type to {\bf iNewType}. This can be SQLXX\_MYSQL, 
SQLXX\_POSTGRES or SQLXX\_ODBC. But this is dependent on how you have
compiled the sqlxx library.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQL::getDSN}
        {(void)}
        {Returns DSN.}
        {35}
\begin{cxxdoc}
Returns DSN.
Returns the DSN.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQL::getHostname}
        {(void)}
        {Returns Hostname.}
        {36}
\begin{cxxdoc}
Returns Hostname.
Returns the Hostname.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQL::getSocket}
        {(void)}
        {Returns Socket.}
        {37}
\begin{cxxdoc}
Returns Socket.
Returns the Socket.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQL::getPort}
        {(void)}
        {Returns Port.}
        {38}
\begin{cxxdoc}
Returns Port.
Returns the port address as string.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{unsigned\ int}
        {CSQL::getPortN}
        {(void)}
        {Returns Port.}
        {39}
\begin{cxxdoc}
Returns Port.
Returns the port address as unsigned integer.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQL::getDatabase}
        {(void)}
        {Returns database name.}
        {40}
\begin{cxxdoc}
Returns database name.
Returns the database name.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQL::getDriver}
        {(void)}
        {Returns ODBC driver.}
        {41}
\begin{cxxdoc}
Returns ODBC driver.
Returns the filename to the ODBC driver.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQL::getUsername}
        {(void)}
        {Returns database username.}
        {42}
\begin{cxxdoc}
Returns database username.
Returns the database username.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQL::getPassword}
        {(void)}
        {Returns database password.}
        {43}
\begin{cxxdoc}
Returns database password.
Returns the database password.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {CSQL::getOptions}
        {(void)}
        {Returns ODBC options.}
        {44}
\begin{cxxdoc}
Returns ODBC options.
Returns the ODBC options.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{unsigned\ short}
        {CSQL::getType}
        {(void)}
        {Returns database type.}
        {45}
\begin{cxxdoc}
Returns database type.
Returns the database type.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::connect}
        {(void)}
        {Connect to database.}
        {46}
\begin{cxxdoc}
Connect to database.
This method inititates the connection to the database.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::disconnect}
        {(void)}
        {Disconnects from database.}
        {47}
\begin{cxxdoc}
Disconnects from database.
This methode closes the connection to the database.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{bool}
        {CSQL::isConnected}
        {(void)}
        {Determine if connected.}
        {48}
\begin{cxxdoc}
Determine if connected.
This method returns true if the database connection is established.
False if not.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{CSQLResult*}
        {CSQL::openQuery}
        {(const\ string\ \&sQuery,\ const\ int\ iBufferSize)}
        {Opens an SQL Query.}
        {49}
\begin{cxxdoc}
Opens an SQL Query.
This method opens a new SQL query {\bf sQuery} and returns a pointer to
a CSQLResult object.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::execQuery}
        {(const\ string\ \&sQuery)}
        {Execute SQL query.}
        {50}
\begin{cxxdoc}
Execute SQL query.
This method executes the SQL query {\bf sQuery}.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{void}
        {CSQL::closeQuery}
        {(const\ CSQLResult*\ DBResult)}
        {Closes SQL query.}
        {51}
\begin{cxxdoc}
Closes SQL query.
Closes the SQL query {\bf DBResult}.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{long}
        {CSQL::getNewID}
        {(const\ string\ \&sTable,\ const\ string\ \&sIDField)}
        {Returns next available Primary key.}
        {52}
\begin{cxxdoc}
Returns next available Primary key.
This method returns the next available primary key value for the field
{\bf sIDField} in table {\bf sTable}
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{vector\<\ CSQLResult\ *\ \>\ \&}
        {CSQL::getQueries}
        {(void)}
        {Returns vector with active queries.}
        {53}
\begin{cxxdoc}
Returns vector with active queries.
This method returns a vector with pointers to all active queries of 
this CSQL object.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{int}
        {CSQL::countQueries}
        {(void)}
        {Count active queries.}
        {54}
\begin{cxxdoc}
Count active queries.
Returns the number of active SQL queries of this CSQL object.
\end{cxxdoc}
\end{cxxfunction}
\begin{cxxfunction}
{string}
        {quote}
        {(const\ string\ \&sSource,\ const\ bool\ bEscape8Bit,\ const\ string\ \&sEscape)}
        {Quotes a string.}
        {55}
\begin{cxxdoc}
Quotes a string.
Quotes the string sSource and returns this new quoted string.  This
method uses the addSlashes function of the strutilsxx library so there
are another two optional parameters: bEscape8Bit, sEscape. They are
relayed to the addSlashes function and are explained in the strutilsxx
documentation.
\end{cxxdoc}
\end{cxxfunction}
\end{document}
