X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/32d77178d821841cd65fea27b1057ff929ffdee1..9154d8cfff9f6a58ccec94bf242086e7e10ea91b:/docs/latex/wx/db.tex

diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex
index 49b27cd225..3a57b24521 100644
--- a/docs/latex/wx/db.tex
+++ b/docs/latex/wx/db.tex
@@ -6,6 +6,9 @@ database connection allows function to be performed directly on the
 datasource, as well as allowing access to any tables/views defined in
 the datasource to which the user has sufficient privileges.
 
+See the \helpref{database classes overview}{odbcoverview} for
+an introduction to using the ODBC classes.
+
 \wxheading{Include files}
 
 <wx/db.h>
@@ -81,7 +84,6 @@ These are the databases currently tested and working with the ODBC classes.  A c
 
 See the remarks in \helpref{wxDb::Dbms}{wxdbdbms} for exceptions/issues with each of these database engines.
 
-
 \wxheading{Public member variables}
 
 \docparam{SWORD {\bf wxDb::cbErrorMsg}}{This member variable is populated as a result of calling \helpref{wxDb::GetNextError}{wxdbgetnexterror}.  Contains the count of bytes in the wxDb::errorMsg string.}
@@ -267,6 +269,46 @@ both types of cursors.
 
 The following functions are used in conjunction with the wxDb class.
 
+\func{void}{wxDbCloseConnections}{\void}
+
+\wxheading{Remarks}
+
+Closes all cached connections that have been made through use of the 
+\helpref{wxDbGetConnection}{wxdbfunctions} function.  
+
+NOTE: These connections are closed regardless of whether they are in use 
+or not.  This function should only be called after the program has 
+finished using the connections and all wxDbTable instances that use any of 
+the connections have been closed.
+
+This function performs a \helpref{wxDb::CommitTrans}{wxdbcommittrans} 
+on the connection before closing it to commit any changes that are still 
+pending, as well as to avoid any function sequence errors upon closing 
+each connection.
+
+
+\func{int }{wxDbConnectionsInUse}{\void}
+
+\wxheading{Remarks}
+
+Returns a count of how many database connections are currently free ( not 
+being used) that have been cached through use of the \helpref{wxDbGetConnection}{wxdbfunctions} 
+function.
+
+
+\func{bool}{wxDbFreeConnection}{\param{wxDb *}{pDb}}
+
+\wxheading{Remarks}
+
+Searches the list of cached database connections connection for one matching 
+the passed in wxDb instance.  If found, that cached connection is freed.
+
+Freeing a connection means that it is marked as available (free) in the 
+cache of connections, so that a call to \helpref{wxDbGetConnection}{wxdbfunctions} 
+is able to return a pointer to the wxDb instance for use.  Freeing a 
+connection does NOT close the connection, it only makes the connection 
+available again.
+ 
 
 \func{wxDb *}{wxDbGetConnection}{\param{wxDbConnectInf *}{pDbConfig}, 
 \param{bool }{FwdOnlyCursors=(bool)wxODBC\_FWD\_ONLY\_CURSORS}}
@@ -310,54 +352,17 @@ When exiting the program, call wxDbCloseConnections() to close all the
 cached connections created by calls to wxDbGetConnection().
 
 
-\func{bool}{wxDbFreeConnection}{\param{wxDb *}{pDb}}
-
-\wxheading{Remarks}
-
-Searches the list of cached database connections connection for one matching 
-the passed in wxDb instance.  If found, that cached connection is freed.
-
-Freeing a connection means that it is marked as available (free) in the 
-cache of connections, so that a call to \helpref{wxDbGetConnection}{wxdbfunctions} 
-is able to return a pointer to the wxDb instance for use.  Freeing a 
-connection does NOT close the connection, it only makes the connection 
-available again.
- 
-
-\func{void}{wxDbCloseConnections}{\void}
-
-\wxheading{Remarks}
-
-Closes all cached connections that have been made through use of the 
-\helpref{wxDbGetConnection}{wxdbfunctions} function.  
-
-NOTE: These connections are closed regardless of whether they are in use 
-or not.  This function should only be called after the program has 
-finished using the connections and all wxDbTable instances that use any of 
-the connections have been closed.
-
-This function performs a \helpref{wxDb::CommitTrans}{wxdbcommittrans} 
-on the connection before closing it to commit any changes that are still 
-pending, as well as to avoid any function sequence errors upon closing 
-each connection.
-
-
-\func{int }{wxDbConnectionsInUse}{\void}
-
-\wxheading{Remarks}
-
-Returns a count of how many database connections are currently free ( not 
-being used) that have been cached through use of the \helpref{wxDbGetConnection}{wxdbfunctions} 
-function.
+\func{const wxChar *}{wxDbLogExtendedErrorMsg}{\param{const wxChar *}{userText}, \param{wxDb *}{pDb}, \param{wxChar *}{ErrFile}, \param{int }{ErrLine}}
 
+Writes a message to the wxLog window (stdout usually) when an internal 
+error situation occurs.  This function only works in DEBUG builds
 
-\func{bool}{wxDbSqlLog}{\param{wxDbSqlLogState }{state}, \param{const wxString &}{filename = SQL\_LOG\_FILENAME}}
+\func{bool}{wxDbSqlLog}{\param{wxDbSqlLogState }{state}, \param{const wxString \&}{filename = SQL\_LOG\_FILENAME}}
 
 \wxheading{Remarks}
 
 This function sets the sql log state for all open wxDb objects
 
-
 \func{bool}{wxDbGetDataSource}{\param{HENV }{henv}, \param{wxChar *}{Dsn}, \param{SWORD }{DsnMax}, \param{wxChar *}{DsDesc}, \param{SWORD }{DsDescMax}, \param{UWORD }{direction = SQL\_FETCH\_NEXT}}
 
 \wxheading{Remarks}
@@ -366,11 +371,12 @@ This routine queries the ODBC driver manager for a list of available
 datasources.  Repeatedly call this function to obtain all the datasources 
 available through the ODBC driver manager on the current workstation.
 
+\begin{verbatim}
     wxStringList strList;
 
     while (wxDbGetDataSource(DbConnectInf.GetHenv(), Dsn, SQL\_MAX\_DSN\_LENGTH+1, DsDesc, 255))
         strList.Add(Dsn);
-
+\end{verbatim}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -380,7 +386,7 @@ available through the ODBC driver manager on the current workstation.
 
 Default constructor.
 
-\func{}{wxDb}{\param{const HENV &}{aHenv}, \param{bool }{FwdOnlyCursors=(bool)wxODBC\_FWD\_ONLY\_CURSORS}}
+\func{}{wxDb}{\param{const HENV \&}{aHenv}, \param{bool }{FwdOnlyCursors=(bool)wxODBC\_FWD\_ONLY\_CURSORS}}
 
 Constructor, used to create an ODBC connection to a datasource.
 
@@ -413,12 +419,11 @@ be created and opened before any database activity can occur.
 
 \wxheading{See also}
 
-\helpref{wxDbGetConnection}{wxdbfunctions},
-
+\helpref{wxDbGetConnection}{wxdbfunctions}
 
 \membersection{wxDb::Catalog}\label{wxdbcatalog}
 
