defs.h doubled include fixed.

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

diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex
index de0f0fbee4162b1ce4777ddf51dd1e2a5540e046..0eec6208cfc5845fba48c05148f6a728fc48ea6f 100644 (file)
--- a/docs/latex/wx/db.tex
+++ b/docs/latex/wx/db.tex
@@ -66,21 +66,22 @@ NOTE: In a future release, all ODBC class constants will be prefaced with 'wx'.
 
 These are the databases currently tested and working with the ODBC classes.  A call to \helpref{wxDb::Dbms}{wxdbdbms} will return one of these enumerated values listed below.
 
 
 These are the databases currently tested and working with the ODBC classes.  A call to \helpref{wxDb::Dbms}{wxdbdbms} will return one of these enumerated values listed below.
 

-\begin{verbatim}
-      dbmsUNIDENTIFIED
-      dbmsORACLE
-      dbmsSYBASE_ASA     // Adaptive Server Anywhere
-      dbmsSYBASE_ASE     // Adaptive Server Enterprise
-      dbmsMS_SQL_SERVER
-      dbmsMY_SQL
-      dbmsPOSTGRES
-      dbmsACCESS
-      dbmsDBASE
-      dbmsINFORMIX
-      dbmsVIRTUOSO
-      dbmsDB2
-      dbmdINTERBASE
-\end{verbatim}
+\begin{itemize}\itemsep=0pt
+\item DB2
+\item DBase (IV, V)**
+\item Firebird
+\item INFORMIX
+\item Interbase
+\item MS SQL Server (v7 - minimal testing)
+\item MS Access (97, 2000, 2002, and 2003)
+\item MySQL (2.x and 3.5 - use the 2.5x drivers though)
+\item Oracle (v7, v8, v8i)
+\item Pervasive SQL
+\item PostgreSQL
+\item Sybase (ASA and ASE)
+\item XBase Sequiter
+\item VIRTUOSO
+\end{itemize}

 
 See the remarks in \helpref{wxDb::Dbms}{wxdbdbms} for exceptions/issues with each of these database engines.
 
 
 See the remarks in \helpref{wxDb::Dbms}{wxdbdbms} for exceptions/issues with each of these database engines.
 


@@ -319,7 +320,7 @@ This function is used to request a "new" wxDb instance for use by the program.
 The wxDb instance returned is also opened (see \helpref{wxDb::Open}{wxdbopen}).
 
 This function (along with wxDbFreeConnection() and wxDbCloseConnection())
 The wxDb instance returned is also opened (see \helpref{wxDb::Open}{wxdbopen}).
 
 This function (along with wxDbFreeConnection() and wxDbCloseConnection())

-maintain a cached of wxDb instances for user/re-use by a program.  When a
+maintain a cache of wxDb instances for user/re-use by a program.  When a

 program needs a wxDb instance, it may call this function to obtain a wxDb
 instance.  If there is a wxDb instance in the cache that is currently unused
 that matches the connection requirements specified in {\it'pDbConfig'} then
 program needs a wxDb instance, it may call this function to obtain a wxDb
 instance.  If there is a wxDb instance in the cache that is currently unused
 that matches the connection requirements specified in {\it'pDbConfig'} then


@@ -372,10 +373,10 @@ datasources.  Repeatedly call this function to obtain all the datasources
 available through the ODBC driver manager on the current workstation.
 
 \begin{verbatim}
 available through the ODBC driver manager on the current workstation.
 
 \begin{verbatim}

-    wxStringList strList;
+    wxArrayString strArray;

 
     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);
+        strArray.Add(Dsn);

 \end{verbatim}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 \end{verbatim}
 
 \latexignore{\rtfignore{\wxheading{Members}}}


