Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Small doc mods

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_2_BRANCH@8082 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2000-08-13 20:20:13 +00:00
parent 9708091a2f
commit 8397d5f719
3 changed files with 32 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/html/makedist.htm
View File

@@ -87,7 +87,7 @@ by projgen).<P>
<li>Build the WinHelp, HTML, and PDF documentation
via the VC++ makefile, src/msw/makefile.vc. You can use e.g. the targets <b>cleandocs alldocs</b>. Check the
output of the Windows Help Compiler for missing links, and edit/recompile the docs if necessary. The PDF documentation is produced from the Word RTF
document, and read into Word. Select all, press F9 to reformat the fields. Check the table of contents for
document, and read into Word. Apply the wxManual Style Template to improve presentation. Select all, press F9 to reformat the fields. Check the table of contents for
overspill from the body of a section into the TOC. If there's a problem, it's due to the lack of a
blank line at the end of the relevant .tex file. Insert the blank line, regenerate the RTF, and reload into Word.
Then use Adobe Distiller to generate the PDF.<P>

2
docs/latex/wx/database.tex
View File

@@ -18,7 +18,7 @@ The connection may be closed and reopened.
A much more robust and feature-rich set of ODBC classes is now
available and recommended for use in place of the wxDatabase class.
See details of these classes in:
See details of these classes in:
\helpref{wxDB}{wxdb}, \helpref{wxDbTable}{wxdbtable}
\latexignore{\rtfignore{\wxheading{Members}}}

52
docs/latex/wx/db.tex
View File