-\func{bool}{Catalog}{\param{wxChar *}{ userID}, \param{const wxString &}{fileName = 
+\func{bool}{Catalog}{\param{wxChar *}{ userID}, \param{const wxString \&}{fileName = 
 SQL\_CATALOG\_FILENAME}}
 
 Allows a data "dictionary" of the datasource to be created, dumping pertinent 
@@ -533,8 +538,8 @@ that leave the cursors open after a transaction.}
 
 \membersection{wxDb::CreateView}\label{wxdbcreateviews}
 
-\func{bool}{CreateView}{\param{const wxString &}{ viewName}, 
-\param{const wxString &}{ colList}, \param{const wxString &}{pSqlStmt}}
+\func{bool}{CreateView}{\param{const wxString \&}{ viewName}, 
+\param{const wxString \&}{ colList}, \param{const wxString \&}{pSqlStmt}}
 
 Creates a SQL VIEW of one or more tables in a single datasource.  Note that 
 this function will only work against databases which support views (currently 
@@ -603,8 +608,7 @@ datasource is not recognized, a value of 'dbmsUNIDENTIFIED' is returned.
 
 \membersection{wxDb::DispAllErrors}\label{wxdbdispallerrors}
 
-\func{bool}{DispAllErrors}{\param{HENV}{ aHenv}, {\param}{HDBC}
-{ aHdbc = SQL\_NULL\_HDBC}, {\param}{HSTMT}{ aHstmt = SQL\_NULL\_HSTMT}}
+\func{bool}{DispAllErrors}{\param{HENV}{ aHenv}, \param{HDBC}{ aHdbc = SQL\_NULL\_HDBC}, \param{HSTMT}{ aHstmt = SQL\_NULL\_HSTMT}}
 
 Used to log all database errors that occurred as a result of an executed 
 database command.  This logging is automatic and also includes debug logging 
@@ -647,7 +651,6 @@ perform an action (see the example below).
       return(db.DispAllErrors(db.henv, db.hdbc, hstmt));
 \end{verbatim}
 
-
 \membersection{wxDb::DispNextError}\label{wxdbdispnexterror}
 
 \func{void}{DispNextError}{\void}
@@ -691,7 +694,7 @@ one in context and displaying the ones you choose.
 
 \membersection{wxDb::DropView}\label{wxdbdropview}
 
-\func{bool}{DropView}{\param{const wxString &}{viewName}}
+\func{bool}{DropView}{\param{const wxString \&}{viewName}}
 
 Drops the data table view named in 'viewName'.
 
@@ -705,8 +708,7 @@ If the view does not exist, this function will return TRUE.  Note that views are
 
 \membersection{wxDb::ExecSql}\label{wxdbexecsql}
 
-
-\func{bool}{ExecSql}{\param{const wxString &}{pSqlStmt}}
+\func{bool}{ExecSql}{\param{const wxString \&}{pSqlStmt}}
 
 Allows a native SQL command to be executed directly against the datasource.  In addition to being able to run any standard SQL command, use of this function allows a user to (potentially) utilize features specific to the datasource they are connected to that may not be available through ODBC.  The ODBC driver will pass the specified command directly to the datasource.
 
@@ -725,7 +727,6 @@ of processing.
 
 \helpref{wxDb::GetData}{wxdbgetdata}, \helpref{wxDb::GetNext}{wxdbgetnext}
 
-
 \membersection{wxDb::FwdOnlyCursors}\label{wxdbfwdonlycursors}
 
 \func{bool}{IsFwdOnlyCursors}{\void}
@@ -764,7 +765,7 @@ The returned catalog will only contain catalog entries for tables to which the u
 
 \membersection{wxDb::GetColumnCount}\label{wxdbgetcolumncount}
 
-\func{int }{GetColumnCount}{\param{const wxString &}{tableName}, \param{const wxChar *}{userID}}
+\func{int }{GetColumnCount}{\param{const wxString \&}{tableName}, \param{const wxChar *}{userID}}
 
 \wxheading{Parameters}
 
@@ -788,7 +789,7 @@ occurs retrieving the number of columns, this function will return a -1.
 
 \membersection{wxDb::GetColumns}\label{wxdbgetcolumns}
 
-\func{wxDbColInf *}{GetColumns}{\param{const wxString &}{tableName}, \param{UWORD *}{numCols}, \param{const wxChar *}{userID=NULL}}
+\func{wxDbColInf *}{GetColumns}{\param{const wxString \&}{tableName}, \param{UWORD *}{numCols}, \param{const wxChar *}{userID=NULL}}
 
 \func{wxDbColInf *}{GetColumns}{\param{wxChar *}{tableName[]}, \param{const wxChar *}{userID}}
 
@@ -838,7 +839,6 @@ to avoid undesired unbinding of columns.}
    }
 \end{verbatim}
 
-
 \membersection{wxDb::GetData}\label{wxdbgetdata}
 
 \func{bool}{GetData}{\param{UWORD}{ colNo}, \param{SWORD}{ cType}, 
@@ -917,7 +917,7 @@ Returns the name of the database engine.
 
 \membersection{wxDb::GetDatasourceName}\label{wxdbgetdatasourcename}
 
-\func{const wxString &}{GetDatasourceName}{\void}
+\func{const wxString \&}{GetDatasourceName}{\void}
 
 Returns the ODBC datasource name.
 
@@ -941,7 +941,7 @@ Returns the ODBC statement handle associated with this database connection.
 
 \membersection{wxDb::GetKeyFields}\label{wxdbgetkeyfields}
 
-\func{int }{GetKeyFields}{\param{const wxString &}{tableName}, \param{wxDbColInf *}{colInf}, \param{UWORD }{nocols}}
+\func{int }{GetKeyFields}{\param{const wxString \&}{tableName}, \param{wxDbColInf *}{colInf}, \param{UWORD }{nocols}}
 
 Used to determine which columns are members of primary or non-primary indexes on the specified table.  If a column is a member of a foreign key for some other table, that information is detected also.
 
@@ -1004,7 +1004,7 @@ hstmt argument.}
 
 \membersection{wxDb::GetPassword}\label{wxdbgetpassword}
 
-\func{const wxString &}{GetPassword}{\void}
+\func{const wxString \&}{GetPassword}{\void}
 
 Returns the password used to establish this connection to the datasource.
 
@@ -1019,7 +1019,7 @@ connection.
 
 \membersection{wxDb::GetUsername}\label{wxdbgetusername}
 
-\func{const wxString &}{GetUsername}{\void}
+\func{const wxString \&}{GetUsername}{\void}
 
 Returns the user name (uid) used to establish this connection to the 
 datasource.
@@ -1027,8 +1027,8 @@ datasource.
 
 \membersection{wxDb::Grant}\label{wxdbgrant}
 
-\func{bool}{Grant}{\param{int }{privileges}, \param{const wxString &}{tableName}, 
-\param{const wxString &}{userList = "PUBLIC"}}
+\func{bool}{Grant}{\param{int }{privileges}, \param{const wxString \&}{tableName}, 
+\param{const wxString \&}{userList = "PUBLIC"}}
 
 Use this member function to GRANT privileges to users for accessing tables in 
 the datasource.
@@ -1064,7 +1064,6 @@ function to be able to successfully grant the indicated privileges.
    db.Grant(DB_GRANT_SELECT | DB_GRANT_INSERT, "PARTS", "mary, sue");
 \end{verbatim}
 
-
 \membersection{wxDb::IsFwdOnlyCursors}\label{wxdbisfwdonlycursors}
 
 \func{bool}{IsFwdOnlyCursors}{\void}
@@ -1107,7 +1106,6 @@ versions prior to 2.4.
 
 \helpref{wxDb constructor}{wxdbconstr}, \helpref{wxDbGetConnection}{wxdbfunctions}
 
-
 \membersection{wxDb::IsOpen}\label{wxdbisopen}
 
 \func{bool}{IsOpen}{\void}
@@ -1128,10 +1126,9 @@ only way to know if complete initialization of this wxDb connection was
 successful or not.  See \helpref{wxDb::Open}{wxdbopen} for more details on 
 partial failures to open a connection instance.
 
-
 \membersection{wxDb::LogError}\label{wxdblogerror}
 
-\func{void}{LogError}{\param{const wxString &}{errMsg} \param{const wxString &}{SQLState=""}}
+\func{void}{LogError}{\param{const wxString \&}{errMsg} \param{const wxString \&}{SQLState=""}}
 
 \docparam{errMsg}{Free-form text to display describing the error/text to be logged.}
 \docparam{SQLState}{{\it OPTIONAL.}  Native SQL state error.  Default is 0.}
@@ -1149,11 +1146,10 @@ text into the SQL log file.
 
 \helpref{wxDb::WriteSqlLog}{wxdbwritesqllog}
 
-
 \membersection{wxDb::ModifyColumn}\label{wxdbmodifycolumn}
 
-\func{void}{ModifyColumn}{\param{const wxString &}{tableName} \param{const wxString &}{ColumnName} 
-\param{int }{dataType} \param{ULONG }{columnLength=0} \param{const wxString &}{optionalParam=""}}
+\func{void}{ModifyColumn}{\param{const wxString \&}{tableName} \param{const wxString \&}{ColumnName} 
+\param{int }{dataType} \param{ULONG }{columnLength=0} \param{const wxString \&}{optionalParam=""}}
 
 Used to change certain properties of a column such as the length, or whether a column 
 allows NULLs or not.
@@ -1189,8 +1185,8 @@ used for behavioral descriptions.
 
 \membersection{wxDb::Open}\label{wxdbopen}
 
-\func{bool}{Open}{\param{const wxString &}{Dsn}, \param{const wxString &}{Uid}, 
-\param{const wxString &}{AuthStr}}
+\func{bool}{Open}{\param{const wxString \&}{Dsn}, \param{const wxString \&}{Uid}, 
+\param{const wxString \&}{AuthStr}}
 
 \func{bool}{Open}{\param{wxDb *}{copyDb}}
 
@@ -1278,7 +1274,6 @@ must maintain the memory for these three strings for the life of the wxDb instan
    }
 \end{verbatim}
 