@@ -571,7 +572,7 @@ of a datasource which does support views.
 \begin{verbatim}
    // Incomplete code sample
    db.CreateView("PARTS_SD1", "PN, PD, QTY",
 \begin{verbatim}
    // Incomplete code sample
    db.CreateView("PARTS_SD1", "PN, PD, QTY",

-                 "SELECT PART_NO, PART_DESC, QTY_ON_HAND * 1.1 FROM PARTS \
+                 "SELECT PART_NUM, PART_DESC, QTY_ON_HAND * 1.1 FROM PARTS \

                   WHERE STORAGE_DEVICE = 1");
 
    // PARTS_SD1 can now be queried just as if it were a data table.
                   WHERE STORAGE_DEVICE = 1");
 
    // PARTS_SD1 can now be queried just as if it were a data table.


@@ -710,12 +711,20 @@ If the view does not exist, this function will return true.  Note that views are
 
 \func{bool}{ExecSql}{\param{const wxString \&}{pSqlStmt}}
 
 
 \func{bool}{ExecSql}{\param{const wxString \&}{pSqlStmt}}
 

+\func{bool}{ExecSql}{\param{const wxString \&}{pSqlStmt}, \param{wxDbColInf **}{columns}, \param{short \&}{numcols}}
+

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

+To get column amount and column names or other information about returned columns, pass {\it 'columns'} and {\it 'numcols'} parameters to the function also.
+

 \wxheading{Parameters}
 
 \docparam{pSqlStmt}{Pointer to the SQL statement to be executed.}
 
 \wxheading{Parameters}
 
 \docparam{pSqlStmt}{Pointer to the SQL statement to be executed.}
 

+\docparam{columns}{On success, this function will set this pointer to point to array of \helpref{wxDbColInf}{wxdbcolinf} objects, holding information about columns returned by the query. You need to call delete[] for the pointer you pass here after you don't use it anymore to prevent memory leak.}
+
+\docparam{numcols}{Reference to variable where amount of objects in {\it 'columns'}-parameter will be set.}
+

 \wxheading{Remarks}
 
 This member extends the wxDb class and allows you to build and execute ANY VALID
 \wxheading{Remarks}
 
 This member extends the wxDb class and allows you to build and execute ANY VALID


@@ -841,7 +850,7 @@ to avoid undesired unbinding of columns.}
 
 \membersection{wxDb::GetData}\label{wxdbgetdata}
 
 
 \membersection{wxDb::GetData}\label{wxdbgetdata}
 

-\func{bool}{GetData}{\param{UWORD}{ colNo}, \param{SWORD}{ cType},
+\func{bool}{GetData}{\param{UWORD}{ colNumber}, \param{SWORD}{ cType},

 \param{PTR}{ pData}, \param{SDWORD}{ maxLen}, \param{SDWORD FAR *}{ cbReturned} }
 
 Used to retrieve result set data without binding column values to memory
 \param{PTR}{ pData}, \param{SDWORD}{ maxLen}, \param{SDWORD FAR *}{ cbReturned} }
 
 Used to retrieve result set data without binding column values to memory


@@ -849,7 +858,7 @@ variables (i.e. not using a wxDbTable instance to access table data).
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{colNo}{Ordinal number of the desired column in the result set to be
+\docparam{colNumber}{Ordinal number of the desired column in the result set to be

 returned.}
 \docparam{cType}{The C data type that is to be returned.  See a partial list
 in \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs}}
 returned.}
 \docparam{cType}{The C data type that is to be returned.  See a partial list
 in \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs}}


@@ -941,7 +950,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{UWORD }{nocols}}
+\func{int }{GetKeyFields}{\param{const wxString \&}{tableName}, \param{wxDbColInf *}{colInf}, \param{UWORD }{numColumns}}

 
 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.
 


