]> git.saurik.com Git - wxWidgets.git/commitdiff
Previosly removed BuildWhereStmt really did exist, but as BuildWhereClause - not...
authorRyan Norton <wxprojects@comcast.net>
Mon, 7 Feb 2005 22:36:04 +0000 (22:36 +0000)
committerRyan Norton <wxprojects@comcast.net>
Mon, 7 Feb 2005 22:36:04 +0000 (22:36 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31840 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/db.tex

index c4399fef465a08c997d7c335672360a2ca13ab04..bda7f4a117274f8f86f07ae760cae9b7df3f9fa6 100644 (file)
@@ -373,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}
-    wxStringList strList;
+    wxArrayString strArray;
 
     while (wxDbGetDataSource(DbConnectInf.GetHenv(), Dsn, SQL_MAX_DSN_LENGTH+1, DsDesc, 255))
-        strList.Add(Dsn);
+        strArray.Add(Dsn);
 \end{verbatim}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -2200,6 +2200,42 @@ and \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause} are ignored by
 this function.
 
 
+\membersection{wxDbTable::BuildWhereClause}\label{wxdbtablebuildwhereclause}
+\func{void}{BuildWhereClause}{\param{wxString \&}{pWhereClause},
+\param{int }{typeOfWhere}, \param{const wxString \&}{qualTableName=""},
+\param{bool }{useLikeComparison=false}}
+
+Constructs the portion of a SQL statement which would follow the word 'WHERE'
+in a SQL statement to be passed to the datasource.  The returned string
+does NOT include the word 'WHERE'.
+
+\wxheading{Parameters}
+
+\docparam{pWhereClause}{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{typeOfWhere}{The type of where clause to generate.  Can be one of
+two values:  DB\_WHERE\_KEYFIELDS or DB\_WHERE\_MATCHING.}
+\docparam{qualTableName}{{\it OPTIONAL}.  Prepended to all base table
+column names.  For use when a FROM clause has been specified with the
+\helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause},
+to clarify which table a column name reference belongs to.  Default is "".}
+\docparam{useLikeComparison}{{\it OPTIONAL}.  Should the constructed WHERE
+clause utilize the LIKE comparison operator.  If false, then the '='
+operator is used.  Default is false.}
+
+\wxheading{Remarks}
+
+This member function allows you to see what the SQL WHERE clause looks like
+that the ODBC class library builds.  This can be used for debugging purposes
+if you are having problems executing your own SQL statements.
+
+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.
+
+
 \membersection{wxDbTable::CanSelectForUpdate}\label{wxdbtablecanselectforupdate}
 
 \func{bool}{CanSelectForUpdate}{\void}