Added missing rejigged IPC Latex files

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

diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex
index 1c0a471a071153195434a67c597d7efdba889ba5..0b051394a21268e2dc067e6a612f4780951e3719 100644 (file)
--- a/docs/latex/wx/db.tex
+++ b/docs/latex/wx/db.tex
@@ -624,7 +624,7 @@ entry is also logged to the defined log file.
 function call that erred required a hdbc or hstmt argument.}
 
 \docparam{aHstmt}{Handle to the ODBC statement being executed against.  Pass
 function call that erred required a hdbc or hstmt argument.}
 
 \docparam{aHstmt}{Handle to the ODBC statement being executed against.  Pass

-this in if the ODBC function call that erred out required a hstmt argument.}
+this in if the ODBC function call that failed required a hstmt argument.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -733,7 +733,7 @@ of processing.
 
 Older form (pre-2.3/2.4 of wxWindows) of the
 \helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors}.  This method is
 
 Older form (pre-2.3/2.4 of wxWindows) of the
 \helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors}.  This method is

-provided for backward compatability only.  The method
+provided for backward compatibility only.  The method

 \helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors} should be
 used in place of this method.
 
 \helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors} should be
 used in place of this method.
 


@@ -981,9 +981,9 @@ in the result set after the current position of the cursor.
 
 \docparam{aHenv}{A handle to the ODBC environment.}
 \docparam{aHdbc}{{\it OPTIONAL.}  A handle to the ODBC connection.  Pass this
 
 \docparam{aHenv}{A handle to the ODBC environment.}
 \docparam{aHdbc}{{\it OPTIONAL.}  A handle to the ODBC connection.  Pass this

-in if the ODBC function call that erred out required a hdbc or hstmt argument.}
+in if the ODBC function call that failed required a hdbc or hstmt argument.}

 \docparam{AHstmt}{{\it OPTIONAL.}A handle to the ODBC statement being executed
 \docparam{AHstmt}{{\it OPTIONAL.}A handle to the ODBC statement being executed

-against.  Pass this in if the ODBC function call that erred out requires a
+against.  Pass this in if the ODBC function call that failed requires a

 hstmt argument.}
 
 \wxheading{Example}
 hstmt argument.}
 
 \wxheading{Example}


@@ -991,8 +991,7 @@ hstmt argument.}
 \begin{verbatim}
    if (SQLExecDirect(hstmt, (UCHAR FAR *) pSqlStmt, SQL_NTS) != SQL_SUCCESS)
    {
 \begin{verbatim}
    if (SQLExecDirect(hstmt, (UCHAR FAR *) pSqlStmt, SQL_NTS) != SQL_SUCCESS)
    {

-      // Display all ODBC errors for this stmt
-      return(db.DispAllErrors(db.henv, db.hdbc, hstmt));
+      return(db.GetNextError(db.henv, db.hdbc, hstmt));

    }
 \end{verbatim}
 
    }
 \end{verbatim}
 


@@ -1422,7 +1421,8 @@ at least minimal privileges to the table).
 \docparam{tableName}{Name of the table on which to check privileges.
 {\it tableName} may refer to a table, view, alias or synonym.}
 \docparam{priv}{The table privilege being evaluated. May be one of the
 \docparam{tableName}{Name of the table on which to check privileges.
 {\it tableName} may refer to a table, view, alias or synonym.}
 \docparam{priv}{The table privilege being evaluated. May be one of the

-following (or a datasource specific privilege):}
+following (or a datasource specific privilege):
+

 \begin{verbatim}
     SELECT      : The connected user is permitted to retrieve data for
                   one or more columns of the table.
 \begin{verbatim}
     SELECT      : The connected user is permitted to retrieve data for
                   one or more columns of the table.


@@ -1442,25 +1442,28 @@ following (or a datasource specific privilege):}
                   example, a unique, referential, or table check
                   constraint).
 \end{verbatim}
                   example, a unique, referential, or table check
                   constraint).
 \end{verbatim}

+}

 \docparam{userID}{{\it OPTIONAL.}  User for which to determine if the privilege
 specified to be checked is granted or not.  Default is "".
 \docparam{userID}{{\it OPTIONAL.}  User for which to determine if the privilege
 specified to be checked is granted or not.  Default is "".

-{\it userID} is evaluated as follows:}
+{\it userID} is evaluated as follows:
+

 \begin{verbatim}
          userID == NULL  ... NOT ALLOWED!
          userID == ""    ... UserID set equal to 'this->uid'
          userID != ""    ... UserID set equal to 'userID'
 \end{verbatim}
 \begin{verbatim}
          userID == NULL  ... NOT ALLOWED!
          userID == ""    ... UserID set equal to 'this->uid'
          userID != ""    ... UserID set equal to 'userID'
 \end{verbatim}

-
+}

 \docparam{schema}{{\it OPTIONAL.}  Owner of the table.  Specify a userID when the datasource
 you are connected to allows multiple unique tables with the same name to be
 owned by different users.  Specifying the table owner makes determination of the
 \docparam{schema}{{\it OPTIONAL.}  Owner of the table.  Specify a userID when the datasource
 you are connected to allows multiple unique tables with the same name to be
 owned by different users.  Specifying the table owner makes determination of the

-users privileges MUCH faster.  Default is NULL.  {\it userID} is evaluated as follows:}
+users privileges MUCH faster.  Default is NULL.  {\it userID} is evaluated as follows:
+

 \begin{verbatim}
          schema == NULL  ... Any owner (DEFAULT)
          schema == ""    ... Owned by 'this->uid'
          schema != ""    ... Owned by userID specified in 'schema'
 \end{verbatim}
 \begin{verbatim}
          schema == NULL  ... Any owner (DEFAULT)
          schema == ""    ... Owned by 'this->uid'
          schema != ""    ... Owned by userID specified in 'schema'
 \end{verbatim}

-
+}

 \docparam{path}{{\it OPTIONAL.}  Path to the table.  Default is "".
 Currently unused.}
 
 \docparam{path}{{\it OPTIONAL.}  Path to the table.  Default is "".
 Currently unused.}
 