@@ -951,7 +960,7 @@ This function is primarily for use by the \helpref{wxDb::GetColumns}{wxdbgetcolu
 
 \docparam{tableName}{Name of the table for which the columns will be evaluated as to their inclusion in any indexes.}
 \docparam{colInf}{Data structure containing the column definitions (obtained with \helpref{wxDb::GetColumns}{wxdbgetcolumns}).  This function populates the PkCol, PkTableName, and FkTableName members of the colInf structure.}
 
 \docparam{tableName}{Name of the table for which the columns will be evaluated as to their inclusion in any indexes.}
 \docparam{colInf}{Data structure containing the column definitions (obtained with \helpref{wxDb::GetColumns}{wxdbgetcolumns}).  This function populates the PkCol, PkTableName, and FkTableName members of the colInf structure.}

-\docparam{nocols}{Number of columns defined in the instance of colInf.}
+\docparam{numColumns}{Number of columns defined in the instance of colInf.}

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


@@ -1604,6 +1613,12 @@ public.
 \helpref{database classes overview}{odbcoverview},
 \helpref{wxDbTable::GetColDefs}{wxdbtablegetcoldefs}, \helpref{wxDb constructor}{wxdbctor}
 
 \helpref{database classes overview}{odbcoverview},
 \helpref{wxDbTable::GetColDefs}{wxdbtablegetcoldefs}, \helpref{wxDb constructor}{wxdbctor}
 

+\wxheading{Include files}
+
+<wx/db.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+

 \membersection{wxDbColDef::Initialize}\label{wxdbcoldefinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by
 \membersection{wxDbColDef::Initialize}\label{wxdbcoldefinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by


@@ -1615,12 +1630,12 @@ Beginning support for handling international formatting specifically on dates
 and floats.
 
 \begin{verbatim}
 and floats.
 
 \begin{verbatim}

-    wxString       s_Field;       // Formated String for Output
-    wxString       s_Format[7];   // Formated Objects - TIMESTAMP has
+    wxString       s_Field;       // Formatted String for Output
+    wxString       s_Format[7];   // Formatted Objects - TIMESTAMP has

                                      the biggest (7)
                                      the biggest (7)

-    wxString       s_Amount[7];   // Formated Objects - amount of
+    wxString       s_Amount[7];   // Formatted Objects - amount of

                                      things that can be formatted
                                      things that can be formatted

-    int            i_Amount[7];   // Formated Objects -
+    int            i_Amount[7];   // Formatted Objects -

                                         TT MM YYYY HH MM SS m
     int            i_Nation;      // 0 = timestamp
                                      1 = EU
                                         TT MM YYYY HH MM SS m
     int            i_Nation;      // 0 = timestamp
                                      1 = EU


@@ -1642,6 +1657,12 @@ Only one function is provided with this class currently.
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 

+\wxheading{Include files}
+
+<wx/db.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+

 \membersection{wxDbColFor::Format}\label{wxdbcolforformat}
 
 \func{int }{Format}{\param{int }{Nation}, \param{int }{dbDataType},
 \membersection{wxDbColFor::Format}\label{wxdbcolforformat}
 
 \func{int }{Format}{\param{int }{Nation}, \param{int }{dbDataType},


@@ -1698,6 +1719,12 @@ it is non-NULL.
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 

+\wxheading{Include files}
+
+<wx/db.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+

 \membersection{wxDbColInf::Initialize}\label{wxdbcolinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by
 \membersection{wxDbColInf::Initialize}\label{wxdbcolinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by


@@ -1977,6 +2004,11 @@ 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.
 
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 

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

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


@@ -2004,6 +2036,12 @@ it is non-NULL.
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 

+\wxheading{Include files}
+
+<wx/db.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+

 \membersection{wxDbInf::Initialize}\label{wxdbinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by
 \membersection{wxDbInf::Initialize}\label{wxdbinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by


@@ -2167,7 +2205,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 typeOfUpdate 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.


@@ -2183,9 +2221,9 @@ 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
 DB\_MAX\_STATEMENT\_LEN bytes.}
 \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.}

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

 of two values: DB\_UPD\_KEYFIELDS or DB\_UPD\_WHERE.}
 of two values: DB\_UPD\_KEYFIELDS or DB\_UPD\_WHERE.}

-\docparam{pWhereClause}{{\it OPTIONAL}.  If the typeOfUpd is DB\_UPD\_WHERE,
+\docparam{pWhereClause}{{\it OPTIONAL}.  If the typeOfUpdate 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}


@@ -2198,9 +2236,10 @@ WHERE and FROM clauses specified using \helpref{wxDbTable::SetWhereClause}{wxdbt
 and \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause} are ignored by
 this function.
 
 and \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause} are ignored by
 this function.
 

-\membersection{wxDbTable::BuildWhereStmt}\label{wxdbtablebuildwherestmt}

 
 

-\func{void}{BuildSelectStmt}{\param{wxString \&}{pWhereClause},
+\membersection{wxDbTable::BuildWhereClause}\label{wxdbtablebuildwhereclause}
+ 
+\func{void}{BuildWhereClause}{\param{wxString \&}{pWhereClause},

 \param{int }{typeOfWhere}, \param{const wxString \&}{qualTableName=""},
 \param{bool }{useLikeComparison=false}}
 
 \param{int }{typeOfWhere}, \param{const wxString \&}{qualTableName=""},
 \param{bool }{useLikeComparison=false}}
 


@@ -2233,6 +2272,7 @@ 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.
 

+

 \membersection{wxDbTable::CanSelectForUpdate}\label{wxdbtablecanselectforupdate}
 
 \func{bool}{CanSelectForUpdate}{\void}
 \membersection{wxDbTable::CanSelectForUpdate}\label{wxdbtablecanselectforupdate}
 
 \func{bool}{CanSelectForUpdate}{\void}


@@ -2287,26 +2327,26 @@ to an Oracle datasource or not.
     // Incomplete code sample
     wxDbTable parts;
     .....
     // Incomplete code sample
     wxDbTable parts;
     .....

-    if (parts.CanUpdByROWID())
+    if (parts.CanUpdateByROWID())

     {
         // Note that the ROWID column must always be the last column selected
     {
         // Note that the ROWID column must always be the last column selected

-        sqlStmt = "SELECT PART_NO, PART_DESC, ROWID" FROM PARTS";
+        sqlStmt = "SELECT PART_NUM, PART_DESC, ROWID" FROM PARTS";

     }
     else
     }
     else

-        sqlStmt = "SELECT PART_NO, PART_DESC FROM PARTS";
+        sqlStmt = "SELECT PART_NUM, PART_DESC FROM PARTS";

 \end{verbatim}
 
 
 \membersection{wxDbTable::ClearMemberVar}\label{wxdbtableclearmembervar}
 
 \end{verbatim}
 
 
 \membersection{wxDbTable::ClearMemberVar}\label{wxdbtableclearmembervar}
 

-\func{void}{ClearMemberVar}{\param{UWORD }{colNo}, \param{bool }{setToNull=false}}
+\func{void}{ClearMemberVar}{\param{UWORD }{colNumber}, \param{bool }{setToNull=false}}

 
 Same as \helpref{wxDbTable::ClearMemberVars}{wxdbtableclearmembervars} except
 that this function clears only the specified column of its values, and
 optionally sets the column to be a NULL column.
 
 
 Same as \helpref{wxDbTable::ClearMemberVars}{wxdbtableclearmembervars} except
 that this function clears only the specified column of its values, and
 optionally sets the column to be a NULL column.
 

-\docparam{colNo}{Column number that is to be cleared.  This number (between 0
-and (noCols-1)) is the index of the column definition created using the
+\docparam{colNumber}{Column number that is to be cleared.  This number (between 0
+and (numColumns-1)) is the index of the column definition created using the

 \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs} function.}
 \docparam{setToNull}{{\it OPTIONAL}.  Indicates whether the column should be
 flagged as being a NULL value stored in the bound memory variable.  If true,
 \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs} function.}
 \docparam{setToNull}{{\it OPTIONAL}.  Indicates whether the column should be
 flagged as being a NULL value stored in the bound memory variable.  If true,


@@ -2413,8 +2453,8 @@ this function.
 
 \membersection{wxDbTable::CreateIndex}\label{wxdbtablecreateindex}
 
 
 \membersection{wxDbTable::CreateIndex}\label{wxdbtablecreateindex}
 

-\func{bool}{CreateIndex}{\param{const wxString \&}{idxName}, \param{bool }{unique},
-\param{UWORD }{noIdxCols}, \param{wxDbIdxDef *}{pIdxDefs},
+\func{bool}{CreateIndex}{\param{const wxString \&}{IndexName}, \param{bool }{unique},
+\param{UWORD }{numIndexColumns}, \param{wxDbIdxDef *}{pIndexDefs},

 \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


@@ -2429,11 +2469,11 @@ take advantage of those indexes.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{idxName}{Name of the Index.  Name must be unique within the table
+\docparam{IndexName}{Name of the Index.  Name must be unique within the table

 space of the datasource.}
 \docparam{unique}{Indicates if this index is unique.}
 space of the datasource.}
 \docparam{unique}{Indicates if this index is unique.}

-\docparam{noIdxCols}{Number of columns in the index.}
-\docparam{pIdxDefs}{A pointer to an array wxDbIdxDef structures. }
+\docparam{numIndexColumns}{Number of columns in the index.}
+\docparam{pIndexDefs}{A pointer to an array \helpref{wxDbIdxDef}{wxdbidxdef} structures. }

 \docparam{attemptDrop}{{\it OPTIONAL}.  Indicates if the function should try
 to execute a \helpref{wxDbTable::DropIndex}{wxdbtabledropindex} on the index
 name provided before trying to create the index name.  Default is true.}
 \docparam{attemptDrop}{{\it OPTIONAL}.  Indicates if the function should try
 to execute a \helpref{wxDbTable::DropIndex}{wxdbtabledropindex} on the index
 name provided before trying to create the index name.  Default is true.}


@@ -2443,7 +2483,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\_Index1).  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


@@ -2452,12 +2492,12 @@ indexes from being inserted into the table when violating a unique index's
 uniqueness.
 
 In the third parameter, specify how many columns are in your index.  This
 uniqueness.
 
 In the third parameter, specify how many columns are in your index.  This

-number must match the number of columns defined in the 'pIdxDefs' parameter.
+number must match the number of columns defined in the 'pIndexDefs' parameter.

 
 The fourth parameter specifies which columns make up the index using the
 
 The fourth parameter specifies which columns make up the index using the

-wxDbIdxDef structure.  For each column in the index, you must specify two
+\helpref{wxDbIdxDef}{wxdbidxdef} structure.  For each column in the index, you must specify two

 things, the column name and the sort order (ascending / descending).  See
 things, the column name and the sort order (ascending / descending).  See

-the example below to see how to build and pass in the wxDbIdxDef structure.
+the example below to see how to build and pass in the \helpref{wxDbIdxDef}{wxdbidxdef} structure.

 
 The fifth parameter is provided to handle the differences in datasources as
 to whether they will automatically overwrite existing indexes with the same
 
 The fifth parameter is provided to handle the differences in datasources as
 to whether they will automatically overwrite existing indexes with the same


@@ -2482,18 +2522,18 @@ after executing this function.
 
 \begin{verbatim}
     // Create a secondary index on the PARTS table
 
 \begin{verbatim}
     // Create a secondary index on the PARTS table

-    wxDbIdxDef  idxDef[2];  // 2 columns make up the index
+    wxDbIdxDef  IndexDef[2];  // 2 columns make up the index

 
 

-    wxStrcpy(idxDef[0].ColName, "PART_DESC");  // Column 1
-    idxDef[0].Ascending = true;
+    wxStrcpy(IndexDef[0].ColName, "PART_DESC");  // Column 1
+    IndexDef[0].Ascending = true;

 
 

-    wxStrcpy(idxDef[1].ColName, "SERIAL_NO");  // Column 2
-    idxDef[1].Ascending = false;
+    wxStrcpy(IndexDef[1].ColName, "SERIAL_NO");  // Column 2
+    IndexDef[1].Ascending = false;

 
     // Create a name for the index based on the table's name
     wxString indexName;
 
     // Create a name for the index based on the table's name
     wxString indexName;

-    indexName.Printf("%s_IDX1",parts->GetTableName());
-    parts->CreateIndex(indexName, true, 2, idxDef);
+    indexName.Printf("%s_Index1",parts->GetTableName());
+    parts->CreateIndex(indexName, true, 2, IndexDef);

 \end{verbatim}
 
 \membersection{wxDbTable::CreateTable}\label{wxdbtablecreatetable}
 \end{verbatim}
 
 \membersection{wxDbTable::CreateTable}\label{wxdbtablecreatetable}


@@ -2691,18 +2731,18 @@ this function.
 
 \membersection{wxDbTable::DropIndex}\label{wxdbtabledropindex}
 
 
 \membersection{wxDbTable::DropIndex}\label{wxdbtabledropindex}
 

-\func{bool}{DropIndex}{\param{const wxString \&}{idxName}}
+\func{bool}{DropIndex}{\param{const wxString \&}{IndexName}}

 
 Allows an index on the associated table to be dropped (deleted) if the user
 login has sufficient privileges to do so.
 
 \wxheading{Parameters}
 
 
 Allows an index on the associated table to be dropped (deleted) if the user
 login has sufficient privileges to do so.
 
 \wxheading{Parameters}
 

-\docparam{idxName}{Name of the index to be dropped.}
+\docparam{IndexName}{Name of the index to be dropped.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-If the index specified in the 'idxName' parameter does not exist, an error
+If the index specified in the 'IndexName' parameter does not exist, an error

 will be logged, and the function will return a result of false.
 
 It is not necessary to call \helpref{wxDb::CommitTrans}{wxdbcommittrans}
 will be logged, and the function will return a result of false.
 
 It is not necessary to call \helpref{wxDb::CommitTrans}{wxdbcommittrans}


@@ -2742,7 +2782,7 @@ of this function).
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{From}{A comma separated list of table names that are to be outer
+\docparam{From}{A comma separated list of table names that are to be inner

 joined with the base table's columns so that the joined table's columns
 may be returned in the result set or used as a portion of a comparison with
 the base table's columns.  NOTE that the base tables name must NOT be included
 joined with the base table's columns so that the joined table's columns
 may be returned in the result set or used as a portion of a comparison with
 the base table's columns.  NOTE that the base tables name must NOT be included


@@ -3063,14 +3103,14 @@ this function to commit or rollback the insertion.
 
 \membersection{wxDbTable::IsColNull}\label{wxdbtableiscolnull}
 
 
 \membersection{wxDbTable::IsColNull}\label{wxdbtableiscolnull}
 

-\func{bool }{IsColNull}{\param{UWORD }{colNo}} const
+\func{bool }{IsColNull}{\param{UWORD }{colNumber}} 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{Parameters}
 
 
 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{Parameters}
 

-\docparam{colNo}{The column number of the bound column as defined by the
+\docparam{colNumber}{The column number of the bound column as defined by the

 \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs}
 calls which defined the columns accessible to this wxDbTable instance.}
 
 \helpref{wxDbTable::SetColDefs}{wxdbtablesetcoldefs}
 calls which defined the columns accessible to this wxDbTable instance.}
 


@@ -3217,7 +3257,7 @@ 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
 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

-\helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause} to allow outer
+\helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause} to allow inner

 joining of the base table (the one being associated with this instance of
 wxDbTable) with other tables which share a related field.
 
 joining of the base table (the one being associated with this instance of
 wxDbTable) with other tables which share a related field.
 


@@ -3313,7 +3353,7 @@ float for column 3 (e.g. PRICE * 1.10 to increase the price by
 10%).
 \item The ROWID can be included in your SELECT statement as the {\bf last}
 column selected, if the datasource supports it.  Use
 10%).
 \item 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
+wxDbTable::CanUpdateByROWID() to determine if the ROWID can be

 selected from the datasource.  If it can, much better
 performance can be achieved on updates and deletes by including
 the ROWID in the SELECT statement.
 selected from the datasource.  If it can, much better
 performance can be achieved on updates and deletes by including
 the ROWID in the SELECT statement.


@@ -3353,7 +3393,7 @@ either \helpref{wxDbTable::GetFirst}{wxdbtablegetfirst} or
     ----------------------
 
     // Table Join returning 3 columns
     ----------------------
 
     // Table Join returning 3 columns

-    SELECT part_no, part_desc, sd_name
+    SELECT PART_NUM, part_desc, sd_name

         from parts, storage_devices
         where parts.storage_device_id =
               storage_devices.storage_device_id
         from parts, storage_devices
         where parts.storage_device_id =
               storage_devices.storage_device_id


@@ -3363,10 +3403,10 @@ either \helpref{wxDbTable::GetFirst}{wxdbtablegetfirst} or
     SELECT count(*) from PARTS where container = 99
 
     // Order by clause; ROWID, scalar function
     SELECT count(*) from PARTS where container = 99
 
     // Order by clause; ROWID, scalar function

-    SELECT part_no, substring(part_desc, 1, 10), qty_on_hand + 1, ROWID
+    SELECT PART_NUM, substring(part_desc, 1, 10), qty_on_hand + 1, ROWID

         from parts
         where warehouse = 10
         from parts
         where warehouse = 10

-        order by part_no desc           // descending order
+        order by PART_NUM desc           // descending order

 
     // Subquery
     SELECT * from parts
 
     // Subquery
     SELECT * from parts


@@ -3512,10 +3552,10 @@ 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{UWORD }{index}, \param{const wxString \&}{fieldName},
+\func{bool}{SetColDefs}{\param{UWORD }{index}, \param{const wxString \&}{fieldName},

 \param{int }{dataType}, \param{void *}{pData}, \param{SWORD }{cType},
 \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 }{updateable = true},
+\param{bool }{insertAllowed = true}, \param{bool }{derivedColumn = false}}

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


@@ -3541,7 +3581,8 @@ representation of the data is converted to to be stored in {\it pData}.
 Other valid types are available also, but these are the most common ones:}
 
 \begin{verbatim}
 Other valid types are available also, but these are the most common ones:}
 
 \begin{verbatim}

-    SQL_C_CHAR      // strings
+    SQL_C_CHAR      // string - deprecated: use SQL_C_WXCHAR
+    SQL_C_WXCHAR    // string - Used transparently in unicode or non-unicode builds

     SQL_C_LONG
     SQL_C_ULONG
     SQL_C_SHORT
     SQL_C_LONG
     SQL_C_ULONG
     SQL_C_SHORT


@@ -3558,11 +3599,11 @@ Other valid types are available also, but these are the most common ones:}
 \docparam{size}{Maximum size in bytes of the {\it pData} object.}
 \docparam{keyField}{{\it OPTIONAL}.  Indicates if this column is part of the
 primary index.  Default is false.}
 \docparam{size}{Maximum size in bytes of the {\it pData} object.}
 \docparam{keyField}{{\it OPTIONAL}.  Indicates if this column is part of the
 primary index.  Default is false.}