@@ -10,35 +10,17 @@ the data source to which the user has sufficient privileges.
<wx/db.h>
\latexignore{\rtfignore{\wxheading{Members}}}
\wxheading{Helper classes and data structures}
The following classes and structs are defined in db.cpp/.h for use with the wxDb class.
\begin{itemize}\itemsep=0pt
\helpref{wxDbColFor}{wxdbcolfor}
\helpref{wxDbColInf}{wxdbcolinf}
\helpref{wxDbTableInf}{wxdbtableinf}
\helpref{wxDbInf}{wxdbinf}
\item \helpref{wxDbColFor}{wxdbcolfor}
\item \helpref{wxDbColInf}{wxdbcolinf}
\item \helpref{wxDbTableInf}{wxdbtableinf}
\item \helpref{wxDbInf}{wxdbinf}
\end{itemize}
\subsection{Associated non-class functions}\label{wxdbfunctions}
The following functions are used in conjunction with the wxDb class.
\func{wxDb *}{wxDbGetConnection}{\param{wxDbConnectInf *}{pDbConfig}, \param{bool }{FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS}}
\func{bool}{wxDbFreeConnection}{\param{wxDb *}{pDb}}
\func{void}{wxDbCloseConnections}{\void}
\func{int}{wxDbConnectionsInUse}{\void}
\func{bool}{wxDbSqlLog}{\param{wxDbSqlLogState }{state}, \param{const wxChar *}{filename = SQL_LOG_FILENAME}}
\func{bool}{wxDbGetDataSource}{\param{HENV }{henv}, \param{char *}{Dsn}, \param{SWORD }{DsnMax}, \param{char *}{DsDesc}, \param{SWORD }{DsDescMax}, \param{UWORD }{direction = SQL_FETCH_NEXT}}
\wxheading{Constants}
NOTE: In a future release, all ODBC class constants will be prefaced with 'wx'
@@ -242,6 +224,24 @@ an instance of a wxDb is created (see \helpref{wxDb constructor}{wxdbconstr}).
\helpref{wxDbColFor}{wxdbcolfor}, \helpref{wxDbColInf}{wxdbcolinf}, \helpref{wxDbTable}{wxdbtable}, \helpref{wxDbTableInf}{wxdbtableinf}, \helpref{wxDbInf}{wxdbinf}
\subsection{Associated non-class functions}\label{wxdbfunctions}
The following functions are used in conjunction with the wxDb class.
\func{wxDb *}{wxDbGetConnection}{\param{wxDbConnectInf *}{pDbConfig}, \param{bool }{FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS}}
\func{bool}{wxDbFreeConnection}{\param{wxDb *}{pDb}}
\func{void}{wxDbCloseConnections}{\void}
\func{int}{wxDbConnectionsInUse}{\void}
\func{bool}{wxDbSqlLog}{\param{wxDbSqlLogState }{state}, \param{const wxChar *}{filename = SQL_LOG_FILENAME}}
\func{bool}{wxDbGetDataSource}{\param{HENV }{henv}, \param{char *}{Dsn}, \param{SWORD }{DsnMax}, \param{char *}{DsDesc}, \param{SWORD }{DsDescMax}, \param{UWORD }{direction = SQL_FETCH_NEXT}}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxDb::wxDb}\label{wxdbconstr}
\func{}{wxDb}{\void}
@@ -264,6 +264,7 @@ This is the constructor for the wxDb class. The wxDb object must
be created and opened before any database activity can occur.
\wxheading{Example}
\begin{verbatim}
wxDbConnectInf ConnectInf;
....Set values for member variables of ConnectInf here
@@ -319,6 +320,7 @@ At the end of your program, when you have finished all of your database work, yo
Any wxDbTable instances which use this connection must be deleted before closing the database connection.
\wxheading{Example}
\begin{verbatim}
// Commit any open transactions on the data source
sampleDB.CommitTrans();
@@ -425,6 +427,7 @@ This member function will display all of the ODBC error messages for the last OD
\helpref{wxDb::SetSqlLogging}{wxdbsetsqllogging}, wxDbSqlLog
\wxheading{Example}
\begin{verbatim}
if (SQLExecDirect(hstmt, (UCHAR FAR *) pSqlStmt, SQL_NTS) != SQL_SUCCESS)
// Display all ODBC errors for this stmt
@@ -599,6 +602,7 @@ to avoid undesired unbinding of columns.}
\helpref{wxDbColInf}{wxdbcolinf}
\wxheading{Example}
\begin{verbatim}
char *tableList[] = {"PARTS", 0};
wxDbColInf *colInf = pDb->GetColumns(tableList);
@@ -631,6 +635,7 @@ Used to retrieve result set data without binding column values to memory variabl
\helpref{wxDb::GetNext}{wxdbgetnext}, \helpref{wxDb::ExecSql}{wxdbexecsql}
\wxheading{Example}
\begin{verbatim}
SDWORD cb;
ULONG reqQty;
@@ -749,6 +754,7 @@ ODBC function call that erred out requires a hstmt argument.}
\helpref{wxDb::DispNextError}{wxdbdispnexterror}, \helpref{wxDb::DispAllErrors}{wxdbdispallerrors}
\wxheading{Example}
\begin{verbatim}
if (SQLExecDirect(hstmt, (UCHAR FAR *) pSqlStmt, SQL_NTS) != SQL_SUCCESS)
{
@@ -800,6 +806,7 @@ Use this member function to GRANT privileges to users for accessing tables in th
Some databases require user names to be specified in all capital letters (i.e. Oracle). This function does not automatically capitalize the user names passed in the comma-separated list. This is the responsibility of the calling routine.
\wxheading{Example}
\begin{verbatim}
db.Grant(DB_GRANT_SELECT | DB_GRANT_INSERT, "PARTS", "mary, sue");
\end{verbatim}
@@ -849,6 +856,7 @@ database administrator.}
After a wxDb instance is created, it must then be opened. When opening a data source, there must be hree pieces of information passed. The data source name, user name (ID) and the password for the user. No database activity on the data source can be performed until it is opened. This would normally be done at program startup and the data source would remain open for the duration of the program run. Note: It is possible to have multiple data sources open at the same time to support distributed database connections.
\wxheading{Example}
\begin{verbatim}
wxDb sampleDB(Db.Henv);
if (!sampleDB.Open("Oracle 7.1 HP/UX", "gtasker", "myPassword"))