-
 \membersection{wxDb::RollbackTrans}\label{wxdbrollbacktrans}
 
 \func{bool}{RollbackTrans}{\void}
@@ -1301,7 +1296,6 @@ use this connection.}
 
 \helpref{wxDb::CommitTrans}{wxdbcommittrans} for a special note on cursors
 
-
 \membersection{wxDb::SetDebugErrorMessages}\label{wxdbsetdebugerrormessages}
 
 \func{void}{SetDebugErrorMessages}{\param{bool }{state}}
@@ -1322,10 +1316,9 @@ When compiled in release mode (FINAL=1), this setting has no affect.
 
 \helpref{wxDb constructor}{wxdbconstr}
 
-
 \membersection{wxDb::SetSqlLogging}\label{wxdbsetsqllogging}
 
-\func{bool}{SetSqlLogging}{\param{wxDbSqlLogState}{ state}, \param{const wxString &}{filename = SQL\_LOG\_FILENAME}, \param{bool }{ append = FALSE}}
+\func{bool}{SetSqlLogging}{\param{wxDbSqlLogState}{ state}, \param{const wxString \&}{filename = SQL\_LOG\_FILENAME}, \param{bool }{ append = FALSE}}
 
 \wxheading{Parameters}
 
@@ -1339,7 +1332,6 @@ When called with {\it sqlLogON}, all commands sent to the datasource engine are
 
 When called with {\it sqlLogOFF}, the logging file is closed, and any calls to \helpref{wxDb::WriteSqlLog}{wxdbwritesqllog} are ignored.
 
-
 \membersection{wxDb::SQLColumnName}\label{wxdbsqlcolumnname}
 
 \func{const wxString}{SQLColumnName}{\param{const char *}{ colName}}
@@ -1362,7 +1354,6 @@ before including the column name in a SQL statement}
 
 \helpref{wxDb::SQLTableName}{wxdbsqltablename}
 
-
 \membersection{wxDb::SQLTableName}\label{wxdbsqltablename}
 
 \func{const wxString}{SQLTableName}{\param{const char *}{ tableName}}
@@ -1385,10 +1376,9 @@ before including the table name in a SQL statement}
 
 \helpref{wxDb::SQLColumnName}{wxdbsqlcolumnname}
 
-
 \membersection{wxDb::TableExists}\label{wxdbtableexists}
 
-\func{bool}{TableExists}{\param{const wxString &}{tableName}, \param{const wxChar *}{userID=NULL}, \param{const wxString &}{path=""}}
+\func{bool}{TableExists}{\param{const wxString \&}{tableName}, \param{const wxChar *}{userID=NULL}, \param{const wxString \&}{path=""}}
 
 Checks the ODBC datasource for the existence of a table.  If a {\it userID} 
 is specified, then the table must be accessible by that user (user must have 
@@ -1417,12 +1407,11 @@ This function does not indicate whether or not the user has privileges to query
 
 \helpref{wxDb::TablePrivileges}{wxdbtableprivileges}
 
-
 \membersection{wxDb::TablePrivileges}\label{wxdbtableprivileges}
 
-\func{bool}{TablePrivileges}{\param{const wxString &}{tableName}, \param{const wxString &}{priv}, 
+\func{bool}{TablePrivileges}{\param{const wxString \&}{tableName}, \param{const wxString \&}{priv}, 
 \param{const wxChar *}{userID=NULL}, \param{const wxChar *}{schema=NULL}, 
-\param{const wxString &}{path=""}}
+\param{const wxString \&}{path=""}}
 
 Checks the ODBC datasource for the existence of a table.  If a {\it userID} 
 is specified, then the table must be accessible by that user (user must have 
@@ -1434,7 +1423,6 @@ at least minimal privileges to the table).
 {\it tableName} may refer to a table, view, alias or synonym.}
 \docparam{priv}{The table privilege being evaluated. May be one of the 
 following (or a datasource specific privilege):}
-
 \begin{verbatim}
     SELECT      : The connected user is permitted to retrieve data for 
                   one or more columns of the table.
@@ -1456,25 +1444,23 @@ following (or a datasource specific privilege):}
 \end{verbatim}
 \docparam{userID}{{\it OPTIONAL.}  User for which to determine if the privilege 
 specified to be checked is granted or not.  Default is "".  
-{\it userID} is evaluated as follows:
-
+{\it userID} is evaluated as follows:}
 \begin{verbatim}
          userID == NULL  ... NOT ALLOWED!
          userID == ""    ... UserID set equal to 'this->uid'
          userID != ""    ... UserID set equal to 'userID'
 \end{verbatim}
-}
+
 \docparam{schema}{{\it OPTIONAL.}  Owner of the table.  Specify a userID when the datasource 
 you are connected to allows multiple unique tables with the same name to be 
 owned by different users.  Specifying the table owner makes determination of the 
-users privileges MUCH faster.  Default is NULL.  {\it userID} is evaluated as follows:
-
+users privileges MUCH faster.  Default is NULL.  {\it userID} is evaluated as follows:}
 \begin{verbatim}
          schema == NULL  ... Any owner (DEFAULT)
          schema == ""    ... Owned by 'this->uid'
          schema != ""    ... Owned by userID specified in 'schema'
 \end{verbatim}
-}
+
 \docparam{path}{{\it OPTIONAL.}  Path to the table.  Default is "".  
 Currently unused.}
 
@@ -1496,7 +1482,7 @@ seconds of time difference.
 
 \membersection{wxDb::TranslateSqlState}\label{wxdbtranslatesqlstate}
 
-\func{int }{TranslateSqlState}{\param{const wxString &}{SQLState}}
+\func{int }{TranslateSqlState}{\param{const wxString \&}{SQLState}}
 
 Converts an ODBC sqlstate to an internal error code.
 
@@ -1508,10 +1494,9 @@ Converts an ODBC sqlstate to an internal error code.
 
 Returns the internal class DB\_ERR code.  See \helpref{wxDb::DB\_STATUS}{wxdb} definition.
 
-
 \membersection{wxDb::WriteSqlLog}\label{wxdbwritesqllog}
 
-\func{bool}{WriteSqlLog}{\param{const wxString &}{logMsg}}
+\func{bool}{WriteSqlLog}{\param{const wxString \&}{logMsg}}
 
 \wxheading{Parameters}
 
@@ -1534,19 +1519,20 @@ FALSE without performing the requested log, otherwise TRUE is returned.
 
 \helpref{wxDb::SetSqlLogging}{wxdbsetsqllogging}
 
-
 \section{\class{wxDbColDataPtr}}\label{wxdbcoldataptr}
 
 Pointer to dynamic column definitions for use with a wxDbTable instance.  
 Currently there are no member functions for this class.
 
+See the \helpref{database classes overview}{odbcoverview} for
+an introduction to using the ODBC classes.
+
 \begin{verbatim}
     void   *PtrDataObj;
     int     SzDataObj;
     SWORD   SqlCtype;
 \end{verbatim}
 
-
 \section{\class{wxDbColDef}}\label{wxdbcoldef}
 
 This class is used to hold information about the columns bound to an 
@@ -1589,14 +1575,59 @@ public.
 
 \wxheading{See also}
 
+\helpref{database classes overview}{odbcoverview}, 
 \helpref{wxDbTable::GetColDefs}{wxdbtablegetcoldefs}, \helpref{wxDb constructor}{wxdbconstr}
 