-\docparam{upd}{{\it OPTIONAL}.  Are updates allowed on this column?
+\docparam{updateable}{{\it OPTIONAL}.  Are updates allowed on this column?

 Default is true.}
 Default is true.}

-\docparam{insAllow}{{\it OPTIONAL}.  Inserts allowed on this column?
+\docparam{insertAllowed}{{\it OPTIONAL}.  Inserts allowed on this column?

 Default is true.}
 Default is true.}

-\docparam{derivedCol}{{\it OPTIONAL}.  Is this a derived column (non-base
+\docparam{derivedColumn}{{\it OPTIONAL}.  Is this a derived column (non-base

 table column for query only)?  Default is false.}
 
 \docparam{colInfs}{Pointer to an array of wxDbColInf instances which contains
 table column for query only)?  Default is false.}
 
 \docparam{colInfs}{Pointer to an array of wxDbColInf instances which contains


@@ -3575,6 +3616,14 @@ to by {\it colInfs}, which are to have column definitions created from them.}
 If {\it pData} is to hold a string of characters, be sure to include enough
 space for the NULL terminator in pData and in the byte count of {\it size}.
 
 If {\it pData} is to hold a string of characters, be sure to include enough
 space for the NULL terminator in pData and in the byte count of {\it size}.
 

+Using the first form of this function, if the column definition is not able 
+to be created, a value of false is returned.  If the specified index of the 
+column exceeds the number of columns defined in the wxDbTable instance, an
+assert is thrown and logged (in debug builds) and a false is returned.
+
+A failure to create the column definition in the second form results in a 
+value of NULL being returned.
+

 Both forms of this function provide a shortcut for defining the columns in
 your wxDbTable object.  Use this function in any derived wxDbTable
 constructor when describing the column/columns in the wxDbTable object.
 Both forms of this function provide a shortcut for defining the columns in
 your wxDbTable object.  Use this function in any derived wxDbTable
 constructor when describing the column/columns in the wxDbTable object.


@@ -3591,10 +3640,10 @@ were to be copied over to another datasource or table.
 
 \begin{verbatim}
     // Long way not using this function
 
 \begin{verbatim}
     // Long way not using this function

-    wxStrcpy(colDefs[0].ColName, "PART_NO");
+    wxStrcpy(colDefs[0].ColName, "PART_NUM");

     colDefs[0].DbDataType   = DB_DATA_TYPE_VARCHAR;
     colDefs[0].PtrDataObj   = PartNumber;
     colDefs[0].DbDataType   = DB_DATA_TYPE_VARCHAR;
     colDefs[0].PtrDataObj   = PartNumber;

-    colDefs[0].SqlCtype     = SQL_C_CHAR;
+    colDefs[0].SqlCtype     = SQL_C_WXCHAR;

     colDefs[0].SzDataObj    = PART_NUMBER_LEN;
     colDefs[0].KeyField     = true;
     colDefs[0].Updateable   = false;
     colDefs[0].SzDataObj    = PART_NUMBER_LEN;
     colDefs[0].KeyField     = true;
     colDefs[0].Updateable   = false;


@@ -3602,13 +3651,13 @@ were to be copied over to another datasource or table.
     colDefs[0].DerivedCol   = false;
 
     // Shortcut using this function
     colDefs[0].DerivedCol   = false;
 
     // Shortcut using this function

-    SetColDefs(0, "PART_NUMBER", DB_DATA_TYPE_VARCHAR, PartNumber,
-               SQL_C_CHAR, PART_NUMBER_LEN, true, false,true,false);
+    SetColDefs(0, "PART_NUM", DB_DATA_TYPE_VARCHAR, PartNumber,
+               SQL_C_WXCHAR, PART_NUMBER_LEN, true, false, true, false);

 \end{verbatim}
 
 \membersection{wxDbTable::SetCursor}\label{wxdbtablesetcursor}
 
 \end{verbatim}
 
 \membersection{wxDbTable::SetCursor}\label{wxdbtablesetcursor}
 

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

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -3640,14 +3689,14 @@ and saving a pointer to that cursor.
 \func{void}{SetFromClause}{\param{const wxString \&}{From}}
 
 Accessor function for setting the private class member wxDbTable::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
+that indicates what other tables should be inner joined with the wxDbTable's

 base table for access to the columns in those other tables.
 
 Synonym to this function is one form of \helpref{wxDbTable::From}{wxdbtablefrom}
 
 \wxheading{Parameters}
 
 base table for access to the columns in those other tables.
 
 Synonym to this function is one form of \helpref{wxDbTable::From}{wxdbtablefrom}
 
 \wxheading{Parameters}
 

-\docparam{From}{A comma separated list of table names that are to be outer
+\docparam{From}{A comma separated list of table names that are to be inner

 joined with the base table's columns so that the joined table's columns
 may be returned in the result set or used as a portion of a comparison with
 the base table's columns.  NOTE that the base tables name must NOT be included
 joined with the base table's columns so that the joined table's columns
 may be returned in the result set or used as a portion of a comparison with
 the base table's columns.  NOTE that the base tables name must NOT be included


@@ -3657,7 +3706,7 @@ in constructing query statements.}
 \wxheading{Remarks}
 
 Used by the \helpref{wxDbTable::Query}{wxdbtablequery} and
 \wxheading{Remarks}
 
 Used by the \helpref{wxDbTable::Query}{wxdbtablequery} and

-\helpref{wxDbTable::Count}{wxdbtablecount} member functions to allow outer
+\helpref{wxDbTable::Count}{wxdbtablecount} member functions to allow inner

 joining of records from multiple tables.
 
 Do {\bf not} include the keyword "FROM" when setting the FROM clause.
 joining of records from multiple tables.
 
 Do {\bf not} include the keyword "FROM" when setting the FROM clause.


@@ -3672,7 +3721,7 @@ the datasource knows on which column values the tables should be joined on.
 \begin{verbatim}
     ...
     // Base table is the "LOCATION" table, and it is being
 \begin{verbatim}
     ...
     // Base table is the "LOCATION" table, and it is being

-    // outer joined to the "PART" table via the the field "PART_NUMBER"
+    // inner joined to the "PART" table via the field "PART_NUMBER"

     // that can be related between the two tables.
     location->SetWhereClause("LOCATION.PART_NUMBER = PART.PART_NUMBER")
     location->SetFromClause("PART");
     // that can be related between the two tables.
     location->SetWhereClause("LOCATION.PART_NUMBER = PART.PART_NUMBER")
     location->SetFromClause("PART");


@@ -3686,7 +3735,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{UWORD }{colNo}, \param{bool }{set=true}}
+\func{bool}{SetColNull}{\param{UWORD }{colNumber}, \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}}


