Updated border style names

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

diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex
index 1158657f99eff7aac2b384f4de461ee81f13379c..12cbfd6626af773a32cdff7b2e9d5c8dcd087ca7 100644 (file)
--- a/docs/latex/wx/db.tex
+++ b/docs/latex/wx/db.tex
@@ -13,6 +13,10 @@ an introduction to using the ODBC classes.
 
 <wx/db.h>
 
 
 <wx/db.h>
 

+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+

 \wxheading{Helper classes and data structures}
 
 The following classes and structs are defined in db.cpp/.h for use with the wxDb class.
 \wxheading{Helper classes and data structures}
 
 The following classes and structs are defined in db.cpp/.h for use with the wxDb class.


@@ -707,16 +711,43 @@ Drops the data table view named in 'viewName'.
 
 If the view does not exist, this function will return true.  Note that views are not supported with all datasources.
 
 
 If the view does not exist, this function will return true.  Note that views are not supported with all datasources.
 

+\membersection{wxDb::EscapeSqlChars}\label{wxdbescapesqlchars}
+
+\func{wxString}{EscapeSqlChars}{\param{const wxString\& }{value}}
+
+This function is used internally by wxWidgets while building SQL statements.
+It has been provided to help users who wish to explicity construct SQL
+statements to be sent to the server.  The function takes the value passed and
+returns it with any special characters escaped.  Which characters are
+considered special depends on what type of datasource the object is connected
+to.  For example, most database servers use a backslash as the escape
+character; if the value passed contains a backlash it will be replaced with a
+double backslash before it is passed to the server.  This function can be used
+to avoid passing statements with syntax errors to the server as well as prevent
+SQL injection attacks.
+
+\wxheading{Parameters}
+
+\docparam{value}{The value to be escaped.}
+

 \membersection{wxDb::ExecSql}\label{wxdbexecsql}
 
 \func{bool}{ExecSql}{\param{const wxString \&}{pSqlStmt}}
 
 \membersection{wxDb::ExecSql}\label{wxdbexecsql}
 
 \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


@@ -1356,7 +1387,7 @@ When called with {\it sqlLogOFF}, the logging file is closed, and any calls to \
 
 \membersection{wxDb::SQLColumnName}\label{wxdbsqlcolumnname}
 
 
 \membersection{wxDb::SQLColumnName}\label{wxdbsqlcolumnname}
 

-\func{const wxString}{SQLColumnName}{\param{const char *}{ colName}}
+\func{const wxString}{SQLColumnName}{\param{const wxChar *}{ 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
 
 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


@@ -1378,7 +1409,7 @@ before including the column name in a SQL statement}
 
 \membersection{wxDb::SQLTableName}\label{wxdbsqltablename}
 
 
 \membersection{wxDb::SQLTableName}\label{wxdbsqltablename}
 

-\func{const wxString}{SQLTableName}{\param{const char *}{ tableName}}
+\func{const wxString}{SQLTableName}{\param{const wxChar *}{ 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
 
 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


@@ -1622,12 +1653,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


@@ -1653,6 +1684,10 @@ an introduction to using the ODBC classes.
 
 <wx/db.h>
 
 
 <wx/db.h>
 

+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbColFor::Format}\label{wxdbcolforformat}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbColFor::Format}\label{wxdbcolforformat}


@@ -1715,6 +1750,10 @@ an introduction to using the ODBC classes.
 
 <wx/db.h>
 
 
 <wx/db.h>
 

+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbColInf::Initialize}\label{wxdbcolinfinitialize}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbColInf::Initialize}\label{wxdbcolinfinitialize}


@@ -2001,6 +2040,10 @@ an introduction to using the ODBC classes.
 
 <wx/db.h>
 
 
 <wx/db.h>
 

+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+

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


@@ -2032,6 +2075,10 @@ an introduction to using the ODBC classes.
 
 <wx/db.h>
 
 
 <wx/db.h>
 

+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbInf::Initialize}\label{wxdbinfinitialize}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbInf::Initialize}\label{wxdbinfinitialize}


@@ -2051,6 +2098,10 @@ an introduction to using the ODBC classes.
 
 <wx/dbtable.h>\\
 <wx/db.h>
 
 <wx/dbtable.h>\\
 <wx/db.h>

+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 \wxheading{Helper classes and data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 \wxheading{Helper classes and data structures}


@@ -2449,7 +2500,7 @@ this function.
 \param{UWORD }{numIndexColumns}, \param{wxDbIdxDef *}{pIndexDefs},
 \param{bool }{attemptDrop=true}}
 
 \param{UWORD }{numIndexColumns}, \param{wxDbIdxDef *}{pIndexDefs},
 \param{bool }{attemptDrop=true}}
 

-This member function allows you to create secondary (non primary) indexes on
+This member function allows you to create secondary (non-primary) indexes on

 your tables.  You first create your table, normally specifying a primary
 index, and then create any secondary indexes on the table.  Indexes in
 relational model are not required.  You do not need indexes to look up records
 your tables.  You first create your table, normally specifying a primary
 index, and then create any secondary indexes on the table.  Indexes in
 relational model are not required.  You do not need indexes to look up records


@@ -2774,7 +2825,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


@@ -3249,7 +3300,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.
 


@@ -3564,6 +3615,8 @@ wxDbTable constructor was called.}
     DB_DATA_TYPE_INTEGER        : non-floating point numbers
     DB_DATA_TYPE_FLOAT          : floating point numbers
     DB_DATA_TYPE_DATE           : dates
     DB_DATA_TYPE_INTEGER        : non-floating point numbers
     DB_DATA_TYPE_FLOAT          : floating point numbers
     DB_DATA_TYPE_DATE           : dates

+    DB_DATA_TYPE_BLOB           : binary large objects
+    DB_DATA_TYPE_MEMO           : large strings

 \end{verbatim}
 
 \docparam{pData}{Pointer to the data object that will hold the column's
 \end{verbatim}
 
 \docparam{pData}{Pointer to the data object that will hold the column's


@@ -3681,14 +3734,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


@@ -3698,7 +3751,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.


@@ -3713,7 +3766,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");


@@ -3847,7 +3900,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 \


@@ -4001,6 +4054,10 @@ an introduction to using the ODBC classes.
 
 <wx/db.h>
 
 
 <wx/db.h>
 

+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbTableInf::Initialize}\label{wxdbtableinfinitialize}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbTableInf::Initialize}\label{wxdbtableinfinitialize}


@@ -4021,6 +4078,10 @@ an introduction to using the wxDbGrid classes.
 
 <wx/dbgrid.h>
 
 
 <wx/dbgrid.h>
 

+\wxheading{Library}
+
+\helpref{wxDbgrid}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbGridColInfo::wxDbGridColInfo}\label{wxdbgridcolinfoctor}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbGridColInfo::wxDbGridColInfo}\label{wxdbgridcolinfoctor}


@@ -4100,6 +4161,10 @@ that the client keeps ownership.
 
 <wx/dbgrid.h>
 
 
 <wx/dbgrid.h>
 

+\wxheading{Library}
+
+\helpref{wxDbgrid}{librarieslist}
+

 
 \wxheading{Example}
 
 
 \wxheading{Example}