-
 \membersection{wxDbColDef::Initialize}\label{wxdbcoldefinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by 
 the constructor automatically.
 
+\section{\class{wxDbColFor}}\label{wxdbcolfor}
+
+Beginning support for handling international formatting specifically on dates 
+and floats.  
+
+\begin{verbatim}
+    wxString       s_Field;       // Formated String for Output
+    wxString       s_Format[7];   // Formated Objects - TIMESTAMP has 
+                                     the biggest (7)
+    wxString       s_Amount[7];   // Formated Objects - amount of 
+                                     things that can be formatted
+    int            i_Amount[7];   // Formated Objects - 
+                                        TT MM YYYY HH MM SS m
+    int            i_Nation;      // 0 = timestamp
+                                     1 = EU
+                                     2 = UK
+                                     3 = International
+                                     4 = US
+    int            i_dbDataType;  // conversion of the 'sqlDataType'
+                                     to the generic data type used by
+                                     these classes
+    SWORD          i_sqlDataType;
+\end{verbatim}
+
+The constructor for this class initializes all the values to zero or NULL.
+
+The destructor does nothing at this time.
+
+Only one function is provided with this class currently.
+
+See the \helpref{database classes overview}{odbcoverview} for
+an introduction to using the ODBC classes.
+
+\membersection{wxDbColFor::Format}\label{wxdbcolforformat}
+
+\func{int }{Format}{\param{int }{Nation}, \param{int }{dbDataType}, 
+\param{SWORD }{sqlDataType}, \param{short }{columnSize}, 
+\param{short }{decimalDigits}}\label{wxdbcolforformat}
+
+Work in progress, and should be inter-related with wxLocale eventually.
+
+\membersection{wxDbColFor::Initialize}\label{wxdbcolforinitialize}
+
+Simply initializes all member variables to a cleared state.  Called by 
+the constructor automatically.
 
 \section{\class{wxDbColInf}}\label{wxdbcolinf}
 
@@ -1638,60 +1669,14 @@ The constructor for this class initializes all the values to zero, "", or NULL.
 The destructor for this class takes care of deleting the pColFor member if 
 it is non-NULL.
 
+See the \helpref{database classes overview}{odbcoverview} for
+an introduction to using the ODBC classes.
 
 \membersection{wxDbColInf::Initialize}\label{wxdbcolinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by 
 the constructor automatically.
 
-
-
-\section{\class{wxDbColFor}}\label{wxdbcolfor}
-
-Beginning support for handling international formatting specifically on dates 
-and floats.  
-
-\begin{verbatim}
-    wxString       s_Field;       // Formated String for Output
-    wxString       s_Format[7];   // Formated Objects - TIMESTAMP has 
-                                     the biggest (7)
-    wxString       s_Amount[7];   // Formated Objects - amount of 
-                                     things that can be formatted
-    int            i_Amount[7];   // Formated Objects - 
-                                        TT MM YYYY HH MM SS m
-    int            i_Nation;      // 0 = timestamp
-                                     1 = EU
-                                     2 = UK
-                                     3 = International
-                                     4 = US
-    int            i_dbDataType;  // conversion of the 'sqlDataType'
-                                     to the generic data type used by
-                                     these classes
-    SWORD          i_sqlDataType;
-\end{verbatim}
-
-The constructor for this class initializes all the values to zero or NULL.
-
-The destructor does nothing at this time.
-
-Only one function is provided with this class currently:
-
-
-\membersection{wxDbColFor::Format}\label{wxdbcolforformat}
-
-\func{int }{Format}{\param{int }{Nation}, \param{int }{dbDataType}, 
-\param{SWORD }{sqlDataType}, \param{short }{columnSize}, 
-\param{short }{decimalDigits}}\label{wxdbcolforformat}
-
-Work in progress, and should be inter-related with wxLocale eventually.
-
-
-\membersection{wxDbColFor::Initialize}\label{wxdbcolforinitialize}
-
-Simply initializes all member variables to a cleared state.  Called by 
-the constructor automatically.
-
-
 \section{\class{wxDbConnectInf}}\label{wxdbconnectinf}
 
 This class is used for holding the data necessary for connecting to the ODBC 
@@ -1700,18 +1685,20 @@ name, user ID, password and default directory path (used with dBase).  Other
 optional fields held in this class are and file type, both for future 
 functions planned to be added for creating/manipulating datasource definitions.
 
+\membersection{wxDbConnectInf::wxDbConnectInfo}
+
 \func{}{wxDbConnectInf}{\void}
 
 Default constructor.
 
-\func{}{wxDb}{\param{HENV }{henv}, \param{const wxString &}{dsn}, 
-\param{const wxString &}{userID=""}, \param{const wxString &}{password}, 
-\param{const wxString &}{defaultDir=""}, \param{const wxString &}{description=""}, 
-\param{const wxString &}{fileType=""}}
+\func{}{wxDb}{\param{HENV }{henv}, \param{const wxString \&}{dsn}, 
+\param{const wxString \&}{userID=""}, \param{const wxString \&}{password}, 
+\param{const wxString \&}{defaultDir=""}, \param{const wxString \&}{description=""}, 
+\param{const wxString \&}{fileType=""}}
 
 Constructor which allows initial settings of all the classes member variables.
 
-See the special not below on the henv parameter for forcing this constructor 
+See the special note below on the henv parameter for forcing this constructor 
 to create a SQL environment handle automatically, rather than needing to pass 
 one in to the function.
 
@@ -1763,7 +1750,6 @@ automatically, and manage the destruction of the handle.
 \helpref{wxDConnectInf::AllocHenv}{wxdbconnectinfallochenv}, 
 \helpref{wxDConnectInf::FreeHenv}{wxdbconnectinffreehenv}
 
-
 \membersection{wxDbConnectInf::\destruct{wxDbConnectInf}}\label{wxdbconnectinfdestr}
 
 \func{}{\destruct{wxDbConnectInf}}{}
@@ -1774,7 +1760,6 @@ also takes care of calling
 \helpref{wxDConnectInf::FreeHenv}{wxdbconnectinffreehenv} to free the 
 SQL environment handle.
 
-
 \membersection{wxDbConnectInf::AllocHenv}\label{wxdbconnectinfallochenv}
 
 \func{bool }{AllocHenv}{\void}
@@ -1787,7 +1772,6 @@ an ODBC datasource.
 This function can be automatically called by the long from of the 
 \helpref{wxDbConnectInf}{wxdbconnectinf} constructor.
 
-
 \membersection{wxDbConnectInf::FreeHenv}\label{wxdbconnectinffreehenv}
 
 \func{void}{FreeHenv}{\void}
@@ -1803,13 +1787,11 @@ is reset to be FALSE, so that any future handles created using the
 \helpref{wxDbConnectInf::AllocHenv}{wxdbconnectinfallochenv} function 
 must be manually released with a call to this function.
 
-
 \membersection{wxDbConnectInf::Initialize}\label{wxdbconnectinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by 
 the constructor automatically.
 
-
 \membersection{wxDbConnectInf::GetAuthStr}\label{wxdbconnectinfgetauthstr}
 
 \func{const wxChar *}{GetAuthStr}{\void}
@@ -1819,7 +1801,6 @@ instance that will be used with the user ID.
 
 Synonymous with \helpref{wxDbConnectInf::GetPassword}{wxdbconnectinfgetpassword}
 
-
 \membersection{wxDbConnectInf::GetDefaultDir}\label{wxdbconnectinfgetdefaultdir}
 
 \func{const wxChar *}{GetDefaultDir}{\void}
@@ -1829,7 +1810,6 @@ table is stored.  This directory is only used for file based datasources like
 dBase.  MS-Access does not require this to be set, as the path is set in the 
 ODBC Administrator for MS-Access.
 
-
 \membersection{wxDbConnectInf::GetDescription}\label{wxdbconnectinfgetdescription}
 
 \func{const wxChar *}{GetDescription}{\void}
@@ -1839,7 +1819,6 @@ instance.
 
 NOTE: Description is a FUTURE USE item and is unused currently.
 
-
 \membersection{wxDbConnectInf::GetDsn}\label{wxdbconnectinfgetdsn}
 
 \func{const wxChar *}{GetDsn}{\void}
@@ -1847,7 +1826,6 @@ NOTE: Description is a FUTURE USE item and is unused currently.
 Accessor function to return the datasource name assigned for this class 
 instance.
 
-
 \membersection{wxDbConnectInf::GetFileType}\label{wxdbconnectinfgetfiletype}
 
 \func{const wxChar *}{GetFileType}{\void}
@@ -1857,7 +1835,6 @@ this class instance.
 
 NOTE: FileType is a FUTURE USE item and is unused currently.
 
-
 \membersection{wxDbConnectInf::GetHenv}\label{wxdbconnectinfgethenv}
 
 \func{const HENV}{GetHenv}{\void}
@@ -1865,7 +1842,6 @@ NOTE: FileType is a FUTURE USE item and is unused currently.
 Accessor function to return the SQL environment handle being managed 
 by this class instance.
 
-
 \membersection{wxDbConnectInf::GetPassword}\label{wxdbconnectinfgetpassword}
 
 \func{const wxChar *}{GetPassword}{\void}
@@ -1875,7 +1851,6 @@ instance that will be used with the user ID.
 
 Synonymous with \helpref{wxDbConnectInf::GetAuthStr}{wxdbconnectinfgetauthstr}
 
-
 \membersection{wxDbConnectInf::GetUid}\label{wxdbconnectinfgetuid}
 
 \func{const wxChar *}{GetUid}{\void}
@@ -1883,7 +1858,6 @@ Synonymous with \helpref{wxDbConnectInf::GetAuthStr}{wxdbconnectinfgetauthstr}
 Accessor function to return the user ID assigned for this class 
 instance.
 
-
 \membersection{wxDbConnectInf::GetUserID}\label{wxdbconnectinfgetuserid}
 
 \func{const wxChar *}{GetUserID}{\void}
@@ -1891,86 +1865,75 @@ instance.
 Accessor function to return the user ID assigned for this class 
 instance.
 
-
 \membersection{wxDbConnectInf::SetAuthStr}\label{wxdbconnectinfsetauthstr}
 
-\func{\void}{SetAuthStr}{const wxString &authstr}
+\func{\void}{SetAuthStr}{const wxString \&authstr}
 
 Accessor function to assign the password for this class 
 instance that will be used with the user ID.
 
 Synonymous with \helpref{wxDbConnectInf::SetPassword}{wxdbconnectinfsetpassword}
 
-
 \membersection{wxDbConnectInf::SetDefaultDir}\label{wxdbconnectinfsetdefaultdir}
 
-\func{\void}{SetDefaultDir}{const wxString &defDir}
+\func{\void}{SetDefaultDir}{const wxString \&defDir}
 
 Accessor function to assign the default directory in which the datasource's data 
 table is stored.  This directory is only used for file based datasources like 
 dBase.  MS-Access does not require this to be set, as the path is set in the 
 ODBC Administrator for MS-Access.
 
-
 \membersection{wxDbConnectInf::SetDescription}\label{wxdbconnectinfsetdescription}
 
-\func{\void}{SetDescription}{const wxString &desc}
+\func{\void}{SetDescription}{const wxString \&desc}
 
 Accessor function to assign the description assigned for this class 
 instance.
 
 NOTE: Description is a FUTURE USE item and is unused currently.
 
-
 \membersection{wxDbConnectInf::SetDsn}\label{wxdbconnectinfsetdsn}
 
-\func{\void}{SetDsn}{const wxString &dsn}
+\func{\void}{SetDsn}{const wxString \&dsn}
 
 Accessor function to assign the datasource name for this class instance.
 
-
 \membersection{wxDbConnectInf::SetFileType}\label{wxdbconnectinfsetfiletype}
 
-\func{\void}{SetFileType}{const wxString &}
+\func{\void}{SetFileType}{const wxString \&}
 
 Accessor function to return the filetype of the ODBC datasource assigned for 
 this class instance.
 
 NOTE: FileType is a FUTURE USE item and is unused currently.
 
-
 \membersection{wxDbConnectInf::SetHenv}\label{wxdbconnectinfsethenv}
 
 \func{void}{SetHenv}{\param{const HENV }{henv}}
 
 Accessor function to set the SQL environment handle for this class instance.
 
-
 \membersection{wxDbConnectInf::SetPassword}\label{wxdbconnectinfsetpassword}
 
-\func{\void}{SetPassword}{const wxString &password}
+\func{\void}{SetPassword}{const wxString \&password}
 
 Accessor function to assign the password for this class 
 instance that will be used with the user ID.
 
 Synonymous with \helpref{wxDbConnectInf::SetAuthStr}{wxdbconnectinfsetauthstr}
 
-
 \membersection{wxDbConnectInf::SetUid}\label{wxdbconnectinfsetuid}
 
-\func{\void}{SetUid}{const wxString &uid}
+\func{\void}{SetUid}{const wxString \&uid}
 
 Accessor function to set the user ID for this class instance.
 
-
 \membersection{wxDbConnectInf::SetUserID}\label{wxdbconnectinfsetuserid}
 
-\func{\void}{SetUserID}{const wxString &userID}
+\func{\void}{SetUserID}{const wxString \&userID}
 
 Accessor function to assign the user ID for this class instance.
 
-
-
 \section{\class{wxDbIdxDef}}\label{wxdbidxdef}
 
 Used in creation of non-primary indexes.  Currently there are no member 
@@ -1985,6 +1948,8 @@ functions for this class.
 
 There are no constructors/destructors as of this time, and no member functions.
 
+See the \helpref{database classes overview}{odbcoverview} for
+an introduction to using the ODBC classes.
 
 \section{\class{wxDbInf}}\label{wxdbinf}
 
@@ -2010,17 +1975,22 @@ The constructor for this class initializes all the values to zero, "", or NULL.
 The destructor for this class takes care of deleting the pTableInf member if 
 it is non-NULL.
 
+See the \helpref{database classes overview}{odbcoverview} for
+an introduction to using the ODBC classes.
+
 \membersection{wxDbInf::Initialize}\label{wxdbinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by 
 the constructor automatically.
 
-
 \section{\class{wxDbTable}}\label{wxdbtable}
 
 A wxDbTable instance provides re-usable access to rows of data in
 a table contained within the associated ODBC datasource
 
+See the \helpref{database classes overview}{odbcoverview} for
+an introduction to using the ODBC classes.
+
 \wxheading{Include files}
 
 <wx/dbtable.h>\\
@@ -2068,9 +2038,9 @@ with the wxDbTable class.
 
 \membersection{wxDbTable::wxDbTable}\label{wxdbtableconstr}
 
-\func{}{wxDbTable}{\param{wxDb *}{pwxDb}, \param{const wxString &}{tblName}, 
-  \param{const UWORD }{numColumns}, \param{const wxString &}{qryTblName = ""}, 
-  \param{bool }{qryOnly = !wxDB\_QUERY\_ONLY}, \param{const wxString &}{tblPath = ""}}
+\func{}{wxDbTable}{\param{wxDb *}{pwxDb}, \param{const wxString \&}{tblName}, 
+  \param{const UWORD }{numColumns}, \param{const wxString \&}{qryTblName = ""}, 
+  \param{bool }{qryOnly = !wxDB\_QUERY\_ONLY}, \param{const wxString \&}{tblPath = ""}}
 
 Default constructor.
 
@@ -2101,11 +2071,10 @@ require a path to where the table is stored on the system.  Default is "".}
 
 Virtual default destructor.
 
-
 \membersection{wxDbTable::BuildDeleteStmt}\label{wxdbtablebuilddeletestmt}
 
-\func{void}{BuildDeleteStmt}{\param{wxString &}{pSqlStmt}, 
-\param{int }{typeOfDel}, \param{const wxString &}{pWhereClause=""}}
+\func{void}{BuildDeleteStmt}{\param{wxString \&}{pSqlStmt}, 
+\param{int }{typeOfDel}, \param{const wxString \&}{pWhereClause=""}}
 
 Constructs the full SQL statement that can be used to delete all rows matching
 the criteria in the pWhereClause.
@@ -2130,10 +2099,9 @@ WHERE and FROM clauses specified using \helpref{wxDbTable::SetWhereClause}{wxdbt
 and \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause} are ignored by 
 this function.
 
-
 \membersection{wxDbTable::BuildSelectStmt}\label{wxdbtablebuildselectstmt}
 
-\func{void}{BuildSelectStmt}{\param{wxString &}{pSqlStmt}, 
+\func{void}{BuildSelectStmt}{\param{wxString \&}{pSqlStmt}, 
 \param{int }{typeOfSelect}, \param{bool }{distinct}}
 
 Constructs the full SQL statement that can be used to select all rows matching
@@ -2165,11 +2133,10 @@ WHERE and FROM clauses specified using
 and \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause} are ignored by 
 this function.
 
-
 \membersection{wxDbTable::BuildUpdateStmt}\label{wxdbtablebuildupdatestmt}
 
-\func{void}{BuildUpdateStmt}{\param{wxString &}{pSqlStmt}, \param{int }{typeOfUpd}, 
-\param{const wxString &}{pWhereClause=""}}
+\func{void}{BuildUpdateStmt}{\param{wxString \&}{pSqlStmt}, \param{int }{typeOfUpd}, 
+\param{const wxString \&}{pWhereClause=""}}
 
 Constructs the full SQL statement that can be used to update all rows matching
 the criteria in the pWhereClause.
@@ -2205,11 +2172,10 @@ WHERE and FROM clauses specified using \helpref{wxDbTable::SetWhereClause}{wxdbt
 and \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause} are ignored by 
 this function.
 
-
 \membersection{wxDbTable::BuildWhereStmt}\label{wxdbtablebuildwherestmt}
 
-\func{void}{BuildSelectStmt}{\param{wxString &}{pWhereClause}, 
-\param{int }{typeOfWhere}, \param{const wxString &}{qualTableName=""}, 
+\func{void}{BuildSelectStmt}{\param{wxString \&}{pWhereClause}, 
+\param{int }{typeOfWhere}, \param{const wxString \&}{qualTableName=""}, 
 \param{bool }{useLikeComparison=FALSE}}
 
 Constructs the portion of a SQL statement which would follow the word 'WHERE'
@@ -2241,7 +2207,6 @@ If using 'typeOfWhere' set to DB\_WHERE\_MATCHING, any bound columns currently
 containing a NULL value are not included in the WHERE clause's list of
 columns to use in the comparison.
 
-
 \membersection{wxDbTable::CanSelectForUpdate}\label{wxdbtablecanselectforupdate}
 
 \func{bool}{CanSelectForUpdate}{\void}
@@ -2262,7 +2227,6 @@ If the wxDbTable instance was created with the parameter wxDB\_QUERY\_ONLY, then
 this function will return FALSE.  For all known databases which do not support 
 the FOR UPDATE clause, this function will return FALSE also.
 
-
 \membersection{wxDbTable::CanUpdateByROWID}\label{wxdbtablecanupdatebyrowid}
 
 \func{bool}{CanUpdateByROWID}{\void}
@@ -2323,7 +2287,6 @@ flagged as being a NULL value stored in the bound memory variable.  If TRUE,
 then any value stored in the bound member variable is cleared.  Default is 
 FALSE.}
 
-
 \membersection{wxDbTable::ClearMemberVars}\label{wxdbtableclearmembervars}
 
 \func{void}{ClearMemberVars}{\param{bool }{setToNull=FALSE}}
@@ -2351,7 +2314,6 @@ functions build their WHERE clauses from non-zero columns.  To call either
 3)  Call wxDbTable::QueryMatching() or wxDbTable::DeleteMatching()
 \end{verbatim}
 
-
 \membersection{wxDbTable::CloseCursor}\label{wxdbtableclosecursor}
 
 \func{bool}{CloseCursor}{\param{HSTMT}{cursor}}
@@ -2367,13 +2329,11 @@ Closes the specified cursor associated with the wxDbTable object.
 Typically handled internally by the ODBC class library, but may be used by the 
 programmer if desired.
 
-
 \normalbox{DO NOT CLOSE THE wxDB\_DEFAULT\_CURSOR!}
 
-
 \membersection{wxDbTable::Count}\label{wxdbtablecount}
 
-\func{ULONG }{Count}{\param{const wxString &}{args="*"}}
+\func{ULONG }{Count}{\param{const wxString \&}{args="*"}}
 
 Returns the number of records which would be in the result set using the
 current query parameters specified in the WHERE and FROM clauses.
@@ -2425,10 +2385,9 @@ this function.
     totalNumberOfUniqueFirstNames = users.Count("DISTINCT FIRST_NAME");
 \end{verbatim}
 
-
 \membersection{wxDbTable::CreateIndex}\label{wxdbtablecreateindex}
 
-\func{bool}{CreateIndex}{\param{const wxString &}{idxName}, \param{bool }{unique}, 
+\func{bool}{CreateIndex}{\param{const wxString \&}{idxName}, \param{bool }{unique}, 
 \param{UWORD }{noIdxCols}, \param{wxDbIdxDef *}{pIdxDefs}, 
 \param{bool }{attemptDrop=TRUE}}
 
@@ -2511,7 +2470,6 @@ after executing this function.
     parts->CreateIndex(indexName, TRUE, 2, idxDef);
 \end{verbatim}
 
-
 \membersection{wxDbTable::CreateTable}\label{wxdbtablecreatetable}
 
 \func{bool}{CreateTable}{\param{bool }{attemptDrop=TRUE}}
@@ -2543,7 +2501,6 @@ information on describing the columns of the table.
 It is not necessary to call \helpref{wxDb::CommitTrans}{wxdbcommittrans} 
 after executing this function.
 
-
 \membersection{wxDbTable::DB\_STATUS}\label{wxdbtabledbstatus}
 
 \func{bool}{DB\_STATUS}{\void}
@@ -2551,7 +2508,6 @@ after executing this function.
 Accessor function that returns the wxDb private member variable DB\_STATUS for 
 the database connection used by this instance of wxDbTable.
 
-
 \membersection{wxDbTable::Delete}\label{wxdbtabledelete}
 
 \func{bool}{Delete}{\void}
@@ -2580,7 +2536,6 @@ most databases.  Therefore it is usually best to try to perform a commit
 or rollback at relatively small intervals when processing a larger number 
 of actions that insert/update/delete rows in a table.
 
-
 \membersection{wxDbTable::DeleteCursor}\label{wxdbtabledeletecursor}
 
 \func{bool}{DeleteCursor}{\param{HSTMT *}{hstmtDel}}
@@ -2603,7 +2558,6 @@ that is passed in is deleted, and the pointer is set to NULL.
 
 \normalbox{DO NOT DELETE THE wxDB\_DEFAULT\_CURSOR!}
 
-
 \membersection{wxDbTable::DeleteMatching}\label{wxdbtabledeletematching}
 
 \func{bool}{DeleteMatching}{\void}
@@ -2645,7 +2599,6 @@ most databases.  Therefore it is usually best to try to perform a commit
 or rollback at relatively small intervals when processing a larger number 
 of actions that insert/update/delete rows in a table.
 
-
 \wxheading{Example}
 
 \begin{verbatim}
@@ -2659,7 +2612,7 @@ of actions that insert/update/delete rows in a table.
 
 \membersection{wxDbTable::DeleteWhere}\label{wxdbtabledeletewhere}
 
-\func{bool}{DeleteWhere}{\param{const wxString &}{pWhereClause}}
+\func{bool}{DeleteWhere}{\param{const wxString \&}{pWhereClause}}
 
 Deletes all rows from the table which match the criteria specified in the 
 WHERE clause that is passed in.
@@ -2712,7 +2665,7 @@ this function.
 
 \membersection{wxDbTable::DropIndex}\label{wxdbtabledropindex}
 
-\func{bool}{DropIndex}{\param{const wxString &}{idxName}}
+\func{bool}{DropIndex}{\param{const wxString \&}{idxName}}
 
 Allows an index on the associated table to be dropped (deleted) if the user 
 login has sufficient privileges to do so.
@@ -2729,7 +2682,6 @@ will be logged, and the function will return a result of FALSE.
 It is not necessary to call \helpref{wxDb::CommitTrans}{wxdbcommittrans} 
 after executing this function.
 
-
 \membersection{wxDbTable::DropTable}\label{wxdbtabledroptable}
 
 \func{bool}{DropTable}{\void}
@@ -2750,12 +2702,11 @@ database to determine the behavior.
 It is not necessary to call \helpref{wxDb::CommitTrans}{wxdbcommittrans} 
 after executing this function.
 
-
 \membersection{wxDbTable::From}\label{wxdbtablefrom}
 
-\func{const wxString &}{From}{}
+\func{const wxString \&}{From}{}
 
-\func{void}{From}{\param{const wxString &}{From}}
+\func{void}{From}{\param{const wxString \&}{From}}
 
 Accessor function for the private class member wxDbTable::from.  Can be used 
 as a synonym for \helpref{wxDbTable::GetFromClause}{wxdbtablegetfromclause} 
@@ -2803,7 +2754,6 @@ To determine the number of elements pointed to by the returned
 These column definitions must not be manually redefined after they have been 
 set.
 
-
 \membersection{wxDbTable::GetCursor}\label{wxdbtablegetcursor}
 
 \func{HSTMT}{GetCursor}{\void}
@@ -2820,7 +2770,6 @@ cursor can be set back to being the cursor in use.
 
 \helpref{wxDbTable::SetCursor}{wxdbtablesetcursor}, \helpref{wxDbTable::GetNewCursor}{wxdbtablegetnewcursor}
 
-
 \membersection{wxDbTable::GetDb}\label{wxdbtablegetdb}
 
 \func{wxDb *}{GetDb}{}
@@ -2828,7 +2777,6 @@ cursor can be set back to being the cursor in use.
 Accessor function for the private member variable pDb which is a pointer to 
 the datasource connection that this wxDbTable instance uses.
 
-
 \membersection{wxDbTable::GetFirst}\label{wxdbtablegetfirst}
 
 \func{bool}{GetFirst}{\void}
@@ -2851,10 +2799,9 @@ return FALSE, and the data contained in the bound columns will be undefined.
 
 \helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors}
 
-
 \membersection{wxDbTable::GetFromClause}\label{wxdbtablegetfromclause}
 
-\func{const wxString &}{GetFromClause}{}
+\func{const wxString \&}{GetFromClause}{}
 
 Accessor function that returns the current FROM setting assigned with the 
 \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause}.
@@ -2863,7 +2810,6 @@ Accessor function that returns the current FROM setting assigned with the
 
 \helpref{wxDbTable::From}{wxdbtablefrom}
 
-
 \membersection{wxDbTable::GetLast}\label{wxdbtablegetlast}
 
 \func{bool}{GetLast}{\void}
@@ -2886,7 +2832,6 @@ return FALSE, and the data contained in the bound columns will be undefined.
 
 \helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors}
 
