Some work on GTK focus handling and events.

[wxWidgets.git] / docs / latex / wx / db.tex

diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex
index 7b2ae3487f02583e62b965c7cc564876e2e28d46..65d6f3e2673253d955c3aef1925a642348d9cda4 100644 (file)
--- a/docs/latex/wx/db.tex
+++ b/docs/latex/wx/db.tex
@@ -6,12 +6,10 @@ 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.
 
 datasource, as well as allowing access to any tables/views defined in
 the datasource to which the user has sufficient privileges.
 

-

 \wxheading{Include files}
 
 <wx/db.h>
 
 \wxheading{Include files}
 
 <wx/db.h>
 

-

 \wxheading{Helper classes and data structures}
 
 The following classes and structs are defined in db.cpp/.h for use with the wxDb class.
 \wxheading{Helper classes and data structures}
 
 The following classes and structs are defined in db.cpp/.h for use with the wxDb class.


@@ -23,13 +21,11 @@ The following classes and structs are defined in db.cpp/.h for use with the wxDb
 \item \helpref{wxDbInf}{wxdbinf}
 \end{itemize}
 
 \item \helpref{wxDbInf}{wxdbinf}
 \end{itemize}
 

-

 \wxheading{Constants}
 
 \wxheading{Constants}
 

-NOTE: In a future release, all ODBC class constants will be prefaced with 'wx'
+NOTE: In a future release, all ODBC class constants will be prefaced with 'wx'.

 
 \begin{verbatim}
 
 \begin{verbatim}

-

     wxDB_PATH_MAX           Maximum path length allowed to be passed to
                             the ODBC driver to indicate where the data 
                             file(s) are located.
     wxDB_PATH_MAX           Maximum path length allowed to be passed to
                             the ODBC driver to indicate where the data 
                             file(s) are located.


@@ -57,8 +53,8 @@ NOTE: In a future release, all ODBC class constants will be prefaced with 'wx'
                             data type
 \end{verbatim}
 
                             data type
 \end{verbatim}
 

-

 \subsection{Enumerated types}\label{wxdbenumeratedtypes}
 \subsection{Enumerated types}\label{wxdbenumeratedtypes}

+

 \wxheading{Enumerated types}
 
 \docparam{enum {\bf wxDbSqlLogState}}{sqlLogOFF, sqlLogON}
 \wxheading{Enumerated types}
 
 \docparam{enum {\bf wxDbSqlLogState}}{sqlLogOFF, sqlLogON}


@@ -240,9 +236,9 @@ have been added for ease of use.}
                                 request
 \end{verbatim}
 
                                 request
 \end{verbatim}
 

-\docparam{wxChar {\bf wxDb::errorList}[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN]}{The last n ODBC errors that have occurred on this database connection.}
+\docparam{wxChar {\bf wxDb::errorList}[DB\_MAX\_ERROR\_HISTORY][DB\_MAX\_ERROR\_MSG\_LEN]}{The last n ODBC errors that have occurred on this database connection.}

 
 

-\docparam{wxChar {\bf wxDb::errorMsg}[SQL_MAX_MESSAGE_LENGTH]}{This member variable is populated as a result of calling \helpref{wxDb::GetNextError}{wxdbgetnexterror}.  It contains the ODBC error message text.}
+\docparam{wxChar {\bf wxDb::errorMsg}[SQL\_MAX\_MESSAGE\_LENGTH]}{This member variable is populated as a result of calling \helpref{wxDb::GetNextError}{wxdbgetnexterror}.  It contains the ODBC error message text.}

 
 \docparam{SDWORD {\bf wxDb::nativeError}}{Set by wxDb::DispAllErrors, 
 wxDb::GetNextError, and wxDb::DispNextError.  It contains the 
 
 \docparam{SDWORD {\bf wxDb::nativeError}}{Set by wxDb::DispAllErrors, 
 wxDb::GetNextError, and wxDb::DispNextError.  It contains the 


@@ -255,7 +251,7 @@ ODBC errors.}
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Default cursor scrolling is defined by wxODBC_FWD_ONLY_CURSORS in setup.h
+Default cursor scrolling is defined by wxODBC\_FWD\_ONLY\_CURSORS in setup.h

 when the wxWindows library is built.  This behavior can be overridden when 
 an instance of a wxDb is created (see \helpref{wxDb constructor}{wxdbconstr}).  
 Default setting of this value TRUE, as not all databases/drivers support 
 when the wxWindows library is built.  This behavior can be overridden when 
 an instance of a wxDb is created (see \helpref{wxDb constructor}{wxdbconstr}).  
 Default setting of this value TRUE, as not all databases/drivers support 


@@ -272,8 +268,49 @@ both types of cursors.
 The following functions are used in conjunction with the wxDb class.
 
 
 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}, 
 \func{wxDb *}{wxDbGetConnection}{\param{wxDbConnectInf *}{pDbConfig}, 

-\param{bool }{FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS}}
+\param{bool }{FwdOnlyCursors=(bool)wxODBC\_FWD\_ONLY\_CURSORS}}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -305,7 +342,7 @@ other connection(s) for that same datasource.  This cuts down greatly on
 network traffic, database load, and connection creation time.
 
 When the program is done using a connection created through a call to 
 network traffic, database load, and connection creation time.
 
 When the program is done using a connection created through a call to 

-wxDbGetConnection(), the program shoudl call wxDbFreeConnection() to release 
+wxDbGetConnection(), the program should call wxDbFreeConnection() to release 

 the wxDb instance back to the cache.  DO NOT DELETE THE wxDb INSTANCE!  
 Deleting the wxDb instance returned can cause a crash/memory corruption 
 later in the program when the cache is cleaned up.
 the wxDb instance back to the cache.  DO NOT DELETE THE wxDb INSTANCE!  
 Deleting the wxDb instance returned can cause a crash/memory corruption 
 later in the program when the cache is cleaned up.


@@ -314,55 +351,20 @@ When exiting the program, call wxDbCloseConnections() to close all the
 cached connections created by calls to wxDbGetConnection().
 
 
 cached connections created by calls to wxDbGetConnection().
 
 

-\func{bool}{wxDbFreeConnection}{\param{wxDb *}{pDb}}
+\func{const wxChar *}{wxDbLogExtendedErrorMsg}{\param{const wxChar *}{userText}, \param{wxDb *}{pDb}, \param{wxChar *}{ErrFile}, \param{int }{ErrLine}}

 
 

-\wxheading{Remarks}
+Writes a message to the wxLog window (stdout usually) when an internal 
+error situation occurs.  This function only works in DEBUG builds

 
 

-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{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
 
 
 
 \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}}
+\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}
 
 
 \wxheading{Remarks}
 


@@ -372,7 +374,7 @@ available through the ODBC driver manager on the current workstation.
 
     wxStringList strList;
 
 
     wxStringList strList;
 

-    while (wxDbGetDataSource(DbConnectInf.GetHenv(), Dsn, SQL_MAX_DSN_LENGTH+1, DsDesc, 255))
+    while (wxDbGetDataSource(DbConnectInf.GetHenv(), Dsn, SQL\_MAX\_DSN\_LENGTH+1, DsDesc, 255))

         strList.Add(Dsn);
 
 
         strList.Add(Dsn);
 
 


@@ -384,7 +386,7 @@ available through the ODBC driver manager on the current workstation.
 
 Default constructor.
 
 
 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.
 
 
 Constructor, used to create an ODBC connection to a datasource.
 


@@ -423,7 +425,7 @@ be created and opened before any database activity can occur.
 \membersection{wxDb::Catalog}\label{wxdbcatalog}
 
 \func{bool}{Catalog}{\param{wxChar *}{ userID}, \param{const wxString &}{fileName = 
 \membersection{wxDb::Catalog}\label{wxdbcatalog}
 
 \func{bool}{Catalog}{\param{wxChar *}{ userID}, \param{const wxString &}{fileName = 

-SQL_CATALOG_FILENAME}}
+SQL\_CATALOG\_FILENAME}}

 
 Allows a data "dictionary" of the datasource to be created, dumping pertinent 
 information about all data tables to which the user specified in userID has 
 
 Allows a data "dictionary" of the datasource to be created, dumping pertinent 
 information about all data tables to which the user specified in userID has 