@@ -3700,7 +3749,7 @@ the actual column name to be specified.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{colNo}{Index into the column definitions used when first defining
+\docparam{colNumber}{Index into the column definitions used when first defining

 this wxDbTable object.}
 \docparam{colName}{Actual data table column name that is to be set to NULL.}
 \docparam{set}{Whether the column is set to NULL or not.  Passing true sets
 this wxDbTable object.}
 \docparam{colName}{Actual data table column name that is to be set to NULL.}
 \docparam{set}{Whether the column is set to NULL or not.  Passing true sets


@@ -3806,7 +3855,7 @@ Do {\bf not} include the keywords "WHERE" when setting the WHERE clause.
     // Using parameters and multiple logical combinations
     parts->Where("((QTY > 10) OR (ON_ORDER > 0)) AND ON_HOLD = 0");
     ...
     // Using parameters and multiple logical combinations
     parts->Where("((QTY > 10) OR (ON_ORDER > 0)) AND ON_HOLD = 0");
     ...

-    // This query uses an outer join (requiring a FROM clause also)
+    // This query uses an inner join (requiring a FROM clause also)

     // that joins the PART and LOCATION table on he common field
     // PART_NUMBER.
     parts->Where("PART.ON_HOLD = 0 AND \
     // that joins the PART and LOCATION table on he common field
     // PART_NUMBER.
     parts->Where("PART.ON_HOLD = 0 AND \


@@ -3956,6 +4005,12 @@ Eventually, accessor functions will be added for this class
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 

+\wxheading{Include files}
+
+<wx/db.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+

 \membersection{wxDbTableInf::Initialize}\label{wxdbtableinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by
 \membersection{wxDbTableInf::Initialize}\label{wxdbtableinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by


@@ -3978,7 +4033,7 @@ an introduction to using the wxDbGrid classes.
 
 \membersection{wxDbGridColInfo::wxDbGridColInfo}\label{wxdbgridcolinfoctor}
 
 
 \membersection{wxDbGridColInfo::wxDbGridColInfo}\label{wxdbgridcolinfoctor}
 

-\func{}{wxDbGridColInfo}{\param{int }{colNo}, \param{wxString }{type},
+\func{}{wxDbGridColInfo}{\param{int }{colNumber}, \param{wxString }{type},

   \param{wxString }{title}, \param{wxDbGridColInfo *}{next}}
 
 Default constructor. See the database grid example in \helpref{wxDbGridTableBase}{wxdbgridtablebase} to
   \param{wxString }{title}, \param{wxDbGridColInfo *}{next}}
 
 Default constructor. See the database grid example in \helpref{wxDbGridTableBase}{wxdbgridtablebase} to


@@ -3987,7 +4042,7 @@ see two different ways for adding columns.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{colNo}{Column number in the \helpref{wxDbTable}{wxdbtable} instance to be used (first column is 0).}
+\docparam{colNumber}{Column number in the \helpref{wxDbTable}{wxdbtable} instance to be used (first column is 0).}

 \docparam{type}{Column type ,wxString specifying the grid name for the datatype in this column, or
  use wxGRID\_VALUE\_DBAUTO to determine the type automatically from the \helpref{wxDbColDef}{wxdbcoldef} definition}
 \docparam{title}{The column label to be used in the grid display}
 \docparam{type}{Column type ,wxString specifying the grid name for the datatype in this column, or
  use wxGRID\_VALUE\_DBAUTO to determine the type automatically from the \helpref{wxDbColDef}{wxdbcoldef} definition}
 \docparam{title}{The column label to be used in the grid display}


@@ -4004,7 +4059,7 @@ Destructor.
 
 \membersection{wxDbGridColInfo::AddColInfo}\label{wxdbgridcolinfoaddcolinfo}
 
 
 \membersection{wxDbGridColInfo::AddColInfo}\label{wxdbgridcolinfoaddcolinfo}
 

-\func{void}{AddColInfo}{\param{int }{colNo},
+\func{void}{AddColInfo}{\param{int }{colNumber},

 \param{wxString }{type}, \param{wxString }{title}}
 
 Use this member function for adding columns. See the database
 \param{wxString }{type}, \param{wxString }{title}}
 
 Use this member function for adding columns. See the database


@@ -4016,7 +4071,7 @@ constructor. Changes made to this datatype after the \helpref{wxDbGridTableBase}
 not have any effect.
 
 \wxheading{Parameters}
 not have any effect.
 
 \wxheading{Parameters}

-\docparam{colNo}{Column number in the \helpref{wxDbTable}{wxdbtable} instance to be used (first column is 0).}
+\docparam{colNumber}{Column number in the \helpref{wxDbTable}{wxdbtable} instance to be used (first column is 0).}

 \docparam{type}{Column type ,wxString specifying the grid name for the datatype in this column, or
  use wxGRID\_VALUE\_DBAUTO to determine the type automatically from the \helpref{wxDbColDef}{wxdbcoldef} definition}
 \docparam{title}{The column label to be used in the grid display}
 \docparam{type}{Column type ,wxString specifying the grid name for the datatype in this column, or
  use wxGRID\_VALUE\_DBAUTO to determine the type automatically from the \helpref{wxDbColDef}{wxdbcoldef} definition}
 \docparam{title}{The column label to be used in the grid display}