-
 \membersection{wxDbTable::GetNewCursor}\label{wxdbtablegetnewcursor}
 
 \func{HSTMT *}{GetNewCursor}{\param{bool }{setCursor=FALSE}, 
@@ -2911,7 +2856,6 @@ This new cursor must be closed using
 by the calling program before the wxDbTable instance is deleted, or both 
 memory and resource leaks will occur.
 
-
 \membersection{wxDbTable::GetNext}\label{wxdbtablegetnext}
 
 \func{bool}{GetNext}{\void}
@@ -2936,7 +2880,6 @@ This function works with both forward and backward scrolling cursors.
 \wxheading{See also}
 \helpref{wxDbTable::++}{wxdbtableplusplus}
 
-
 \membersection{wxDbTable::GetNumberOfColumns}\label{wxdbtablegetnumberofcolumns}
 
 \func{UWORD }{GetNumberOfColumns}{}
@@ -2944,10 +2887,9 @@ This function works with both forward and backward scrolling cursors.
 Accessor function that returns the number of columns that are statically 
 bound for access by the wxDbTable instance.
 
-
 \membersection{wxDbTable::GetOrderByClause}\label{wxdbtablegetorderbyclause}
 
-\func{const wxString &}{GetOrderByClause}{}
+\func{const wxString \&}{GetOrderByClause}{}
 
 Accessor function that returns the current ORDER BY setting assigned with 
 the \helpref{wxDbTable::SetOrderByClause}{wxdbtablesetorderbyclause}.
@@ -2956,7 +2898,6 @@ the \helpref{wxDbTable::SetOrderByClause}{wxdbtablesetorderbyclause}.
 
 \helpref{wxDbTable::OrderBy}{wxdbtableorderby}
 
-
 \membersection{wxDbTable::GetPrev}\label{wxdbtablegetprev}
 
 \func{bool}{GetPrev}{\void}
@@ -2986,10 +2927,9 @@ return FALSE, and the data contained in the bound columns will be undefined.
 \helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors}, 
 \helpref{wxDbTable::--}{wxdbtableminusminus}
 