@@ -435,7 +437,7 @@ access.
 tables to which this user has rights will be evaluated in the catalog.}
 
 \docparam{fileName}{{\it OPTIONAL}.  Name of the text file to create and write 
 tables to which this user has rights will be evaluated in the catalog.}
 
 \docparam{fileName}{{\it OPTIONAL}.  Name of the text file to create and write 

-the DB catalog to.  Default is SQL_CATALOG_FILENAME.}
+the DB catalog to.  Default is SQL\_CATALOG\_FILENAME.}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 


@@ -482,19 +484,6 @@ closing the database connection.
 
    // Close the wxDb connection when finished with it
    sampleDB.Close();
 
    // Close the wxDb connection when finished with it
    sampleDB.Close();

-
-   // Free Environment Handle that ODBC uses
-   //
-   // Be certain that no wxDb instances still exist 
-   // that were created using this handle!  If you
-   // use wxDbGetConnection() to get all the wxDb
-   // instances, you can use wxDbConnectionsInUse()
-   // to find out if any connections have not been 
-   // closed before calling this
-   if (SQLFreeEnv(Db.Henv) != SQL_SUCCESS)
-   {
-      // Error freeing environment handle
-   }

 \end{verbatim}
 
 
 \end{verbatim}
 
 


@@ -518,7 +507,7 @@ them by calling this function.
 
 Calling this member function commits ALL open transactions on this ODBC 
 connection.  For example, if three different wxDbTable instances used the 
 
 Calling this member function commits ALL open transactions on this ODBC 
 connection.  For example, if three different wxDbTable instances used the 

-same connection to the datasource, commiting changes made on one of those 
+same connection to the datasource, committing changes made on one of those 

 wxDbTable instances commits any pending transactions on all three wxDbTable 
 instances.
 
 wxDbTable instances commits any pending transactions on all three wxDbTable 
 instances.
 


@@ -559,7 +548,7 @@ only Oracle as of November 21 2000).
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{viewName}{The name of the view.  e.g. PARTS_V}
+\docparam{viewName}{The name of the view.  e.g. PARTS\_V}

 
 \docparam{colList}{{\it OPTIONAL} Pass in a comma delimited list of column 
 names if you wish to explicitly name each column in the result set.  If not 
 
 \docparam{colList}{{\it OPTIONAL} Pass in a comma delimited list of column 
 names if you wish to explicitly name each column in the result set.  If not 


@@ -621,7 +610,7 @@ datasource is not recognized, a value of 'dbmsUNIDENTIFIED' is returned.
 \membersection{wxDb::DispAllErrors}\label{wxdbdispallerrors}
 
 \func{bool}{DispAllErrors}{\param{HENV}{ aHenv}, {\param}{HDBC}
 \membersection{wxDb::DispAllErrors}\label{wxdbdispallerrors}
 
 \func{bool}{DispAllErrors}{\param{HENV}{ aHenv}, {\param}{HDBC}

-{ aHdbc = SQL_NULL_HDBC}, {\param}{HSTMT}{ aHstmt = SQL_NULL_HSTMT}}
+{ 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 
 
 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 


@@ -722,6 +711,7 @@ If the view does not exist, this function will return TRUE.  Note that views are
 
 \membersection{wxDb::ExecSql}\label{wxdbexecsql}
 
 
 \membersection{wxDb::ExecSql}\label{wxdbexecsql}
 

+

 \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.
 \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.


@@ -742,6 +732,19 @@ of processing.
 \helpref{wxDb::GetData}{wxdbgetdata}, \helpref{wxDb::GetNext}{wxdbgetnext}
 
 
 \helpref{wxDb::GetData}{wxdbgetdata}, \helpref{wxDb::GetNext}{wxdbgetnext}
 
 

+\membersection{wxDb::FwdOnlyCursors}\label{wxdbfwdonlycursors}
+
+\func{bool}{IsFwdOnlyCursors}{\void}
+
+Older form (pre-2.3/2.4 of wxWindows) of the 
+\helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors}.  This method is 
+provided for backward compatability only.  The method 
+\helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors} should be 
+used in place of this method. 
+
+
+\func{wxDbInf *}{GetCatalog}{\param{const wxChar *}{userID}}
+

 \membersection{wxDb::GetCatalog}\label{wxdbgetcatalog}
 
 \func{wxDbInf *}{GetCatalog}{\param{const wxChar *}{userID}}
 \membersection{wxDb::GetCatalog}\label{wxdbgetcatalog}
 
 \func{wxDbInf *}{GetCatalog}{\param{const wxChar *}{userID}}


@@ -773,7 +776,10 @@ The returned catalog will only contain catalog entries for tables to which the u
 
 \docparam{tableName}{The table name you wish to obtain column information about.}
 
 
 \docparam{tableName}{The table name you wish to obtain column information about.}
 

-\docparam{userID}{Name of the user that owns the table(s) (also referred to as schema).  Required for some datasources for situations where there may be multiple tables with the same name in the datasource, but owned by different users. {\it userID} is evaluated in the following manner:}
+\docparam{userID}{Name of the user that owns the table(s) (also referred to as schema).  
+Required for some datasources for situations where there may be multiple tables with the 
+same name in the datasource, but owned by different users. {\it userID } is 
+evaluated in the following manner:}

 
 \begin{verbatim}
          userID == NULL  ... UserID is ignored (DEFAULT)
 
 \begin{verbatim}
          userID == NULL  ... UserID is ignored (DEFAULT)


@@ -788,14 +794,14 @@ occurs retrieving the number of columns, this function will return a -1.
 
 \membersection{wxDb::GetColumns}\label{wxdbgetcolumns}
 
 
 \membersection{wxDb::GetColumns}\label{wxdbgetcolumns}
 

-\func{wxDbColInf *}{GetColumns}{\param{const wxString &}{tableName}, \param{int *}{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}}
 
 \wxheading{Parameters}
 
 \docparam{tableName}{The table name you wish to obtain column information about.}
 
 \func{wxDbColInf *}{GetColumns}{\param{wxChar *}{tableName[]}, \param{const wxChar *}{userID}}
 
 \wxheading{Parameters}
 
 \docparam{tableName}{The table name you wish to obtain column information about.}

-\docparam{numCols}{Pointer to an integer which will hold a count of the number of columns returned by this function}
+\docparam{numCols}{Pointer to a UWORD which will hold a count of the number of columns returned by this function}

 \docparam{tableName[]}{An array of pointers to table names you wish to obtain column information about.  The last element of this array must be a NULL string.}
 \docparam{userID}{Name of the user that owns the table(s) (also referred to as schema).  Required for some datasources for situations where there may be multiple tables with the same name in the datasource, but owned by different users. {\it userID} is evaluated in the following manner:}
 
 \docparam{tableName[]}{An array of pointers to table names you wish to obtain column information about.  The last element of this array must be a NULL string.}
 \docparam{userID}{Name of the user that owns the table(s) (also referred to as schema).  Required for some datasources for situations where there may be multiple tables with the same name in the datasource, but owned by different users. {\it userID} is evaluated in the following manner:}
 


@@ -860,8 +866,8 @@ NOTE: Not UNICODE safe.  If this is a numeric field, a value of 0 may be
 passed for this parameter, as the API knows the size of the expected return 
 value.}
 \docparam{cbReturned}{Pointer to the buffer containing the length of the 
 passed for this parameter, as the API knows the size of the expected return 
 value.}
 \docparam{cbReturned}{Pointer to the buffer containing the length of the 

-actual data returned.  If this value comes back as SQL_NULL_DATA, then the 
-wxDb::GetData() call has failed.}
+actual data returned.  If this value comes back as SQL\_NULL\_DATA, then the 
+\helpref{wxDb::GetData}{wxdbgetdata} call has failed.}

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -941,7 +947,7 @@ Returns the ODBC statement handle associated with this database connection.
 
 \membersection{wxDb::GetKeyFields}\label{wxdbgetkeyfields}
 
 
 \membersection{wxDb::GetKeyFields}\label{wxdbgetkeyfields}
 

