documented just added env functions

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

diff --git a/docs/latex/wx/tdb.tex b/docs/latex/wx/tdb.tex
index 28c43f79b7e935ae61663975f0041107adbeefba..1d2dae0ef2e71db5cd3141bfbefdc79b82c6a2af 100644 (file)
--- a/docs/latex/wx/tdb.tex
+++ b/docs/latex/wx/tdb.tex
@@ -3,10 +3,8 @@
 Classes: \helpref{wxDatabase}{wxdatabase}, \helpref{wxRecordSet}{wxrecordset}, \helpref{wxQueryCol}{wxquerycol},
 \rtfsp\helpref{wxQueryField}{wxqueryfield}
 
-\normalboxd{IMPORTANT NOTE: The ODBC classes are a preliminary release and incomplete. Please
-take this into account when using them. Feedback and bug fixes are appreciated,
-as always. The classes are being developed by Olaf Klein (oklein@smallo.ruhr.de) and
-Patrick Halke (patrick@zaphod.ruhr.de).}
+\normalboxd{Note that more sophisticated ODBC classes are provided by the Remstar
+database classes: please see the separate HTML and Word documentation.}
 
 wxWindows provides a set of classes for accessing a subset of Microsoft's ODBC (Open Database Connectivity)
 product. Currently, this wrapper is available under MS Windows only, although
@@ -19,7 +17,7 @@ file via an ODBC driver. The language for most of the database
 operations is SQL, so you need to learn a small amount of SQL as well as
 the wxWindows ODBC wrapper API. Even though the databases may not be
 SQL-based, the ODBC drivers translate SQL into appropriate operations
-for the database or file: even text files have rudimentry ODBC support,
+for the database or file: even text files have rudimentary ODBC support,
 along with dBASE, Access, Excel and other file formats.
 
 The run-time files for ODBC are bundled with many existing database
@@ -75,8 +73,6 @@ also get deleted, so beware of holding onto invalid pointers.
 
 \subsection{wxDatabase overview}\label{wxdatabaseoverview}
 
-\overview{Database classes overview}{odbcoverview}
-
 Class: \helpref{wxDatabase}{wxdatabase}
 
 Every database object represents an ODBC connection. To do anything useful
@@ -84,9 +80,11 @@ with a database object you need to bind a wxRecordSet object to it. All you
 can do with wxDatabase is opening/closing connections and getting some info
 about it (users, passwords, and so on).
 
-\subsection{wxQueryCol overview}\label{wxquerycoloverview}
+\wxheading{See also}
 
-\overview{Database classes overview}{odbcoverview}
+\helpref{Database classes overview}{odbcoverview}
+
+\subsection{wxQueryCol overview}\label{wxquerycoloverview}
 
 Class: \helpref{wxQueryCol}{wxquerycol}
 
@@ -95,9 +93,11 @@ It contains the name and type of a column and a list of wxQueryFields where
 the real data is stored. The links to user-defined variables are stored
 here, as well.
 
-\subsection{wxQueryField overview}\label{wxqueryfieldoverview}
+\wxheading{See also}
 
-\overview{Database classes overview}{odbcoverview}
+\helpref{Database classes overview}{odbcoverview}
+
+\subsection{wxQueryField overview}\label{wxqueryfieldoverview}
 
 Class: \helpref{wxQueryField}{wxqueryfield}
 
@@ -110,9 +110,11 @@ or wxRecordSet::GoTo. If wxRecordSet is of the type wxOPEN\_TYPE\_SNAPSHOT,
 all data returned by an ODBC function will be loaded at once and the number
 of wxQueryField instances for each column will depend on the number of records.
 
-\subsection{wxRecordSet overview}\label{wxrecordsetoverview}
+\wxheading{See also}
 
-\overview{Database classes overview}{odbcoverview}
+\helpref{Database classes overview}{odbcoverview}
+
+\subsection{wxRecordSet overview}\label{wxrecordsetoverview}
 
 Class: \helpref{wxRecordSet}{wxrecordset}
 
@@ -120,9 +122,11 @@ Each wxRecordSet represents a database query. You can make multiple queries
 at a time by using multiple wxRecordSets with a wxDatabase or you can make
 your queries in sequential order using the same wxRecordSet.
 
-\subsection{ODBC SQL data types}\label{sqltypes}
+\wxheading{See also}
+
+\helpref{Database classes overview}{odbcoverview}
 
-\overview{Database classes overview}{odbcoverview}
+\subsection{ODBC SQL data types}\label{sqltypes}
 
 These are the data types supported in ODBC SQL. Note that there are other, extended level conformance
 types, not currently supported in wxWindows.
@@ -155,13 +159,19 @@ These data types correspond to the following ODBC identifiers:
 \twocolitem{SQL\_DOUBLE}{Same as SQL\_FLOAT.}
 \end{twocollist}
 
-\subsection{A selection of SQL commands}\label{sqlcommands}
+\wxheading{See also}
+
+\helpref{Database classes overview}{odbcoverview}
 
-\overview{Database classes overview}{odbcoverview}
+\subsection{A selection of SQL commands}\label{sqlcommands}
 
 The following is a very brief description of some common SQL commands, with
 examples.
 
+\wxheading{See also}
+
+\helpref{Database classes overview}{odbcoverview}
+
 \subsubsection{Create}
 
 Creates a table.
@@ -236,5 +246,3 @@ Example:
 This example sets a field in column `X' to the number 123, for the record
 where the column ASSET has the value `BD34'.
 
-
-