-
 \membersection{wxDbTable::GetQueryTableName}\label{wxdbtablegetquerytablename}
 
-\func{const wxString &}{GetQueryTableName}{}
+\func{const wxString \&}{GetQueryTableName}{}
 
 Accessor function that returns the name of the table/view that was indicated 
 as being the table/view to query against when this wxDbTable instance was 
@@ -2999,7 +2939,6 @@ created.
 
 \helpref{wxDbTable constructor}{wxdbtableconstr}
 
-
 \membersection{wxDbTable::GetRowNum}\label{wxdbtablegetrownum}
 
 \func{UWORD}{GetRowNum}{\void}
@@ -3015,18 +2954,16 @@ Row number with some datasources/ODBC drivers is the position in the result set,
 while in others it may be a physical position in the database.  Check your 
 database documentation to find out which behavior is supported.
 
-
 \membersection{wxDbTable::GetTableName}\label{wxdbtablegettablename}
 
-\func{const wxString &}{GetTableName}{}
+\func{const wxString \&}{GetTableName}{}
 
 Accessor function that returns the name of the table that was indicated 
 as being the table that this wxDbTable instance was associated with.
 
-
 \membersection{wxDbTable::GetTablePath}\label{wxdbtablegettablepath}
 
-\func{const wxString &}{GetTablePath}{}
+\func{const wxString \&}{GetTablePath}{}
 
 Accessor function that returns the path to the data table that was indicated 
 during creation of this wxDbTable instance.