@@ -1685,13 +1688,13 @@ name, user ID, password and default directory path (used with dBase).  Other
 optional fields held in this class are and file type, both for future
 functions planned to be added for creating/manipulating datasource definitions.
 
 optional fields held in this class are and file type, both for future
 functions planned to be added for creating/manipulating datasource definitions.
 

-\membersection{wxDbConnectInf::wxDbConnectInfo}
+\membersection{wxDbConnectInf::wxDbConnectInf}

 
 \func{}{wxDbConnectInf}{\void}
 
 Default constructor.
 
 
 \func{}{wxDbConnectInf}{\void}
 
 Default constructor.
 

-\func{}{wxDb}{\param{HENV }{henv}, \param{const wxString \&}{dsn},
+\func{}{wxDbConnectInf}{\param{HENV }{henv}, \param{const wxString \&}{dsn},

 \param{const wxString \&}{userID=""}, \param{const wxString \&}{password},
 \param{const wxString \&}{defaultDir=""}, \param{const wxString \&}{description=""},
 \param{const wxString \&}{fileType=""}}
 \param{const wxString \&}{userID=""}, \param{const wxString \&}{password},
 \param{const wxString \&}{defaultDir=""}, \param{const wxString \&}{description=""},
 \param{const wxString \&}{fileType=""}}


@@ -2569,11 +2572,11 @@ by specifying the data in the columns to match on.
 
 To delete all users with a first name of "JOHN", do the following:
 
 
 To delete all users with a first name of "JOHN", do the following:
 

-\begin{verbatim}
-    1)  Clear all "columns" using wxDbTable::ClearMemberVars().
-    2)  Set the FIRST_NAME column equal to "JOHN".
-    3)  Call wxDbTable::DeleteMatching().
-\end{verbatim}
+\begin{enumerate}\itemsep=0pt
+\item Clear all "columns" using wxDbTable::ClearMemberVars().
+\item Set the FIRST\_NAME column equal to "JOHN".
+\item Call wxDbTable::DeleteMatching().
+\end{enumerate}

 
 The WHERE clause is built by the ODBC class library based on all non-NULL
 columns.  This allows deletion of records by matching on any column(s) in
 
 The WHERE clause is built by the ODBC class library based on all non-NULL
 columns.  This allows deletion of records by matching on any column(s) in


@@ -3106,7 +3109,7 @@ If the function returns a FALSE value due to the table not existing, a log
 entry is recorded for the datasource connection indicating the problem
 that was detected when checking for table existence.  Note that it is usually
 best for the calling routine to check for the existence of the table and for
 entry is recorded for the datasource connection indicating the problem
 that was detected when checking for table existence.  Note that it is usually
 best for the calling routine to check for the existence of the table and for

-sufficent user privileges to access the table in the mode (wxDB\_QUERY\_ONLY or
+sufficient user privileges to access the table in the mode (wxDB\_QUERY\_ONLY or

 !wxDB\_QUERY\_ONLY) before trying to open the table for the best possible
 explanation as to why a table cannot be opened.
 
 !wxDB\_QUERY\_ONLY) before trying to open the table for the best possible
 explanation as to why a table cannot be opened.
 


@@ -3265,27 +3268,25 @@ specific function calls.
 
 The requirements of the SELECT statement are the following:
 
 
 The requirements of the SELECT statement are the following:
 

-\begin{verbatim}
-    1. Must return the correct number of columns.  In the derived
-       wxDbTable constructor, it is specified how many columns are in
-       the wxDbTable object.  The SELECT statement must return exactly
-       that many columns.
-
-    2. The columns must be returned in the same sequence as specified
-       when defining the bounds columns using wxDbTable::SetColDefs(),
-       and the columns returned must be of the proper data type.  For
-       example, if column 3 is defined in the wxDbTable bound column
-       definitions to be a float, the SELECT statement must return a
-       float for column 3 (e.g. PRICE * 1.10 to increase the price by
-       10%).
-
-    3. 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
-       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.
-\end{verbatim}
+\begin{enumerate}
+\item Must return the correct number of columns.  In the derived
+wxDbTable constructor, it is specified how many columns are in
+the wxDbTable object. The SELECT statement must return exactly
+that many columns.
+\item The columns must be returned in the same sequence as specified
+when defining the bounds columns using wxDbTable::SetColDefs(),
+and the columns returned must be of the proper data type.  For
+example, if column 3 is defined in the wxDbTable bound column
+definitions to be a float, the SELECT statement must return a
+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
+wxDbTable::CanUpdByROWID() 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.
+\end{enumerate}

 
 Even though data can be selected from multiple tables (joins) in your select
 statement, only the base table associated with this wxDbTable object
 
 Even though data can be selected from multiple tables (joins) in your select
 statement, only the base table associated with this wxDbTable object