-\func{int }{GetKeyFields}{\param{const wxString &}{tableName}, \param{wxDbColInf *}{colInf}, \param{int }{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.
 
 
 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.
 


@@ -975,7 +981,7 @@ in the result set after the current position of the cursor.
 \membersection{wxDb::GetNextError}\label{wxdbgetnexterror}
 
 \func{bool}{GetNextError}{\param{HENV}{ aHenv}, 
 \membersection{wxDb::GetNextError}\label{wxdbgetnexterror}
 
 \func{bool}{GetNextError}{\param{HENV}{ aHenv}, 

-\param{HDBC}{ aHdbc = SQL_NULL_HDBC}, \param{HSTMT}{ aHstmt = SQL_NULL_HSTMT}}
+\param{HDBC}{ aHdbc = SQL\_NULL\_HDBC}, \param{HSTMT}{ aHstmt = SQL\_NULL\_HSTMT}}

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -1036,7 +1042,7 @@ the datasource.
 \wxheading{Parameters}
 
 \docparam{privileges}{Use this argument to select which privileges you want to 
 \wxheading{Parameters}
 
 \docparam{privileges}{Use this argument to select which privileges you want to 

-grant.  Pass DB_GRANT_ALL to grant all privileges.  To grant individual 
+grant.  Pass DB\_GRANT\_ALL to grant all privileges.  To grant individual 

 privileges pass one or more of the following OR'd together:}
 
 \begin{verbatim}
 privileges pass one or more of the following OR'd together:}
 
 \begin{verbatim}


@@ -1083,7 +1089,7 @@ to use forward scrolling cursors.
 
 The default setting of whether a wxDb connection to a database allows
 forward-only or also backward scrolling cursors is defined in setup.h by the 
 
 The default setting of whether a wxDb connection to a database allows
 forward-only or also backward scrolling cursors is defined in setup.h by the 

-value of wxODBC_FWD_ONLY_CURSORS.  This default setting can be overridden
+value of wxODBC\_FWD\_ONLY\_CURSORS.  This default setting can be overridden

 when the wxDb connection is initially created (see 
 \helpref{wxDb constructor}{wxdbconstr} and \helpref{wxDbGetConnection}{wxdbfunctions}).
 
 when the wxDb connection is initially created (see 
 \helpref{wxDb constructor}{wxdbconstr} and \helpref{wxDbGetConnection}{wxdbfunctions}).
 


@@ -1161,16 +1167,16 @@ allows NULLs or not.
 \docparam{tableName}{Name of the table that the column to be modified is in.}
 \docparam{columnName}{Name of the column to be modified.  NOTE: Name of column cannot 
 be changed with this function.}
 \docparam{tableName}{Name of the table that the column to be modified is in.}
 \docparam{columnName}{Name of the column to be modified.  NOTE: Name of column cannot 
 be changed with this function.}

-\docparam{dataType}{Any one of DB_DATA_TYPE_VARCHAR, DB_DATA_TYPE_INTEGER, 
-DB_DATA_TYPE_FLOAT, DB_DATA_TYPE_DATE.}
-\docparam{columnLength}{New size of the column.  Valid only for DB_DATA_TYPE_VARCHAR 
+\docparam{dataType}{Any one of DB\_DATA\_TYPE\_VARCHAR, DB\_DATA\_TYPE\_INTEGER, 
+DB\_DATA\_TYPE\_FLOAT, DB\_DATA\_TYPE\_DATE.}
+\docparam{columnLength}{New size of the column.  Valid only for DB\_DATA\_TYPE\_VARCHAR 

 dataType fields.  Default is 0.}
 \docparam{optionalParam}{Default is "".}
 
 \wxheading{Remarks}
 
 Cannot be used to modify the precision of a numeric column, therefore 'columnLength' 
 dataType fields.  Default is 0.}
 \docparam{optionalParam}{Default is "".}
 
 \wxheading{Remarks}
 
 Cannot be used to modify the precision of a numeric column, therefore 'columnLength' 

-is ignored unless the dataType is DB_DATA_TYPE_VARCHAR.
+is ignored unless the dataType is DB\_DATA\_TYPE\_VARCHAR.

 
 Some datasources do not allow certain properties of a column to be changed if any rows 
 currently have data stored in that column.  Those datasources that do allow columns 
 
 Some datasources do not allow certain properties of a column to be changed if any rows 
 currently have data stored in that column.  Those datasources that do allow columns 


@@ -1307,7 +1313,7 @@ use this connection.}
 \func{void}{SetDebugErrorMessages}{\param{bool }{state}}
 
 \docparam{state}{Either TRUE (debug messages are logged) or FALSE (debug
 \func{void}{SetDebugErrorMessages}{\param{bool }{state}}
 
 \docparam{state}{Either TRUE (debug messages are logged) or FALSE (debug

-messages are not logged.}
+messages are not logged).}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -1325,21 +1331,67 @@ When compiled in release mode (FINAL=1), this setting has no affect.
 
 \membersection{wxDb::SetSqlLogging}\label{wxdbsetsqllogging}
 
 
 \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}
 
 \docparam{state}{Either sqlLogOFF or sqlLogON (see \helpref{enum wxDbSqlLogState}{wxdbcolfor}). Turns logging of SQL commands sent to the datasource OFF or ON.}
 
 \wxheading{Parameters}
 
 \docparam{state}{Either sqlLogOFF or sqlLogON (see \helpref{enum wxDbSqlLogState}{wxdbcolfor}). Turns logging of SQL commands sent to the datasource OFF or ON.}

-\docparam{filename}{{\it OPTIONAL}.  Name of the file to which the log text is to be written.  Default is SQL_LOG_FILENAME.}
+\docparam{filename}{{\it OPTIONAL}.  Name of the file to which the log text is to be written.  Default is SQL\_LOG\_FILENAME.}

 \docparam{append}{{\it OPTIONAL}. Whether the file is appended to or overwritten.  Default is FALSE.}
 
 \wxheading{Remarks}
 
 \docparam{append}{{\it OPTIONAL}. Whether the file is appended to or overwritten.  Default is FALSE.}
 
 \wxheading{Remarks}
 

-When called with {\it sqlLogON}, all commands sent to the datasource engine are logged to the file specified by {\it filename}.  Logging is done by embedded riteSqlLog() calls in the database member functions, or may be manually logged by adding calls to \helpref{wxDb::WriteSqlLog}{wxdbwritesqllog} in your own source code.
+When called with {\it sqlLogON}, all commands sent to the datasource engine are logged to the file specified by {\it filename}.  Logging is done by embedded \helpref{wxDb::WriteSqlLog}{wxdbwritesqllog} calls in the database member functions, or may be manually logged by adding calls to \helpref{wxDb::WriteSqlLog}{wxdbwritesqllog} in your own source code.

 
 When called with {\it sqlLogOFF}, the logging file is closed, and any calls to \helpref{wxDb::WriteSqlLog}{wxdbwritesqllog} are ignored.
 
 
 
 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}}
+
+Returns the column name in a form ready for use in SQL statements.  
+In most cases, the column name is returned verbatim.  But some databases
+(e.g. MS Access, SQL Server, MSDE) allow for spaces in column names, which 
+must be specially quoted.  For example, if the datasource allows spaces
+in the column name, the returned string will have the correct enclosing 
+marks around the name to allow it to be properly included in a SQL statement 
+for the DBMS that is currently connected to with this connection.
+
+\wxheading{Parameters}
+
+\docparam{colName}{Native name of the column in the table that is to be 
+evaluated to determine if any special quoting marks needed to be added to it 
+before including the column name in a SQL statement}
+
+\wxheading{See also}
+
+\helpref{wxDb::SQLTableName}{wxdbsqltablename}
+
+
+\membersection{wxDb::SQLTableName}\label{wxdbsqltablename}
+
+\func{const wxString}{SQLTableName}{\param{const char *}{ tableName}}
+
+Returns the table name in a form ready for use in SQL statements.  
+In most cases, the table name is returned verbatim.  But some databases
+(e.g. MS Access, SQL Server, MSDE) allow for spaces in table names, which 
+must be specially quoted.  For example, if the datasource allows spaces
+in the table name, the returned string will have the correct enclosing 
+marks around the name to allow it to be properly included in a SQL statement 
+for the data source that is currently connected to with this connection.
+
+\wxheading{Parameters}
+
+\docparam{tableName}{Native name of the table that is to be evaluated to 
+determine if any special quoting marks needed to be added to it 
+before including the table name in a SQL statement}
+
+\wxheading{See also}
+
+\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=""}}
 \membersection{wxDb::TableExists}\label{wxdbtableexists}
 
 \func{bool}{TableExists}{\param{const wxString &}{tableName}, \param{const wxChar *}{userID=NULL}, \param{const wxString &}{path=""}}


