Use const

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

diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex
index 88cd6ca6e3431e44cc59aa90d16179b54b6e2ff3..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>
 
+\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.
@@ -707,6 +711,25 @@ 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.
 
+\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}}
@@ -1364,7 +1387,7 @@ When called with {\it sqlLogOFF}, the logging file is closed, and any calls to \
 
 \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
@@ -1386,7 +1409,7 @@ before including the column name in a SQL statement}
 
 \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
@@ -1661,6 +1684,10 @@ an introduction to using the ODBC classes.
 
 <wx/db.h>
 
+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbColFor::Format}\label{wxdbcolforformat}
@@ -1723,6 +1750,10 @@ an introduction to using the ODBC classes.
 
 <wx/db.h>
 
+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbColInf::Initialize}\label{wxdbcolinfinitialize}
@@ -2009,6 +2040,10 @@ an introduction to using the ODBC classes.
 
 <wx/db.h>
 
+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+
 \section{\class{wxDbInf}}\label{wxdbinf}
 
 Contains information regarding the database connection (datasource name,
@@ -2040,6 +2075,10 @@ an introduction to using the ODBC classes.
 
 <wx/db.h>
 
+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbInf::Initialize}\label{wxdbinfinitialize}
@@ -2059,6 +2098,10 @@ an introduction to using the ODBC classes.
 
 <wx/dbtable.h>\\
 <wx/db.h>
+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 \wxheading{Helper classes and data structures}
@@ -4011,6 +4054,10 @@ an introduction to using the ODBC classes.
 
 <wx/db.h>
 
+\wxheading{Library}
+
+\helpref{wxOdbc}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbTableInf::Initialize}\label{wxdbtableinfinitialize}
@@ -4031,6 +4078,10 @@ an introduction to using the wxDbGrid classes.
 
 <wx/dbgrid.h>
 
+\wxheading{Library}
+
+\helpref{wxDbgrid}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDbGridColInfo::wxDbGridColInfo}\label{wxdbgridcolinfoctor}
@@ -4110,6 +4161,10 @@ that the client keeps ownership.
 
 <wx/dbgrid.h>
 
+\wxheading{Library}
+
+\helpref{wxDbgrid}{librarieslist}
+
 
 \wxheading{Example}