X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..a9de2608baddf0d5a2a559f9acebfc56aa0d2d47:/docs/latex/wx/db.tex

diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex
index 2910dd5f26..0c21678a03 100644
--- a/docs/latex/wx/db.tex
+++ b/docs/latex/wx/db.tex
@@ -254,7 +254,7 @@ ODBC errors.}
 \wxheading{Remarks}
 
 Default cursor scrolling is defined by wxODBC\_FWD\_ONLY\_CURSORS in setup.h
-when the wxWindows library is built.  This behavior can be overridden when
+when the wxWidgets library is built.  This behavior can be overridden when
 an instance of a wxDb is created (see \helpref{wxDb constructor}{wxdbconstr}).
 Default setting of this value true, as not all databases/drivers support
 both types of cursors.
@@ -355,7 +355,7 @@ cached connections created by calls to wxDbGetConnection().
 \func{const wxChar *}{wxDbLogExtendedErrorMsg}{\param{const wxChar *}{userText}, \param{wxDb *}{pDb}, \param{wxChar *}{ErrFile}, \param{int }{ErrLine}}
 
 Writes a message to the wxLog window (stdout usually) when an internal
-error situation occurs.  This function only works in DEBUG builds
+error situation occurs.
 
 \func{bool}{wxDbSqlLog}{\param{wxDbSqlLogState }{state}, \param{const wxString \&}{filename = SQL\_LOG\_FILENAME}}
 
@@ -596,7 +596,7 @@ Possible values returned by this function can be viewed in the
 \helpref{Enumerated types}{wxdbenumeratedtypes} section of wxDb.
 
 There are known issues with conformance to the ODBC standards with several
-datasources supported by the wxWindows ODBC classes.  Please see the overview
+datasources supported by the wxWidgets ODBC classes.  Please see the overview
 for specific details on which datasource have which issues.
 
 \wxheading{Return value}
@@ -731,7 +731,7 @@ of processing.
 
 \func{bool}{IsFwdOnlyCursors}{\void}
 
-Older form (pre-2.3/2.4 of wxWindows) of the
+Older form (pre-2.3/2.4 of wxWidgets) of the
 \helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors}.  This method is
 provided for backward compatibility only.  The method
 \helpref{wxDb::IsFwdOnlyCursors}{wxdbisfwdonlycursors} should be
@@ -1093,12 +1093,12 @@ use backward scrolling cursors and their associated functions (see note above).
 
 \wxheading{Remarks}
 
-Added as of wxWindows v2.4 release, this function is a renamed version of
-wxDb::FwdOnlyCursors() to match the normal wxWindows naming conventions for
+Added as of wxWidgets v2.4 release, this function is a renamed version of
+wxDb::FwdOnlyCursors() to match the normal wxWidgets naming conventions for
 class member functions.
 
 This function is not available in versions prior to v2.4.  You should
-use \helpref{wxDb::FwdOnlyCursors}{wxdbfwdonlycursors} for wxWindows
+use \helpref{wxDb::FwdOnlyCursors}{wxdbfwdonlycursors} for wxWidgets
 versions prior to 2.4.
 
 \wxheading{See also}
@@ -1185,7 +1185,13 @@ used for behavioral descriptions.
 \membersection{wxDb::Open}\label{wxdbopen}
 
 \func{bool}{Open}{\param{const wxString \&}{Dsn}, \param{const wxString \&}{Uid},
-\param{const wxString \&}{AuthStr}}
+\param{const wxString \&}{AuthStr}, \param{bool }{failOnDataTypeUnsupported}}
+
+\func{bool}{Open}{\param{const wxString \&}{inConnectStr}, 
+\param{bool }{failOnDataTypeUnsupported}}
+
+\func{bool}{Open}{\param{wxDbConnectInf *}{dbConnectInf}, 
+\param{bool }{failOnDataTypeUnsupported}}
 
 \func{bool}{Open}{\param{wxDb *}{copyDb}}
 
@@ -1222,9 +1228,25 @@ Privileges include being able to create new objects, update objects, delete
 objects and so on.  Users and privileges are normally administered by the
 database administrator.}
 \docparam{AuthStr}{The password associated with the Uid.}
-\docparam{copyDb}{Already completely configured and opened datasource connection
-from which all Dsn, Uid, AuthStr, and data typing information is to be copied
-from for use by this datasource connection.}
+\docparam{failOnDataTypeUnsupporte}{As part of connecting to a database, the 
+wxDb::Open() function will query the database to find out the native types 
+that it supports.  With some databases, some data types may not be supported,
+or not sufficiently supported, for use with the wxODBC classes.  Normally
+a program should fail in this case, so as not to try to use a data type
+that is not supported.  This parameter allows the programmer to override the
+failure if they wish and continue on using the connection.}
+\docparam{dbConnectInf}{Contains a DSN, Uid, Password, or a connection string 
+to be used in opening a new connection to the database.  If a connection
+string is present, then the connection string will be used.  If there is no 
+connection string present, then the DSN, Uid, and Password are used.}
+\docparam{inConnectStr}{A valid ODBC connection string used to connect to a 
+database}
+\docparam{copyDb}{Already completely configured and opened datasource 
+connection from which all Dsn, Uid, AuthStr, connection string, and data 
+typing information is to be copied from for use by this datasource 
+connection.  If 'copyDb' used a connection string to create its connection 
+originally, then the connection being made by this call to wxDb::Open() will 
+use that same connection string.}
 
 \wxheading{Remarks}
 
