document wxDb::ExecSql() 3 params overload (patch 1240839)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@34960 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2005-07-28 21:28:05 +00:00
parent e6d67b57dd
commit 2b3c87952d

View File

@@ -711,12 +711,20 @@ If the view does not exist, this function will return true. Note that views are
\func{bool}{ExecSql}{\param{const wxString \&}{pSqlStmt}}
\func{bool}{ExecSql}{\param{const wxString \&}{pSqlStmt}, \param{wxDbColInf **}{columns}, \param{short \&}{numcols}}
Allows a native SQL command to be executed directly against the datasource. In addition to being able to run any standard SQL command, use of this function allows a user to (potentially) utilize features specific to the datasource they are connected to that may not be available through ODBC. The ODBC driver will pass the specified command directly to the datasource.
To get column amount and column names or other information about returned columns, pass {\it 'columns'} and {\it 'numcols'} parameters to the function also.
\wxheading{Parameters}
\docparam{pSqlStmt}{Pointer to the SQL statement to be executed.}
\docparam{columns}{On success, this function will set this pointer to point to array of \helpref{wxDbColInf}{wxdbcolinf} objects, holding information about columns returned by the query. You need to call delete[] for the pointer you pass here after you don't use it anymore to prevent memory leak.}
\docparam{numcols}{Reference to variable where amount of objects in {\it 'columns'}-parameter will be set.}
\wxheading{Remarks}
This member extends the wxDb class and allows you to build and execute ANY VALID