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>
-
\wxheading{Helper classes and data structures}
The following classes and structs are defined in db.cpp/.h for use with the wxDb class.
\item \helpref{wxDbInf}{wxdbinf}
\end{itemize}
-
\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}
-
wxDB_PATH_MAX Maximum path length allowed to be passed to
the ODBC driver to indicate where the data
file(s) are located.
data type
\end{verbatim}
-
\subsection{Enumerated types}\label{wxdbenumeratedtypes}
+
\wxheading{Enumerated types}
\docparam{enum {\bf wxDbSqlLogState}}{sqlLogOFF, sqlLogON}
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.}
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
\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
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}}
+\param{bool }{FwdOnlyCursors=(bool)wxODBC\_FWD\_ONLY\_CURSORS}}
\wxheading{Remarks}
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}}
+\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}
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))
+ while (wxDbGetDataSource(DbConnectInf.GetHenv(), Dsn, SQL\_MAX\_DSN\_LENGTH+1, DsDesc, 255))
strList.Add(Dsn);
-
+\end{verbatim}
\latexignore{\rtfignore{\wxheading{Members}}}
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.
\wxheading{See also}
-\helpref{wxDbGetConnection}{wxdbfunctions},
-
+\helpref{wxDbGetConnection}{wxdbfunctions}
\membersection{wxDb::Catalog}\label{wxdbcatalog}
-\func{bool}{Catalog}{\param{wxChar *}{ userID}, \param{const wxString &}{fileName =
-SQL_CATALOG_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
information about all data tables to which the user specified in userID has
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}
\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
\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
\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
return(db.DispAllErrors(db.henv, db.hdbc, hstmt));
\end{verbatim}
-
\membersection{wxDb::DispNextError}\label{wxdbdispnexterror}
\func{void}{DispNextError}{\void}
\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'.
\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.
\helpref{wxDb::GetData}{wxdbgetdata}, \helpref{wxDb::GetNext}{wxdbgetnext}
-
\membersection{wxDb::FwdOnlyCursors}\label{wxdbfwdonlycursors}
\func{bool}{IsFwdOnlyCursors}{\void}
\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}
\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.}
-\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:}
}
\end{verbatim}
-
\membersection{wxDb::GetData}\label{wxdbgetdata}
\func{bool}{GetData}{\param{UWORD}{ colNo}, \param{SWORD}{ cType},
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
+actual data returned. If this value comes back as SQL\_NULL\_DATA, then the
\helpref{wxDb::GetData}{wxdbgetdata} call has failed.}
\wxheading{See also}
\membersection{wxDb::GetDatasourceName}\label{wxdbgetdatasourcename}
-\func{const wxString &}{GetDatasourceName}{\void}
+\func{const wxString \&}{GetDatasourceName}{\void}
Returns the ODBC datasource name.
\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.
\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}
\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.
\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.
\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.
\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}
db.Grant(DB_GRANT_SELECT | DB_GRANT_INSERT, "PARTS", "mary, sue");
\end{verbatim}
-
\membersection{wxDb::IsFwdOnlyCursors}\label{wxdbisfwdonlycursors}
\func{bool}{IsFwdOnlyCursors}{\void}
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}).
\helpref{wxDb constructor}{wxdbconstr}, \helpref{wxDbGetConnection}{wxdbfunctions}
-
\membersection{wxDb::IsOpen}\label{wxdbisopen}
\func{bool}{IsOpen}{\void}
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.}
\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.
\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'
-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
\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}}
}
\end{verbatim}
-
\membersection{wxDb::RollbackTrans}\label{wxdbrollbacktrans}
\func{bool}{RollbackTrans}{\void}
\helpref{wxDb::CommitTrans}{wxdbcommittrans} for a special note on cursors
-
\membersection{wxDb::SetDebugErrorMessages}\label{wxdbsetdebugerrormessages}
\func{void}{SetDebugErrorMessages}{\param{bool }{state}}
\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}
\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}
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=""}}
+\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
\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
{\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.
\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.}
\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.
\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}
-\func{bool}{WriteSqlLog}{\param{const wxString &}{logMsg}}
+\func{bool}{WriteSqlLog}{\param{const wxString \&}{logMsg}}
\wxheading{Parameters}
\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;
- int SqlCtype;
+ SWORD SqlCtype;
\end{verbatim}
-
\section{\class{wxDbColDef}}\label{wxdbcoldef}
This class is used to hold information about the columns bound to an
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
\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}
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
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.
\helpref{wxDConnectInf::AllocHenv}{wxdbconnectinfallochenv},
\helpref{wxDConnectInf::FreeHenv}{wxdbconnectinffreehenv}
-
\membersection{wxDbConnectInf::\destruct{wxDbConnectInf}}\label{wxdbconnectinfdestr}
\func{}{\destruct{wxDbConnectInf}}{}
\helpref{wxDConnectInf::FreeHenv}{wxdbconnectinffreehenv} to free the
SQL environment handle.
-
\membersection{wxDbConnectInf::AllocHenv}\label{wxdbconnectinfallochenv}
\func{bool }{AllocHenv}{\void}
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}
\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}
Synonymous with \helpref{wxDbConnectInf::GetPassword}{wxdbconnectinfgetpassword}
-
\membersection{wxDbConnectInf::GetDefaultDir}\label{wxdbconnectinfgetdefaultdir}
\func{const wxChar *}{GetDefaultDir}{\void}
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}
NOTE: Description is a FUTURE USE item and is unused currently.
-
\membersection{wxDbConnectInf::GetDsn}\label{wxdbconnectinfgetdsn}
\func{const wxChar *}{GetDsn}{\void}
Accessor function to return the datasource name assigned for this class
instance.
-
\membersection{wxDbConnectInf::GetFileType}\label{wxdbconnectinfgetfiletype}
\func{const wxChar *}{GetFileType}{\void}
NOTE: FileType is a FUTURE USE item and is unused currently.
-
\membersection{wxDbConnectInf::GetHenv}\label{wxdbconnectinfgethenv}
\func{const HENV}{GetHenv}{\void}
Accessor function to return the SQL environment handle being managed
by this class instance.
-
\membersection{wxDbConnectInf::GetPassword}\label{wxdbconnectinfgetpassword}
\func{const wxChar *}{GetPassword}{\void}
Synonymous with \helpref{wxDbConnectInf::GetAuthStr}{wxdbconnectinfgetauthstr}
-
\membersection{wxDbConnectInf::GetUid}\label{wxdbconnectinfgetuid}
\func{const wxChar *}{GetUid}{\void}
Accessor function to return the user ID assigned for this class
instance.
-
\membersection{wxDbConnectInf::GetUserID}\label{wxdbconnectinfgetuserid}
\func{const wxChar *}{GetUserID}{\void}
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
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}
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>\\
\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 = ""}}
+\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.
\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
\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 "".}
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.
\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
-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 "".}
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
\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
-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}
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.
-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.
\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
-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}
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'
\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
-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},
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.
-
\membersection{wxDbTable::CanSelectForUpdate}\label{wxdbtablecanselectforupdate}
\func{bool}{CanSelectForUpdate}{\void}
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.
-
\membersection{wxDbTable::CanUpdateByROWID}\label{wxdbtablecanupdatebyrowid}
\func{bool}{CanUpdateByROWID}{\void}
\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
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}}
3) Call wxDbTable::QueryMatching() or wxDbTable::DeleteMatching()
\end{verbatim}
-
\membersection{wxDbTable::CloseCursor}\label{wxdbtableclosecursor}
\func{bool}{CloseCursor}{\param{HSTMT}{cursor}}
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!}
-
+\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.
totalNumberOfUniqueFirstNames = users.Count("DISTINCT FIRST_NAME");
\end{verbatim}
-
\membersection{wxDbTable::CreateIndex}\label{wxdbtablecreateindex}
-\func{bool}{CreateIndex}{\param{const wxString &}{idxName}, \param{bool }{unique},
-\param{int }{noIdxCols}, \param{wxDbIdxDef *}{pIdxDefs},
+\func{bool}{CreateIndex}{\param{const wxString \&}{idxName}, \param{bool }{unique},
+\param{UWORD }{noIdxCols}, \param{wxDbIdxDef *}{pIdxDefs},
\param{bool }{attemptDrop=TRUE}}
This member function allows you to create secondary (non primary) indexes on
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
parts->CreateIndex(indexName, TRUE, 2, idxDef);
\end{verbatim}
-
\membersection{wxDbTable::CreateTable}\label{wxdbtablecreatetable}
\func{bool}{CreateTable}{\param{bool }{attemptDrop=TRUE}}
It is not necessary to call \helpref{wxDb::CommitTrans}{wxdbcommittrans}
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.
-
\membersection{wxDbTable::Delete}\label{wxdbtabledelete}
\func{bool}{Delete}{\void}
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}}
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}
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}
\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.
\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.
It is not necessary to call \helpref{wxDb::CommitTrans}{wxdbcommittrans}
after executing this function.
-
\membersection{wxDbTable::DropTable}\label{wxdbtabledroptable}
\func{bool}{DropTable}{\void}
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}
These column definitions must not be manually redefined after they have been
set.
-
\membersection{wxDbTable::GetCursor}\label{wxdbtablegetcursor}
\func{HSTMT}{GetCursor}{\void}
\helpref{wxDbTable::SetCursor}{wxdbtablesetcursor}, \helpref{wxDbTable::GetNewCursor}{wxdbtablegetnewcursor}
-
\membersection{wxDbTable::GetDb}\label{wxdbtablegetdb}
\func{wxDb *}{GetDb}{}
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}
\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}.
\helpref{wxDbTable::From}{wxdbtablefrom}
-
\membersection{wxDbTable::GetLast}\label{wxdbtablegetlast}
\func{bool}{GetLast}{\void}
\helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors}
-
\membersection{wxDbTable::GetNewCursor}\label{wxdbtablegetnewcursor}
\func{HSTMT *}{GetNewCursor}{\param{bool }{setCursor=FALSE},
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}
\wxheading{See also}
\helpref{wxDbTable::++}{wxdbtableplusplus}
-
\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.
-
\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}.
\helpref{wxDbTable::OrderBy}{wxdbtableorderby}
-
\membersection{wxDbTable::GetPrev}\label{wxdbtablegetprev}
\func{bool}{GetPrev}{\void}
\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
\helpref{wxDbTable constructor}{wxdbtableconstr}
-
\membersection{wxDbTable::GetRowNum}\label{wxdbtablegetrownum}
\func{UWORD}{GetRowNum}{\void}
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.
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}
\helpref{wxDbTable::Where}{wxdbtablewhere}
-
\membersection{wxDbTable::Insert}\label{wxdbtableinsert}
\func{int }{Insert}{\void}
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:
}
\end{verbatim}
-
\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.
\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}
which use the database connection are closed on the commit if this function
indicates TRUE.
-
\membersection{wxDbTable::IsQueryOnly}\label{wxdbtableisqueryonly}
\func{bool }{IsQueryOnly}{}
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}}
+\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
-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.
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
-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
\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
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}
\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}}
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.
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.
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
where device_id = 12)
\end{verbatim}
-
\membersection{wxDbTable::QueryMatching}\label{wxdbtablequerymatching}
\func{virtual bool }{QueryMatching}{\param{bool }{forUpdate=FALSE},
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
-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}
dispPart(parts); // Some application defined function
\end{verbatim}
-
\membersection{wxDbTable::QueryOnKeyFields}\label{wxdbtablequeryonkeyfields}
\func{bool }{QueryOnKeyFields}{\param{bool }{forUpdate=FALSE},
dispPart(parts); // Some application defined function
\end{verbatim}
-
\membersection{wxDbTable::Refresh}\label{wxdbtablerefresh}
\func{bool}{Refresh}{\void}
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{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}}
-\func{wxDbColDataPtr *}{SetColDefs}{\param{wxDbColInf *}{colInfs}, \param{ULONG }{numCols}}
+\func{wxDbColDataPtr *}{SetColDefs}{\param{wxDbColInf *}{colInfs}, \param{UWORD }{numCols}}
\wxheading{Parameters}
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}}
+\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
-wxDbTable instance was first created. Default is wxDB_DEFAULT_CURSOR.}
+wxDbTable instance was first created. Default is wxDB\_DEFAULT\_CURSOR.}
\wxheading{Remarks}
\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
\helpref{wxDbTable::From}{wxdbtablefrom},
\helpref{wxDbTable::GetFromClause}{wxdbtablegetfromclause}
-
\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},
+\func{bool}{SetColNull}{\param{const wxString \&}{colName},
\param{bool }{set=TRUE}}
Both forms of this function allow a member variable representing a column
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
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}
\helpref{wxDbTable::OrderBy}{wxdbtableorderby},
\helpref{wxDbTable::GetOrderByClause}{wxdbtablegetorderbyclause}
-
\membersection{wxDbTable::SetQueryTimeout}\label{wxdbtablesetquerytimeout}
\func{bool}{SetQueryTimeout}{\param{UDWORD }{nSeconds}}
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.
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}
\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
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}.
\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}
\helpref{wxDbTable::GetWhereClause}{wxdbtablegetwhereclause},
\helpref{wxDbTable::SetWhereClause}{wxdbtablesetwhereclause}
-
-
\membersection{wxDbTable::operator $++$}\label{wxdbtableplusplus}
\func{bool}{operator $++$}{\void}
\helpref{wxDbTable::GetNext}{wxdbtablegetnext}
-
\membersection{wxDbTable::operator $--$}\label{wxdbtableminusminus}
\func{bool}{operator $--$}{\void}
\helpref{wxDbTable::GetPrev}{wxdbtablegetprev}
-
\section{\class{wxDbTableInf}}\label{wxdbtableinf}
\begin{verbatim}
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).
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
the constructor automatically.
+