@@ -3035,10 +2972,9 @@ during creation of this wxDbTable instance.
 
 Currently only applicable to dBase and MS-Access datasources.
 
-
 \membersection{wxDbTable::GetWhereClause}\label{wxdbtablegetwhereclause}
 
-\func{const wxString &}{GetWhereClause}{}
+\func{const wxString \&}{GetWhereClause}{}
 
 Accessor function that returns the current WHERE setting assigned with the 
 \helpref{wxDbTable::SetWhereClause}{wxdbtablesetwhereclause}
@@ -3047,7 +2983,6 @@ Accessor function that returns the current WHERE setting assigned with the
 
 \helpref{wxDbTable::Where}{wxdbtablewhere}
 
-
 \membersection{wxDbTable::Insert}\label{wxdbtableinsert}
 
 \func{int }{Insert}{\void}
@@ -3082,7 +3017,7 @@ this function to commit or rollback the insertion.
     wxStrcpy(parts->PartName, "10");
     wxStrcpy(parts->PartDesc, "Part #10");
     parts->Qty = 1000;
-    RETCODE retcode = parts.Insert();
+    RETCODE retcode = parts->Insert();
     switch(retcode)
     {
         case DB_SUCCESS:
@@ -3100,7 +3035,6 @@ this function to commit or rollback the insertion.
     }
 \end{verbatim}
 
-
 \membersection{wxDbTable::IsColNull}\label{wxdbtableiscolnull}
 
 \func{bool }{IsColNull}{\param{UWORD }{colNo}} const
@@ -3116,8 +3050,7 @@ calls which defined the columns accessible to this wxDbTable instance.}
 
 \wxheading{Remarks}
 
-NULL column support is currently not fully implemented as of wxWindows 2.4
-
+NULL column support is currently not fully implemented as of wxWindows 2.4.
 
 \membersection{wxDbTable::IsCursorClosedOnCommit}\label{wxdbtableiscursorclosedoncommit}
 
@@ -3139,7 +3072,6 @@ If more than one wxDbTable instance used the same database connection, all curso
 which use the database connection are closed on the commit if this function 
 indicates TRUE.
 
-
 \membersection{wxDbTable::IsQueryOnly}\label{wxdbtableisqueryonly}
 
 \func{bool }{IsQueryOnly}{}
@@ -3149,7 +3081,6 @@ was created to allow only queries to be performed on the bound columns.  If
 this function returns TRUE, then no actions may be performed using this 
 wxDbTable instance that would modify (insert/delete/update) the table's data.
 
-
 \membersection{wxDbTable::Open}\label{wxdbtableopen}
 
 \func{bool }{Open}{\param{bool }{checkPrivileges=FALSE}, \param{bool }{checkTableExists=TRUE}}
@@ -3194,12 +3125,11 @@ function can significantly speed up the privileges checks.
 \helpref{wxDb::TableExists}{wxdbtableexists}, 
 \helpref{wxDb::TablePrivileges}{wxdbtableprivileges}
 
-
 \membersection{wxDbTable::OrderBy}\label{wxdbtableorderby}
 
-\func{const wxString &}{OrderBy}{}
+\func{const wxString \&}{OrderBy}{}
 
-\func{void}{OrderBy}{\param{const wxString &}{OrderBy}}
+\func{void}{OrderBy}{\param{const wxString \&}{OrderBy}}
 
 Accessor function for the private class member wxDbTable::orderBy.  Can be 
 used as a synonym for 
@@ -3228,7 +3158,6 @@ The second form of the function has no return value.
 \helpref{wxDbTable::GetOrderByClause}{wxdbtablegetorderbyclause}, 
 \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause}
 
-
 \membersection{wxDbTable::Query}\label{wxdbtablequery}
 
 \func{virtual bool }{Query}{\param{bool }{forUpdate=FALSE}, \param{bool }{distinct=FALSE}}
@@ -3314,10 +3243,9 @@ clauses.}
         dispPart(parts);  // user defined function
 \end{verbatim}
 
-
 \membersection{wxDbTable::QueryBySqlStmt}\label{wxdbtablequerybysqlstmt}
 
-\func{bool}{QueryBySqlStmt}{\param{const wxString &}{pSqlStmt}}
+\func{bool}{QueryBySqlStmt}{\param{const wxString \&}{pSqlStmt}}
 
 Performs a query against the datasource by accepting and passing verbatim the 
 SQL SELECT statement passed to the function.
@@ -3415,7 +3343,6 @@ either \helpref{wxDbTable::GetFirst}{wxdbtablegetfirst} or
             where device_id = 12)
 \end{verbatim}
 