@@ -1460,7 +1512,7 @@ Converts an ODBC sqlstate to an internal error code.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns the internal class DB_ERR code.  See \helpref{wxDb::DB_STATUS}{wxdb} definition.
+Returns the internal class DB\_ERR code.  See \helpref{wxDb::DB\_STATUS}{wxdb} definition.

 
 
 \membersection{wxDb::WriteSqlLog}\label{wxdbwritesqllog}
 
 
 \membersection{wxDb::WriteSqlLog}\label{wxdbwritesqllog}


@@ -1497,7 +1549,7 @@ Currently there are no member functions for this class.
 \begin{verbatim}
     void   *PtrDataObj;
     int     SzDataObj;
 \begin{verbatim}
     void   *PtrDataObj;
     int     SzDataObj;

-    int     SqlCtype;
+    SWORD   SqlCtype;

 \end{verbatim}
 
 
 \end{verbatim}
 
 


@@ -1517,16 +1569,17 @@ maintained by the wxDbTable class (and can be retrieved using the
 To access the nth column definition of your wxDbTable object, just reference 
 wxDbColDefs element [n - 1].
 
 To access the nth column definition of your wxDbTable object, just reference 
 wxDbColDefs element [n - 1].
 

-Currently there are no member functions for this class.
-

 Typically, \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs} is used to 
 populate an array of these data structures for the wxDbTable instance.
 
 Typically, \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs} is used to 
 populate an array of these data structures for the wxDbTable instance.
 

+Currently there are no accessor functions for this class, so all members are 
+public.
+

 \begin{verbatim}
     wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];  // Column Name
     int     DbDataType;    - Logical Data Type; 
                              e.g. DB_DATA_TYPE_INTEGER
 \begin{verbatim}
     wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];  // Column Name
     int     DbDataType;    - Logical Data Type; 
                              e.g. DB_DATA_TYPE_INTEGER

-    int     SqlCtype;      - C data type; e.g. SQL_C_LONG
+    SWORD   SqlCtype;      - C data type; e.g. SQL_C_LONG

     void   *PtrDataObj;    - Address of the data object
     int     SzDataObj;     - Size, in bytes, of the data object
     bool    KeyField;      - Is column part of the PRIMARY KEY for the
     void   *PtrDataObj;    - Address of the data object
     int     SzDataObj;     - Size, in bytes, of the data object
     bool    KeyField;      - Is column part of the PRIMARY KEY for the


@@ -1545,45 +1598,10 @@ populate an array of these data structures for the wxDbTable instance.
 \helpref{wxDbTable::GetColDefs}{wxdbtablegetcoldefs}, \helpref{wxDb constructor}{wxdbconstr}
 
 
 \helpref{wxDbTable::GetColDefs}{wxdbtablegetcoldefs}, \helpref{wxDb constructor}{wxdbconstr}
 
 

-\section{\class{wxDbColInf}}\label{wxdbcolinf}
-
-Used with the \helpref{wxDb::GetColumns}{wxdbgetcolumns} functions for obtaining all retrievable information about a column's definition.
+\membersection{wxDbColDef::Initialize}\label{wxdbcoldefinitialize}

 
 

-\begin{verbatim}
-    wxChar       catalog[128+1];
-    wxChar       schema[128+1];
-    wxChar       tableName[DB_MAX_TABLE_NAME_LEN+1];
-    wxChar       colName[DB_MAX_COLUMN_NAME_LEN+1];
-    SWORD        sqlDataType;
-    wxChar       typeName[128+1];
-    SWORD        columnSize;
-    SWORD        bufferLength;
-    short        decimalDigits;
-    short        numPrecRadix;
-    short        nullable;
-    wxChar       remarks[254+1];
-    int          dbDataType;  // conversion of the 'sqlDataType' 
-                              // to the generic data type used by 
-                              // these classes
-    int          PkCol;       // Primary key column
-                                    0 = No
-                                    1 = First Key
-                                    2 = Second Key, etc...
-    wxChar       PkTableName[DB_MAX_TABLE_NAME_LEN+1];
-                              // Tables that use this PKey as a FKey
-    int          FkCol;       // Foreign key column
-                                    0 = No
-                                    1 = First Key
-                                    2 = Second Key, etc...
-    wxChar       FkTableName[DB_MAX_TABLE_NAME_LEN+1]; 
-                              // Foreign key table name
-    wxDbColFor  *pColFor;     // How should this column be formatted
-\end{verbatim}
-
-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.
+Simply initializes all member variables to a cleared state.  Called by 
+the constructor automatically.

 
 
 \section{\class{wxDbColFor}}\label{wxdbcolfor}
 
 
 \section{\class{wxDbColFor}}\label{wxdbcolfor}


@@ -1632,19 +1650,52 @@ Simply initializes all member variables to a cleared state.  Called by
 the constructor automatically.
 
 
 the constructor automatically.
 
 

-\section{\class{wxDbIdxDef}}\label{wxdbidxdef}
+\section{\class{wxDbColInf}}\label{wxdbcolinf}

 
 

-Used in creation of non-primary indexes.  Currently there are no member 
-functions for this class.
+Used with the \helpref{wxDb::GetColumns}{wxdbgetcolumns} functions for obtaining all retrievable information about a column's definition.

 
 \begin{verbatim}
 
 \begin{verbatim}

-        wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1] 
-                                  // Name of column
-        bool    Ascending         // Is index maintained in 
-                                     ASCENDING sequence?
+    wxChar       catalog[128+1];
+    wxChar       schema[128+1];
+    wxChar       tableName[DB_MAX_TABLE_NAME_LEN+1];
+    wxChar       colName[DB_MAX_COLUMN_NAME_LEN+1];
+    SWORD        sqlDataType;
+    wxChar       typeName[128+1];
+    SWORD        columnSize;
+    SWORD        bufferLength;
+    short        decimalDigits;
+    short        numPrecRadix;
+    short        nullable;
+    wxChar       remarks[254+1];
+    int          dbDataType;  // conversion of the 'sqlDataType' 
+                              // to the generic data type used by 
+                              // these classes
+    int          PkCol;       // Primary key column
+                                    0 = No
+                                    1 = First Key
+                                    2 = Second Key, etc...
+    wxChar       PkTableName[DB_MAX_TABLE_NAME_LEN+1];
+                              // Tables that use this PKey as a FKey
+    int          FkCol;       // Foreign key column
+                                    0 = No
+                                    1 = First Key
+                                    2 = Second Key, etc...
+    wxChar       FkTableName[DB_MAX_TABLE_NAME_LEN+1]; 
+                              // Foreign key table name
+    wxDbColFor  *pColFor;     // How should this column be formatted

 \end{verbatim}
 
 \end{verbatim}
 