@@ -1421,7 +1443,7 @@ 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
-following (or a datasource specific privilege):
+following (or a datasource specific privilege):}
 
 \begin{verbatim}
     SELECT      : The connected user is permitted to retrieve data for
@@ -1442,28 +1464,29 @@ following (or a datasource specific privilege):
                   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 "".
-{\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}
-}
+
 \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}
-}
+
 \docparam{path}{{\it OPTIONAL.}  Path to the table.  Default is "".
 Currently unused.}
 
@@ -1707,15 +1730,15 @@ one in to the function.
 
 \wxheading{Parameters}
 
-\docparam{henv}{Environment handle used for this connection.  See
+\docparam{henv}{Environment handle used for this connection.  See\rtfsp
 \helpref{wxDConnectInf::AllocHenv}{wxdbconnectinfallochenv} for how to create
 an SQL environment handle.  NOTE: Passing in a NULL for this parameter will
 inform the constructor that it should create its own SQL environment handle.
-If NULL is passed for this parameter, the constructor will call
+If NULL is passed for this parameter, the constructor will call\rtfsp
 \helpref{wxDConnectInf::AllocHenv}{wxdbconnectinfallochenv} internally.  A
 flag is set internally also to indicate that the HENV was created by the
 constructor so that when the default class destructor is called, the
-destructor will call \helpref{wxDConnectInf::FreeHenv}{wxdbconnectinffreehenv}
+destructor will call \helpref{wxDConnectInf::FreeHenv}{wxdbconnectinffreehenv}\rtfsp
 to free the environment handle automatically.}
 \docparam{dsn}{Name of the datasource to be used in creating wxDb instances
 for creating connection(s) to a datasource.}
@@ -1759,7 +1782,7 @@ automatically, and manage the destruction of the handle.
 
 Handles the default destruction of the instance of the class.  If the long form
 of the \helpref{wxDConnectInf}{wxdbconnectinf} was used, then this destructor
-also takes care of calling
+also takes care of calling\rtfsp
 \helpref{wxDConnectInf::FreeHenv}{wxdbconnectinffreehenv} to free the
 SQL environment handle.
 
@@ -1783,10 +1806,10 @@ Frees the SQL environment handle being managed by the instance of this class.
 
 \wxheading{Remarks}
 
-If the SQL environment handle was created using the long form of the
+If the SQL environment handle was created using the long form of the\rtfsp
 \helpref{wxDbConnectInf}{wxdbconnectinf} constructor, then the flag indicating
 that the HENV should be destroyed when the classes destructor is called
-is reset to be false, so that any future handles created using the
+is reset to be false, so that any future handles created using the\rtfsp
 \helpref{wxDbConnectInf::AllocHenv}{wxdbconnectinfallochenv} function
 must be manually released with a call to this function.
 
@@ -1962,7 +1985,7 @@ class so a program can create a wxDbTableInf array instance to maintain all
 information about all tables in the datasource to have all the datasource's
 information in one memory structure.
 
-Primarily, this class is used internally by the wxWindows ODBC classes.
+Primarily, this class is used internally by the wxWidgets ODBC classes.
 
 \begin{verbatim}
     wxChar        catalog[128+1];
@@ -3053,7 +3076,7 @@ calls which defined the columns accessible to this wxDbTable instance.}
 
 \wxheading{Remarks}
 
-NULL column support is currently not fully implemented as of wxWindows 2.4.
+NULL column support is currently not fully implemented as of wxWidgets 2.4.
 
 \membersection{wxDbTable::IsCursorClosedOnCommit}\label{wxdbtableiscursorclosedoncommit}
 
@@ -3945,7 +3968,7 @@ an introduction to using the wxDbGrid classes.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxDbGridColInfo::wxDbGridColInfo}\label{wxdbgridcolinfo}
+\membersection{wxDbGridColInfo::wxDbGridColInfo}\label{wxdbgridcolinfoctor}
 
 \func{}{wxDbGridColInfo}{\param{int }{colNo}, \param{wxString }{type},
   \param{wxString }{title}, \param{wxDbGridColInfo *}{next}}
@@ -3997,7 +4020,7 @@ info structure as this is the structure which informs the grid of how you want t
 \helpref{wxDbTable}{wxdbtable}. If no datatype conversion or the referenced column number does not exist the
 the behavior is undefined.
 
-See the example at \helpref{wxDbGridColInfo::wxDbGridColInfo}{wxdbgridcolinfo}.
+See the example at \helpref{wxDbGridColInfo::wxDbGridColInfo}{wxdbgridcolinfoctor}.
 
 \section{\class{wxDbGridTableBase}}\label{wxdbgridtablebase}