-
 \membersection{wxDbTable::QueryMatching}\label{wxdbtablequerymatching}
 
 \func{virtual bool }{QueryMatching}{\param{bool }{forUpdate=FALSE}, 
@@ -3480,7 +3407,6 @@ this function.
         dispPart(parts);  // Some application defined function
 \end{verbatim}
 
-
 \membersection{wxDbTable::QueryOnKeyFields}\label{wxdbtablequeryonkeyfields}
 
 \func{bool }{QueryOnKeyFields}{\param{bool }{forUpdate=FALSE}, 
@@ -3530,7 +3456,6 @@ this function.
         dispPart(parts);  // Some application defined function
 \end{verbatim}
 
-
 \membersection{wxDbTable::Refresh}\label{wxdbtablerefresh}
 
 \func{bool}{Refresh}{\void}
@@ -3553,10 +3478,9 @@ index defined for it.  Otherwise, more than one record may be fetched and
 there is no guarantee that the correct record will be refreshed.  The 
 table's columns are refreshed to reflect the current data in the database.
 
-
 \membersection{wxDbTable::SetColDefs}\label{wxdbtablesetcoldefs}
 
-\func{void}{SetColDefs}{\param{UWORD }{index}, \param{const wxString &}{fieldName}, 
+\func{void}{SetColDefs}{\param{UWORD }{index}, \param{const wxString \&}{fieldName}, 
 \param{int }{dataType}, \param{void *}{pData}, \param{SWORD }{cType}, 
 \param{int }{size}, \param{bool }{keyField = FALSE}, \param{bool }{upd = TRUE}, 
 \param{bool }{insAllow = TRUE}, \param{bool }{derivedCol = FALSE}}
@@ -3650,7 +3574,6 @@ were to be copied over to another datasource or table.
                SQL_C_CHAR, PART_NUMBER_LEN, TRUE, FALSE,TRUE,FALSE);
 \end{verbatim}
 
-
 \membersection{wxDbTable::SetCursor}\label{wxdbtablesetcursor}
 
 \func{bool}{SetCursor}{\param{HSTMT *}{hstmtActivate = (void **) wxDB\_DEFAULT\_CURSOR}}
@@ -3680,10 +3603,9 @@ and saving a pointer to that cursor.
 \helpref{wxDbTable::GetCursor}{wxdbtablegetcursor}, 
 \helpref{wxDbTable::SetCursor}{wxdbtablesetcursor}
 
-
 \membersection{wxDbTable::SetFromClause}\label{wxdbtablesetfromclause}
 
-\func{void}{SetFromClause}{\param{const wxString &}{From}}
+\func{void}{SetFromClause}{\param{const wxString \&}{From}}
 
 Accessor function for setting the private class member wxDbTable::from 
 that indicates what other tables should be outer joined with the wxDbTable's
@@ -3730,12 +3652,11 @@ the datasource knows on which column values the tables should be joined on.
 \helpref{wxDbTable::From}{wxdbtablefrom}, 
 \helpref{wxDbTable::GetFromClause}{wxdbtablegetfromclause}
 
-
 \membersection{wxDbTable::SetColNull}\label{wxdbtablesetcolnull}
 
 \func{bool}{SetColNull}{\param{UWORD }{colNo}, \param{bool }{set=TRUE}}
 
-\func{bool}{SetColNull}{\param{const wxString &}{colName}, 
+\func{bool}{SetColNull}{\param{const wxString \&}{colName}, 
 \param{bool }{set=TRUE}}
 
 Both forms of this function allow a member variable representing a column 
@@ -3754,17 +3675,15 @@ this wxDbTable object.}
 the column to NULL, passing FALSE sets the column to be non-NULL.  Default is 
 TRUE.}
 
-
 \wxheading{Remarks}
 
 No database updates are done by this function.  It only operates on the 
 member variables in memory.  Use and insert or update function to store this 
 value to disk.
 
-
 \membersection{wxDbTable::SetOrderByClause}\label{wxdbtablesetorderbyclause}
 
-\func{void}{SetOrderByClause}{\param{const wxString &}{OrderBy}}
+\func{void}{SetOrderByClause}{\param{const wxString \&}{OrderBy}}
 
 Accessor function for setting the private class member wxDbTable::orderBy 
 which determines sequence/ordering of the rows returned in the result set 
@@ -3801,7 +3720,6 @@ Do {\bf not} include the keywords "ORDER BY" when setting the ORDER BY clause.
 \helpref{wxDbTable::OrderBy}{wxdbtableorderby}, 
 \helpref{wxDbTable::GetOrderByClause}{wxdbtablegetorderbyclause}
 
-
 \membersection{wxDbTable::SetQueryTimeout}\label{wxdbtablesetquerytimeout}
 
 \func{bool}{SetQueryTimeout}{\param{UDWORD }{nSeconds}}
@@ -3819,10 +3737,9 @@ Neither Oracle or Access support this function as of yet.  Other databases
 should be evaluated for support before depending on this function working 
 correctly.
 
-
 \membersection{wxDbTable::SetWhereClause}\label{wxdbtablesetwhereclause}
 
-\func{void}{SetWhereClause}{\param{const wxString &}{Where}}
+\func{void}{SetWhereClause}{\param{const wxString \&}{Where}}
 
 Accessor function for setting the private class member wxDbTable::where 
 that determines which rows are returned in the result set by the datasource.
@@ -3870,12 +3787,11 @@ Do {\bf not} include the keywords "WHERE" when setting the WHERE clause.
 \helpref{wxDbTable::Where}{wxdbtablewhere}, 
 \helpref{wxDbTable::GetWhereClause}{wxdbtablegetwhereclause}
 
-
 \membersection{wxDbTable::Update}\label{wxdbtableupdate}
 
 \func{bool }{Update}{\void}
 
-\func{bool }{Update}{\param{const wxString &}{pSqlStmt}}
+\func{bool }{Update}{\param{const wxString \&}{pSqlStmt}}
 
 The first form of this function will update the row that the current cursor 
 is currently positioned at with the values in the memory variables that 
@@ -3910,10 +3826,9 @@ this function to commit or rollback the update.
     sqlStmt = "update PART set QTY = 0 where PART_NUMBER = '32'";
 \end{verbatim}
 
-
 \membersection{wxDbTable::UpdateWhere}\label{wxdbtableupdatewhere}
 
-\func{bool}{UpdateWhere}{\param{const wxString &}{pWhereClause}}
+\func{bool}{UpdateWhere}{\param{const wxString \&}{pWhereClause}}
 
 Performs updates to the base table of the wxDbTable object, updating only the 
 rows which match the criteria specified in the {\it pWhereClause}.
@@ -3936,12 +3851,11 @@ A \helpref{wxDb::CommitTrans}{wxdbcommittrans} or
 \helpref{wxDb::RollbackTrans}{wxdbrollbacktrans} must be called after use of 
 this function to commit or rollback the update(s).
 
-
 \membersection{wxDbTable::Where}\label{wxdbtablewhere}
 
-\func{const wxString &}{Where}{}
+\func{const wxString \&}{Where}{}
 
-\func{void}{Where}{\param{const wxString& }{Where}}
+\func{void}{Where}{\param{const wxString\& }{Where}}
 
 Accessor function for the private class member wxDbTable::where.  Can be used 
 as a synonym for \helpref{wxDbTable::GetWhereClause}{wxdbtablegetwhereclause} 
@@ -3966,8 +3880,6 @@ the where clause successfully.
 \helpref{wxDbTable::GetWhereClause}{wxdbtablegetwhereclause}, 
 \helpref{wxDbTable::SetWhereClause}{wxdbtablesetwhereclause}
 
-
-
 \membersection{wxDbTable::operator $++$}\label{wxdbtableplusplus}
 
 \func{bool}{operator $++$}{\void}
@@ -3978,7 +3890,6 @@ Synonym for \helpref{wxDbTable::GetNext}{wxdbtablegetnext}
 
 \helpref{wxDbTable::GetNext}{wxdbtablegetnext}
 
-
 \membersection{wxDbTable::operator $--$}\label{wxdbtableminusminus}
 
 \func{bool}{operator $--$}{\void}
@@ -3989,7 +3900,6 @@ Synonym for \helpref{wxDbTable::GetPrev}{wxdbtablegetprev}
 
 \helpref{wxDbTable::GetPrev}{wxdbtablegetprev}
 
-
 \section{\class{wxDbTableInf}}\label{wxdbtableinf}
 
 \begin{verbatim}
@@ -4000,7 +3910,6 @@ Synonym for \helpref{wxDbTable::GetPrev}{wxdbtablegetprev}
     pColInf         = NULL;
 \end{verbatim}
 
-
 Currently only used by \helpref{wxDb::GetCatalog}{wxdbgetcatalog} internally 
 and \helpref{wxDbInf}{wxdbinf} class, but may be used in future releases for 
 user functions.  Contains information describing the table (Name, type, etc). 
@@ -4012,6 +3921,9 @@ structure.
 
 Eventually, accessor functions will be added for this class
 
+See the \helpref{database classes overview}{odbcoverview} for
+an introduction to using the ODBC classes.
+
 \membersection{wxDbTableInf::Initialize}\label{wxdbtableinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by 