-There are no constructors/destructors as of this time, and no member functions.
+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.
+
+
+\membersection{wxDbColInf::Initialize}\label{wxdbcolinfinitialize}
+
+Simply initializes all member variables to a cleared state.  Called by 
+the constructor automatically.
+

 
 
 \section{\class{wxDbConnectInf}}\label{wxdbconnectinf}
 
 
 \section{\class{wxDbConnectInf}}\label{wxdbconnectinf}


@@ -1926,6 +1977,21 @@ 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 
+functions for this class.
+
+\begin{verbatim}
+        wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1] 
+                                  // Name of column
+        bool    Ascending         // Is index maintained in 
+                                     ASCENDING sequence?
+\end{verbatim}
+
+There are no constructors/destructors as of this time, and no member functions.
+
+

 \section{\class{wxDbInf}}\label{wxdbinf}
 
 Contains information regarding the database connection (datasource name, 
 \section{\class{wxDbInf}}\label{wxdbinf}
 
 Contains information regarding the database connection (datasource name, 


@@ -2009,8 +2075,8 @@ with the wxDbTable class.
 \membersection{wxDbTable::wxDbTable}\label{wxdbtableconstr}
 
 \func{}{wxDbTable}{\param{wxDb *}{pwxDb}, \param{const wxString &}{tblName}, 
 \membersection{wxDbTable::wxDbTable}\label{wxdbtableconstr}
 
 \func{}{wxDbTable}{\param{wxDb *}{pwxDb}, \param{const wxString &}{tblName}, 

-  \param{const int }{nCols}, \param{const wxString &}{qryTblName = ""}, 
-  \param{bool }{qryOnly = !wxDB_QUERY_ONLY}, \param{const wxString &}{tblPath = ""}}
+  \param{const UWORD }{numColumns}, \param{const wxString &}{qryTblName = ""}, 
+  \param{bool }{qryOnly = !wxDB\_QUERY\_ONLY}, \param{const wxString &}{tblPath = ""}}

 
 Default constructor.
 
 
 Default constructor.
 


@@ -2019,7 +2085,7 @@ Default constructor.
 \docparam{pwxDb}{Pointer to the wxDb instance to be used by this wxDbTable 
 instance.}
 \docparam{tblName}{The name of the table in the RDBMS.}
 \docparam{pwxDb}{Pointer to the wxDb instance to be used by this wxDbTable 
 instance.}
 \docparam{tblName}{The name of the table in the RDBMS.}

-\docparam{nCols}{The number of columns in the table.  (Do NOT include the ROWID
+\docparam{numColumns}{The number of columns in the table.  (Do NOT include the ROWID

 column in the count if using Oracle).}
 \docparam{qryTblName}{{\it OPTIONAL}.  The name of the table or view to base 
 your queries on.  This argument allows you to specify a table/view other than
 column in the count if using Oracle).}
 \docparam{qryTblName}{{\it OPTIONAL}.  The name of the table or view to base 
 your queries on.  This argument allows you to specify a table/view other than


@@ -2031,7 +2097,7 @@ your queries involve many tables with multiple joins.  Default is "".}
 \docparam{qryOnly}{{\it OPTIONAL}.  Indicates whether the table will be 
 accessible for query purposes only, or should the table create the necessary
 cursors to be able to insert, update, and delete data from the table.  
 \docparam{qryOnly}{{\it OPTIONAL}.  Indicates whether the table will be 
 accessible for query purposes only, or should the table create the necessary
 cursors to be able to insert, update, and delete data from the table.  

-Default is !wxDB_QUERY_ONLY.}
+Default is !wxDB\_QUERY\_ONLY.}

 \docparam{tblPath}{{\it OPTIONAL}.  Some datasources (such as dBase) 
 require a path to where the table is stored on the system.  Default is "".}
 
 \docparam{tblPath}{{\it OPTIONAL}.  Some datasources (such as dBase) 
 require a path to where the table is stored on the system.  Default is "".}
 


@@ -2054,10 +2120,10 @@ the criteria in the pWhereClause.
 
 \docparam{pSqlStmt}{Pointer to buffer for the SQL statement retrieved.  To be
 sure you have adequate space allocated for the SQL statement, allocate
 
 \docparam{pSqlStmt}{Pointer to buffer for the SQL statement retrieved.  To be
 sure you have adequate space allocated for the SQL statement, allocate

-DB_MAX_STATEMENT_LEN bytes.}
+DB\_MAX\_STATEMENT\_LEN bytes.}

 \docparam{typeOfDel}{The type of delete statement being performed.  Can be one
 \docparam{typeOfDel}{The type of delete statement being performed.  Can be one

-of three values: DB_DEL_KEYFIELDS, DB_DEL_WHERE or DB_DEL_MATCHING}
-\docparam{pWhereClause}{{\it OPTIONAL}.  If the typeOfDel is DB_DEL_WHERE, 
+of three values: DB\_DEL\_KEYFIELDS, DB\_DEL\_WHERE or DB\_DEL\_MATCHING}
+\docparam{pWhereClause}{{\it OPTIONAL}.  If the typeOfDel is DB\_DEL\_WHERE, 

 then you must also pass in a SQL WHERE clause in this argument.  Default 
 is "".}
 
 then you must also pass in a SQL WHERE clause in this argument.  Default 
 is "".}
 


@@ -2078,7 +2144,7 @@ this function.
 
 Constructs the full SQL statement that can be used to select all rows matching
 the criteria in the pWhereClause.  This function is called internally in the 
 
 Constructs the full SQL statement that can be used to select all rows matching
 the criteria in the pWhereClause.  This function is called internally in the 

-wxDbTable class whenever the function \helpref{wxDbTable::Query}{wxdbtablequery}
+wxDbTable class whenever the function \helpref{wxDbTable::Query}{wxdbtablequery} 

 is called.
 
 NOTE: Only the columns specified in \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs} 
 is called.
 
 NOTE: Only the columns specified in \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs} 


@@ -2089,10 +2155,10 @@ created by a call to this function.
 
 \docparam{pSqlStmt}{Pointer to storage for the SQL statement retrieved.  To be
 sure you have adequate space allocated for the SQL statement, allocate
 
 \docparam{pSqlStmt}{Pointer to storage for the SQL statement retrieved.  To be
 sure you have adequate space allocated for the SQL statement, allocate

-DB_MAX_STATEMENT_LEN bytes.}
+DB\_MAX\_STATEMENT\_LEN bytes.}

 \docparam{typeOfSelect}{The type of select statement being performed.  Can be
 \docparam{typeOfSelect}{The type of select statement being performed.  Can be

-one of four values: DB_SELECT_KEYFIELDS, DB_SELECT_WHERE, DB_SELECT_MATCHING
-or DB_SELECT_STATEMENT.}
+one of four values: DB\_SELECT\_KEYFIELDS, DB\_SELECT\_WHERE, DB\_SELECT\_MATCHING
+or DB\_SELECT\_STATEMENT.}

 \docparam{distinct}{Whether to select distinct records only.}
 
 \wxheading{Remarks}
 \docparam{distinct}{Whether to select distinct records only.}
 
 \wxheading{Remarks}


@@ -2114,7 +2180,7 @@ this function.
 Constructs the full SQL statement that can be used to update all rows matching
 the criteria in the pWhereClause.
 
 Constructs the full SQL statement that can be used to update all rows matching
 the criteria in the pWhereClause.
 

-If typeOfUpd is DB_UPD_KEYFIELDS, then the current values in the bound columns
+If typeOfUpd is DB\_UPD\_KEYFIELDS, then the current values in the bound columns

 are used to determine which row(s) in the table are to be updated. The 
 exception to this is when a datasource supports ROW IDs (Oracle).  The ROW ID
 column is used for efficiency purposes when available.
 are used to determine which row(s) in the table are to be updated. The 
 exception to this is when a datasource supports ROW IDs (Oracle).  The ROW ID
 column is used for efficiency purposes when available.


@@ -2129,10 +2195,10 @@ by this function.
 
 \docparam{pSqlStmt}{Pointer to storage for the SQL statement retrieved.  To be
 sure you have adequate space allocated for the SQL statement, allocate
 
 \docparam{pSqlStmt}{Pointer to storage for the SQL statement retrieved.  To be
 sure you have adequate space allocated for the SQL statement, allocate

-DB_MAX_STATEMENT_LEN bytes.}
+DB\_MAX\_STATEMENT\_LEN bytes.}

 \docparam{typeOfUpd}{The type of update statement being performed.  Can be one
 \docparam{typeOfUpd}{The type of update statement being performed.  Can be one

-of two values: DB_UPD_KEYFIELDS or DB_UPD_WHERE.}
-\docparam{pWhereClause}{{\it OPTIONAL}.  If the typeOfUpd is DB_UPD_WHERE, 
+of two values: DB\_UPD\_KEYFIELDS or DB\_UPD\_WHERE.}
+\docparam{pWhereClause}{{\it OPTIONAL}.  If the typeOfUpd is DB\_UPD\_WHERE, 

 then you must also pass in a SQL WHERE clause in this argument. Default is "".}
 
 \wxheading{Remarks}
 then you must also pass in a SQL WHERE clause in this argument. Default is "".}
 
 \wxheading{Remarks}


@@ -2160,9 +2226,9 @@ does NOT include the word 'WHERE'.
 
 \docparam{pWhereClause}{Pointer to storage for the SQL statement retrieved.  
 To be sure you have adequate space allocated for the SQL statement, allocate
 
 \docparam{pWhereClause}{Pointer to storage for the SQL statement retrieved.  
 To be sure you have adequate space allocated for the SQL statement, allocate

-DB_MAX_STATEMENT_LEN bytes.}
+DB\_MAX\_STATEMENT\_LEN bytes.}

 \docparam{typeOfWhere}{The type of where clause to generate.  Can be one of 
 \docparam{typeOfWhere}{The type of where clause to generate.  Can be one of 

-two values:  DB_WHERE_KEYFIELDS or DB_WHERE_MATCHING.}
+two values:  DB\_WHERE\_KEYFIELDS or DB\_WHERE\_MATCHING.}

 \docparam{qualTableName}{{\it OPTIONAL}.  Prepended to all base table 
 column names.  For use when a FROM clause has been specified with the 
 \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause}, 
 \docparam{qualTableName}{{\it OPTIONAL}.  Prepended to all base table 
 column names.  For use when a FROM clause has been specified with the 
 \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause}, 


@@ -2177,7 +2243,7 @@ This member function allows you to see what the SQL WHERE clause looks like
 that the ODBC class library builds.  This can be used for debugging purposes
 if you are having problems executing your own SQL statements.
 
 that the ODBC class library builds.  This can be used for debugging purposes
 if you are having problems executing your own SQL statements.
 

-If using 'typeOfWhere' set to DB_WHERE_MATCHING, any bound columns currently
+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.
 
 containing a NULL value are not included in the WHERE clause's list of
 columns to use in the comparison.
 


@@ -2198,7 +2264,7 @@ Not all datasources support the "FOR UPDATE" clause, so you must use this
 member function to determine if the datasource currently connected to supports
 this behavior or not before trying to select using "FOR UPDATE".
 
 member function to determine if the datasource currently connected to supports
 this behavior or not before trying to select using "FOR UPDATE".
 

-If the wxDbTable instance was created with the parameter wxDB_QUERY_ONLY, then 
+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.
 
 this function will return FALSE.  For all known databases which do not support 
 the FOR UPDATE clause, this function will return FALSE also.
 


@@ -2249,7 +2315,7 @@ to an Oracle datasource or not.
 
 \membersection{wxDbTable::ClearMemberVar}\label{wxdbtableclearmembervar}
 
 
 \membersection{wxDbTable::ClearMemberVar}\label{wxdbtableclearmembervar}
 

-\func{void}{ClearMemberVar}{\param{int }{colNo}, \param{bool }{setToNull=FALSE}}
+\func{void}{ClearMemberVar}{\param{UWORD }{colNo}, \param{bool }{setToNull=FALSE}}

 
 Same as \helpref{wxDbTable::ClearMemberVars}{wxdbtableclearmembervars} except
 that this function clears only the specified column of its values, and 
 
 Same as \helpref{wxDbTable::ClearMemberVars}{wxdbtableclearmembervars} except
 that this function clears only the specified column of its values, and 


@@ -2308,7 +2374,7 @@ Typically handled internally by the ODBC class library, but may be used by the
 programmer if desired.
 
 
 programmer if desired.
 
 

-\normalbox{DO NOT CLOSE THE wxDB_DEFAULT_CURSOR!}
+\normalbox{DO NOT CLOSE THE wxDB\_DEFAULT\_CURSOR!}

 
 
 \membersection{wxDbTable::Count}\label{wxdbtablecount}
 
 
 \membersection{wxDbTable::Count}\label{wxdbtablecount}


@@ -2320,7 +2386,7 @@ current query parameters specified in the WHERE and FROM clauses.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{args}{{\it OPTIONAL}.  This arguement allows the use of the 
+\docparam{args}{{\it OPTIONAL}.  This argument allows the use of the 

 DISTINCT keyword against a column name to cause the returned count to 
 only indicate the number of rows in the result set that have a unique 
 value in the specified column.  An example is shown below.  Default is "*", 
 DISTINCT keyword against a column name to cause the returned count to 
 only indicate the number of rows in the result set that have a unique 
 value in the specified column.  An example is shown below.  Default is "*", 


@@ -2369,7 +2435,7 @@ this function.
 \membersection{wxDbTable::CreateIndex}\label{wxdbtablecreateindex}
 
 \func{bool}{CreateIndex}{\param{const wxString &}{idxName}, \param{bool }{unique}, 
 \membersection{wxDbTable::CreateIndex}\label{wxdbtablecreateindex}
 
 \func{bool}{CreateIndex}{\param{const wxString &}{idxName}, \param{bool }{unique}, 

-\param{int }{noIdxCols}, \param{wxDbIdxDef *}{pIdxDefs}, 
+\param{UWORD }{noIdxCols}, \param{wxDbIdxDef *}{pIdxDefs}, 

 \param{bool }{attemptDrop=TRUE}}
 
 This member function allows you to create secondary (non primary) indexes on 
 \param{bool }{attemptDrop=TRUE}}
 
 This member function allows you to create secondary (non primary) indexes on 


@@ -2398,7 +2464,7 @@ name provided before trying to create the index name.  Default is TRUE.}
 The first parameter, index name, must be unique and should be given a 
 meaningful name.  Common practice is to include the table name as a prefix 
 in the index name (e.g. For table PARTS, you might want to call your index 
 The first parameter, index name, must be unique and should be given a 
 meaningful name.  Common practice is to include the table name as a prefix 
 in the index name (e.g. For table PARTS, you might want to call your index 

-PARTS_IDX1).  This will allow you to easily view all 
+PARTS\_IDX1).  This will allow you to easily view all 

 of the indexes defined for a given table grouped together alphabetically.
 
 The second parameter indicates if the index is unique or not.  Uniqueness 
 of the indexes defined for a given table grouped together alphabetically.
 
 The second parameter indicates if the index is unique or not.  Uniqueness 


@@ -2484,11 +2550,11 @@ It is not necessary to call \helpref{wxDb::CommitTrans}{wxdbcommittrans}
 after executing this function.
 
 
 after executing this function.
 
 

-\membersection{wxDbTable::DB_STATUS}\label{wxdbtabledbstatus}
+\membersection{wxDbTable::DB\_STATUS}\label{wxdbtabledbstatus}

 
 

-\func{bool}{DB_STATUS}{\void}
+\func{bool}{DB\_STATUS}{\void}

 
 

-Accessor function that returns the wxDb private member variable DB_STATUS for 
+Accessor function that returns the wxDb private member variable DB\_STATUS for 

 the database connection used by this instance of wxDbTable.
 
 
 the database connection used by this instance of wxDbTable.
 
 


@@ -2541,7 +2607,7 @@ NOTE: If the cursor could not be deleted for some reason, an error is logged
 indicating the reason.  Even if the cursor could not be deleted, the HSTMT 
 that is passed in is deleted, and the pointer is set to NULL.
 
 indicating the reason.  Even if the cursor could not be deleted, the HSTMT 
 that is passed in is deleted, and the pointer is set to NULL.
 

-\normalbox{DO NOT DELETE THE wxDB_DEFAULT_CURSOR!}
+\normalbox{DO NOT DELETE THE wxDB\_DEFAULT\_CURSOR!}

 
 
 \membersection{wxDbTable::DeleteMatching}\label{wxdbtabledeletematching}
 
 
 \membersection{wxDbTable::DeleteMatching}\label{wxdbtabledeletematching}


@@ -2789,7 +2855,7 @@ return FALSE, and the data contained in the bound columns will be undefined.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxDb::FwdOnlyCursors}{wxdbfwdonlycursors}
+\helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors}

 
 
 \membersection{wxDbTable::GetFromClause}\label{wxdbtablegetfromclause}
 
 
 \membersection{wxDbTable::GetFromClause}\label{wxdbtablegetfromclause}


