X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..a124f99a24fb1f2ef41e37223ea35bcc9a4eece9:/docs/latex/wx/database.tex

diff --git a/docs/latex/wx/database.tex b/docs/latex/wx/database.tex
index cf155b86ca..3f188cae4e 100644
--- a/docs/latex/wx/database.tex
+++ b/docs/latex/wx/database.tex
@@ -1,15 +1,26 @@
 \section{\class{wxDatabase}}\label{wxdatabase}
 
-Every database object represents an ODBC connection. The connection may be closed and reopened.
+Every database object represents an ODBC connection.
+The connection may be closed and reopened.
 
-\wxheading{Derivation}
+\wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/odbc.h>
+
 \wxheading{See also}
 
 \overview{wxDatabase overview}{wxdatabaseoverview}, \helpref{wxRecordSet}{wxrecordset}
 
+A much more robust and feature-rich set of ODBC classes is now
+available and recommended for use in place of the wxDatabase class.
+
+See details of these classes in:
+\helpref{wxDb}{wxdb}, \helpref{wxDbTable}{wxdbtable}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDatabase::wxDatabase}
@@ -66,20 +77,6 @@ and disconnects from the current data source.
 
 Commits previous transactions. Not implemented.
 
-\membersection{wxDatabase::ErrorOccured}
-
-\func{bool}{ErrorOccured}{\void}
-
-Returns TRUE if the last action caused an error.
-
-\membersection{wxDatabase::ErrorSnapshot}
-
-\func{void}{ErrorSnapshot}{\param{HSTMT}{ statement = SQL\_NULL\_HSTMT}}
-
-This function will be called whenever an ODBC error occured. It stores the
-error related information returned by ODBC. If a statement handle of the
-concerning ODBC action is available it should be passed to the function.
-
 \membersection{wxDatabase::GetDatabaseName}
 
 \func{wxString}{GetDatabaseName}{\void}
@@ -91,7 +88,7 @@ Returns the name of the database associated with the current connection.
 \func{wxString}{GetDataSource}{\void}
 
 Returns the name of the connected data source.
-  
+
 \membersection{wxDatabase::GetErrorClass}
 
 \func{wxString}{GetErrorClass}{\void}
@@ -141,14 +138,14 @@ Returns the current ODBC database handle.
 \func{HENV}{GetHENV}{\void}
 
 Returns the ODBC environment handle. 
-  
+
 \membersection{wxDatabase::GetInfo}
 
 \func{bool}{GetInfo}{\param{long}{ infoType}, \param{long *}{buf}}
 
 \func{bool}{GetInfo}{\param{long}{ infoType}, \param{const wxString\& }{buf}, \param{int}{ bufSize=-1}}
 
-Returns requested information. The return value is TRUE if successful, FALSE otherwise.
+Returns requested information. The return value is true if successful, false otherwise.
 
 {\it infoType} is an ODBC identifier specifying the type of information to be returned.
 
@@ -172,11 +169,11 @@ Returns the current username.
 
 \membersection{wxDatabase::GetODBCVersionFloat}
 
-\func{float}{GetODBCVersionFloat}{\param{bool}{ implementation=TRUE}}
+\func{float}{GetODBCVersionFloat}{\param{bool}{ implementation=true}}
 
 Returns the version of ODBC in floating point format, e.g. 2.50.
 
-{\it implementation} should be TRUE to get the DLL version, or FALSE to get the
+{\it implementation} should be true to get the DLL version, or false to get the
 version defined in the {\tt sql.h} header file.
 
 This function can return the value 0.0 if the header version number is not defined (for early
@@ -184,11 +181,11 @@ versions of ODBC).
 
 \membersection{wxDatabase::GetODBCVersionString}
 
-\func{wxString}{GetODBCVersionString}{\param{bool}{ implementation=TRUE}}
+\func{wxString}{GetODBCVersionString}{\param{bool}{ implementation=true}}
 
 Returns the version of ODBC in string format, e.g. ``02.50".
 
-{\it implementation} should be TRUE to get the DLL version, or FALSE to get the
+{\it implementation} should be true to get the DLL version, or false to get the
 version defined in the {\tt sql.h} header file.
 
 This function can return the value ``00.00" if the header version number is not defined (for early
@@ -204,11 +201,11 @@ Not implemented.
 
 \func{bool}{IsOpen}{\void}
 
-Returns TRUE if a connection is open.
+Returns true if a connection is open.
 
 \membersection{wxDatabase::Open}\label{wxdatabaseopen}
 
-\func{bool}{Open}{\param{const wxString\& }{datasource}, \param{bool}{ exclusive = FALSE}, \param{bool }{readOnly = TRUE},
+\func{bool}{Open}{\param{const wxString\& }{datasource}, \param{bool}{ exclusive = false}, \param{bool }{readOnly = true},
  \param{const wxString\& }{username = ``ODBC"}, \param{const wxString\& }{password = ``"}}
 
 Connect to a data source. {\it datasource} contains the name of the ODBC data
@@ -219,7 +216,7 @@ source. The parameters exclusive and readOnly are not used.
 \func{void}{OnSetOptions}{\param{wxRecordSet *}{recordSet}}
 
 Not implemented.  
-  
+
 \membersection{wxDatabase::OnWaitForDataSource}
 
 \func{void}{OnWaitForDataSource}{\param{bool}{ stillExecuting}}
@@ -237,13 +234,13 @@ Sends a rollback to the ODBC driver. Not implemented.
 \func{void}{SetDataSource}{\param{const wxString\& }{s}}
 
 Sets the name of the data source. Not implemented.
-  
+
 \membersection{wxDatabase::SetLoginTimeout}
 
 \func{void}{SetLoginTimeout}{\param{long}{ seconds}}
 
 Sets the time to wait for an user login. Not implemented.
-  
+
 \membersection{wxDatabase::SetPassword}
 
 \func{void}{SetPassword}{\param{const wxString\& }{s}}
@@ -262,7 +259,7 @@ mode is supported, so this function has no effect.
 \func{void}{SetQueryTimeout}{\param{long}{ seconds}}
 
 Sets the time to wait for a response to a query. Not implemented.
- 
+
 \membersection{wxDatabase::SetUsername}
 
 \func{void}{SetUsername}{\param{const wxString\& }{s}}