X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fa482912e420a40e9f2e55a0f5407562826dd15e..d479632a8f5846d33a4ea13a9ceae158b78f57eb:/docs/latex/wx/database.tex diff --git a/docs/latex/wx/database.tex b/docs/latex/wx/database.tex index 6647678df7..3f188cae4e 100644 --- a/docs/latex/wx/database.tex +++ b/docs/latex/wx/database.tex @@ -3,9 +3,6 @@ Every database object represents an ODBC connection. The connection may be closed and reopened. -Note: this class is considered obsolete, replaced by the Remstar wxDB/wxTable classes -(documented separately in Word and PDF format, as odbc.doc and odbc.pdf). - \wxheading{Derived from} \helpref{wxObject}{wxobject} @@ -18,6 +15,12 @@ Note: this class is considered obsolete, replaced by the Remstar wxDB/wxTable cl \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} @@ -74,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} @@ -156,7 +145,7 @@ Returns the ODBC environment handle. \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. @@ -180,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 @@ -192,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 @@ -212,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