@@ -2824,7 +2890,7 @@ return FALSE, and the data contained in the bound columns will be undefined.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxDb::FwdOnlyCursors}{wxdbfwdonlycursors}
+\helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors}

 
 
 \membersection{wxDbTable::GetNewCursor}\label{wxdbtablegetnewcursor}
 
 
 \membersection{wxDbTable::GetNewCursor}\label{wxdbtablegetnewcursor}


@@ -2879,7 +2945,7 @@ This function works with both forward and backward scrolling cursors.
 
 \membersection{wxDbTable::GetNumberOfColumns}\label{wxdbtablegetnumberofcolumns}
 
 
 \membersection{wxDbTable::GetNumberOfColumns}\label{wxdbtablegetnumberofcolumns}
 

-\func{int }{GetNumberOfColumns}{}
+\func{UWORD }{GetNumberOfColumns}{}

 
 Accessor function that returns the number of columns that are statically 
 bound for access by the wxDbTable instance.
 
 Accessor function that returns the number of columns that are statically 
 bound for access by the wxDbTable instance.


@@ -2923,7 +2989,7 @@ return FALSE, and the data contained in the bound columns will be undefined.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxDb::FwdOnlyCursors}{wxdbfwdonlycursors}, 
+\helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors}, 

 \helpref{wxDbTable::--}{wxdbtableminusminus}
 
 
 \helpref{wxDbTable::--}{wxdbtableminusminus}
 
 


@@ -2951,7 +3017,7 @@ Returns the ODBC row number for performing positioned updates and deletes.
 This function is not being used within the ODBC class library and may be a 
 candidate for removal if no use is found for it.
 
 This function is not being used within the ODBC class library and may be a 
 candidate for removal if no use is found for it.
 

-Row nuumber with some datasources/ODBC drivers is the position in the result set, 
+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.
 
 while in others it may be a physical position in the database.  Check your 
 database documentation to find out which behavior is supported.
 


@@ -3022,7 +3088,7 @@ this function to commit or rollback the insertion.
     wxStrcpy(parts->PartName, "10");
     wxStrcpy(parts->PartDesc, "Part #10");
     parts->Qty = 1000;
     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:
     switch(retcode)
     {
         case DB_SUCCESS:


@@ -3043,7 +3109,7 @@ this function to commit or rollback the insertion.
 
 \membersection{wxDbTable::IsColNull}\label{wxdbtableiscolnull}
 
 
 \membersection{wxDbTable::IsColNull}\label{wxdbtableiscolnull}
 

-\func{bool }{IsColNull}{\param{int }{colNo}}
+\func{bool }{IsColNull}{\param{UWORD }{colNo}} const

 
 Used primarily in the ODBC class library to determine if a column value is 
 set to "NULL".  Works for all data types supported by the ODBC class library.
 
 Used primarily in the ODBC class library to determine if a column value is 
 set to "NULL".  Works for all data types supported by the ODBC class library.


@@ -3052,7 +3118,7 @@ set to "NULL".  Works for all data types supported by the ODBC class library.
 
 \docparam{colNo}{The column number of the bound column as defined by the 
 \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs} 
 
 \docparam{colNo}{The column number of the bound column as defined by the 
 \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs} 

-calls which defined the columns accesible to this wxDbTable instance.}
+calls which defined the columns accessible to this wxDbTable instance.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -3065,7 +3131,7 @@ NULL column support is currently not fully implemented as of wxWindows 2.4
 
 Accessor function to return information collected during the opening of the 
 datasource connection that is used by this wxDbTable instance.  The result 
 
 Accessor function to return information collected during the opening of the 
 datasource connection that is used by this wxDbTable instance.  The result 

-returned by this function indicates whether an implicit closing of the curosr is 
+returned by this function indicates whether an implicit closing of the cursor is 

 done after a commit on the database connection.
 
 \wxheading{Return value}
 done after a commit on the database connection.
 
 \wxheading{Return value}


@@ -3092,11 +3158,11 @@ wxDbTable instance that would modify (insert/delete/update) the table's data.
 
 \membersection{wxDbTable::Open}\label{wxdbtableopen}
 
 
 \membersection{wxDbTable::Open}\label{wxdbtableopen}
 

-\func{bool }{Open}{\param{bool }{checkPrivileges=FALSE}}
+\func{bool }{Open}{\param{bool }{checkPrivileges=FALSE}, \param{bool }{checkTableExists=TRUE}}

 
 Every wxDbTable instance must be opened before it can be used.  This function 
 checks for the existence of the requested table, binds columns, creates required 
 
 Every wxDbTable instance must be opened before it can be used.  This function 
 checks for the existence of the requested table, binds columns, creates required 

-cursors, (insert/select and update if connection is not wxDB_QUERY_ONLY) and 
+cursors, (insert/select and update if connection is not wxDB\_QUERY\_ONLY) and 

 constructs the insert statement that is to be used for inserting data as a new 
 row in the datasource.
 
 constructs the insert statement that is to be used for inserting data as a new 
 row in the datasource.
 


@@ -3106,14 +3172,17 @@ row in the datasource.
 whether the current connected user has at least SELECT privileges to access the 
 table to which they are trying to open.  Default is FALSE.}
 
 whether the current connected user has at least SELECT privileges to access the 
 table to which they are trying to open.  Default is FALSE.}
 

+\docparam{checkTableExists}{Indicates whether the Open() function should check 
+whether the table exists in the database or not before opening it.  Default is TRUE.}
+

 \wxheading{Remarks}
 
 If the function returns a FALSE value due to the table not existing, a log 
 entry is recorded for the datasource connection indicating the problem 
 that was detected when checking for table existence.  Note that it is usually 
 best for the calling routine to check for the existence of the table and for 
 \wxheading{Remarks}
 
 If the function returns a FALSE value due to the table not existing, a log 
 entry is recorded for the datasource connection indicating the problem 
 that was detected when checking for table existence.  Note that it is usually 
 best for the calling routine to check for the existence of the table and for 

-sufficent user privileges to access the table in the mode (wxDB_QUERY_ONLY or 
-!wxDB_QUERY_ONLY) before trying to open the table for the best possible 
+sufficent user privileges to access the table in the mode (wxDB\_QUERY\_ONLY or 
+!wxDB\_QUERY\_ONLY) before trying to open the table for the best possible 

 explanation as to why a table cannot be opened.
 
 Checking the user's privileges on a table can be quite time consuming during 
 explanation as to why a table cannot be opened.
 
 Checking the user's privileges on a table can be quite time consuming during 


@@ -3151,7 +3220,7 @@ used as a synonym for
 alphabetized/numeric sorting sequence that the result set is to be returned 
 in.  If a FROM clause has also been specified, each column name specified in 
 the ORDER BY clause should be prefaced with the table name to which the column 
 alphabetized/numeric sorting sequence that the result set is to be returned 
 in.  If a FROM clause has also been specified, each column name specified in 
 the ORDER BY clause should be prefaced with the table name to which the column 

-belongs using DOT notation (TABLE_NAME.COLUMN_NAME).}
+belongs using DOT notation (TABLE\_NAME.COLUMN\_NAME).}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 


@@ -3190,7 +3259,7 @@ wxDbTable members: "where", "orderBy", and "from".  Use
 records to be retrieved (e.g. All users with a first name of "JOHN").  
 Use \helpref{wxDbTable::SetOrderByClause}{wxdbtablesetorderbyclause} to 
 change the sequence in which records are returned in the result set from 
 records to be retrieved (e.g. All users with a first name of "JOHN").  
 Use \helpref{wxDbTable::SetOrderByClause}{wxdbtablesetorderbyclause} to 
 change the sequence in which records are returned in the result set from 

-the datasource (e.g. Ordered by LAST_NAME).  Use 
+the datasource (e.g. Ordered by LAST\_NAME).  Use 

 \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause} to allow outer 
 joining of the base table (the one being associated with this instance of 
 wxDbTable) with other tables which share a related field.  
 \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause} to allow outer 
 joining of the base table (the one being associated with this instance of 
 wxDbTable) with other tables which share a related field.  


@@ -3288,7 +3357,7 @@ The requirements of the SELECT statement are the following:
        float for column 3 (e.g. PRICE * 1.10 to increase the price by 
        10%).
 
        float for column 3 (e.g. PRICE * 1.10 to increase the price by 
        10%).
 

-    3. The ROWID can be included in your SELECT statement as the {\bf last}
+    3. The ROWID can be included in your SELECT statement as the {\bf last} 

        column selected, if the datasource supports it.  Use 
        wxDbTable::CanUpdByROWID() to determine if the ROWID can be 
        selected from the datasource.  If it can, much better 
        column selected, if the datasource supports it.  Use 
        wxDbTable::CanUpdByROWID() to determine if the ROWID can be 
        selected from the datasource.  If it can, much better 


@@ -3361,9 +3430,9 @@ either \helpref{wxDbTable::GetFirst}{wxdbtablegetfirst} or
 QueryMatching allows querying of records from the table associated with 
 the wxDbTable object by matching "columns" to values.  
 
 QueryMatching allows querying of records from the table associated with 
 the wxDbTable object by matching "columns" to values.  
 

-For example: To query the datasource for the row with a PART_NUMBER column 
+For example: To query the datasource for the row with a PART\_NUMBER column 

 value of "32", clear all column variables of the wxDbTable object, set the 
 value of "32", clear all column variables of the wxDbTable object, set the 

-PartNumber variable that is bound to the PART_NUMBER column in the wxDbTable 
+PartNumber variable that is bound to the PART\_NUMBER column in the wxDbTable 

 object to "32", and then call wxDbTable::QueryMatching().
 
 \wxheading{Parameters}
 object to "32", and then call wxDbTable::QueryMatching().
 
 \wxheading{Parameters}


@@ -3493,12 +3562,12 @@ table's columns are refreshed to reflect the current data in the database.
 
 \membersection{wxDbTable::SetColDefs}\label{wxdbtablesetcoldefs}
 
 
 \membersection{wxDbTable::SetColDefs}\label{wxdbtablesetcoldefs}
 

-\func{void}{SetColDefs}{\param{int }{index}, \param{const wxString &}{fieldName}, 
-\param{int }{dataType}, \param{void *}{pData}, \param{int }{cType}, 
+\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}}
 
 \param{int }{size}, \param{bool }{keyField = FALSE}, \param{bool }{upd = TRUE}, 
 \param{bool }{insAllow = TRUE}, \param{bool }{derivedCol = FALSE}}
 

-\func{wxDbColDataPtr *}{SetColDefs}{\param{wxDbColInf *}{colInfs}, \param{ULONG }{numCols}}
+\func{wxDbColDataPtr *}{SetColDefs}{\param{wxDbColInf *}{colInfs}, \param{UWORD }{numCols}}

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -3590,14 +3659,14 @@ were to be copied over to another datasource or table.
 
 \membersection{wxDbTable::SetCursor}\label{wxdbtablesetcursor}
 
 
 \membersection{wxDbTable::SetCursor}\label{wxdbtablesetcursor}
 

-\func{bool}{SetCursor}{\param{HSTMT *}{hstmtActivate = (void **) wxDB_DEFAULT_CURSOR}}
+\func{bool}{SetCursor}{\param{HSTMT *}{hstmtActivate = (void **) wxDB\_DEFAULT\_CURSOR}}

 
 \wxheading{Parameters}
 
 \docparam{hstmtActivate}{{\it OPTIONAL}.  Pointer to the cursor that is to 
 become the current cursor.  Passing no cursor handle will reset the cursor 
 back to the wxDbTable's default (original) cursor that was created when the 
 
 \wxheading{Parameters}
 
 \docparam{hstmtActivate}{{\it OPTIONAL}.  Pointer to the cursor that is to 
 become the current cursor.  Passing no cursor handle will reset the cursor 
 back to the wxDbTable's default (original) cursor that was created when the 

-wxDbTable instance was first created.  Default is wxDB_DEFAULT_CURSOR.}
+wxDbTable instance was first created.  Default is wxDB\_DEFAULT\_CURSOR.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -3670,7 +3739,7 @@ the datasource knows on which column values the tables should be joined on.
 
 \membersection{wxDbTable::SetColNull}\label{wxdbtablesetcolnull}
 
 
 \membersection{wxDbTable::SetColNull}\label{wxdbtablesetcolnull}
 

-\func{bool}{SetColNull}{\param{int }{colNo}, \param{bool }{set=TRUE}}
+\func{bool}{SetColNull}{\param{UWORD }{colNo}, \param{bool }{set=TRUE}}

 
 \func{bool}{SetColNull}{\param{const wxString &}{colName}, 
 \param{bool }{set=TRUE}}
 
 \func{bool}{SetColNull}{\param{const wxString &}{colName}, 
 \param{bool }{set=TRUE}}


@@ -3715,7 +3784,7 @@ A synonym to this function is one form of the function \helpref{wxDbTable::Order
 alphabetized sorting sequence that the result set is to be returned in.  If 
 a FROM clause has also been specified, each column name specified in the 
 ORDER BY clause should be prefaced with the table name to which the column 
 alphabetized sorting sequence that the result set is to be returned in.  If 
 a FROM clause has also been specified, each column name specified in the 
 ORDER BY clause should be prefaced with the table name to which the column 

-belongs using DOT notation (TABLE_NAME.COLUMN_NAME).}
+belongs using DOT notation (TABLE\_NAME.COLUMN\_NAME).}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -3772,7 +3841,7 @@ A synonym to this function is one form of the function \helpref{wxDbTable::Where
 that is legal in standard where clauses.  If a FROM clause has also been 
 specified, each column name specified in the ORDER BY clause should be 
 prefaced with the table name to which the column belongs using DOT notation 
 that is legal in standard where clauses.  If a FROM clause has also been 
 specified, each column name specified in the ORDER BY clause should be 
 prefaced with the table name to which the column belongs using DOT notation 

-(TABLE_NAME.COLUMN_NAME).}
+(TABLE\_NAME.COLUMN\_NAME).}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -3947,3 +4016,10 @@ A pointer to a wxDbColInf array instance is included so a program can create a
 to maintain all information about the columns of a table in one memory 
 structure.
 
 to maintain all information about the columns of a table in one memory 
 structure.
 

+Eventually, accessor functions will be added for this class
+
+\membersection{wxDbTableInf::Initialize}\label{wxdbtableinfinitialize}
+
+Simply initializes all member variables to a cleared state.  Called by 
+the constructor automatically.
+