+\helpref{wxDbTable}{wxdbtable}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxDbTable::wxDbTable}\label{wxdbtableconstr}
+
+\func{}{wxDbTable}{\param{wxDb *}{pwxDb}, \param{const char *}{tblName}, \param{const int }{nCols},\param{const char *}{qryTblName = 0}, \param{bool}{qryOnly = !wxDB_QUERY_ONLY},\param{const char *}{tblPath=NULL}}
+
+Default constructor.
+
+\wxheading{Parameters}
+
+\docparam{pSqlStmt}{}
+\docparam{typeOfDel}{}
+\docparam{pWhereClause}{Default is 0.}
+
+
+\membersection{wxDbTable::wxDbTable}\label{wxdbtabledestr}
+
+\func{virtual}{\destruct{wxDbTable}}{}
+
+Virtual default destructor.
+
+
+\membersection{wxDbTable::BuildDeleteStmt}\label{wxdbtablebuilddeletestmt}
+
+\func{void}{BuildSelectStmt}{\param{char *}{pSqlStmt}, \param{int }{typeOfDel}, \param{const char *}{pWhereClause=0}}
+
+\wxheading{Parameters}
+
+\docparam{pSqlStmt}{}
+\docparam{typeOfDel}{}
+\docparam{pWhereClause}{Default is 0.}
+
+
+\membersection{wxDbTable::BuildSelectStmt}\label{wxdbtablebuildselectstmt}
+
+\func{void}{BuildSelectStmt}{\param{char *}{pSqlStmt}, \param{int }{typeOfSelect}, \param{bool }{distinct}}
+
+\wxheading{Parameters}
+
+\docparam{pSqlStmt}{}
+\docparam{typeOfSelect}{}
+\docparam{distinct}{}
+
+
+\membersection{wxDbTable::BuildUpdateStmt}\label{wxdbtablebuildupdatestmt}
+
+\func{void}{BuildSelectStmt}{\param{char *}{pSqlStmt}, \param{int }{typeOfUpd}, \param{const char *}{pWhereClause=0}}
+
+\wxheading{Parameters}
+
+\docparam{pSqlStmt}{}
+\docparam{typeOfUpd}{}
+\docparam{pWhereClause}{Default is 0.}
+
+
+\membersection{wxDbTable::BuildWhereStmt}\label{wxdbtablebuildwherestmt}
+
+\func{void}{BuildSelectStmt}{\param{char *}{pWhereClause}, \param{int }{typeOfWhere}, \param{const char *}{qualTableName=0}, \param{const char *}{useLikeComparison=FALSE}}
+
+\wxheading{Parameters}
+
+\docparam{pWhereClause}{}
+\docparam{typeOfWhere}{}
+\docparam{qualTableName}{Default is 0.}
+\docparam{useLikeComparison}{Default is FALSE.}
+
+
+\membersection{wxDbTable::CanSelectForUpdate}\label{wxdbtablecanselectforupdate}
+
+\func{bool}{CanSelectForUpdate}{\void}
+
+\wxheading{Remarks}
+
+
+\membersection{wxDbTable::CanUpdateByROWID}\label{wxdbtablecanupdatebyrowid}
+
+\func{bool}{CanUpdateByROWID}{\void}
+
+\wxheading{Remarks}
+
+
+\membersection{wxDbTable::ClearMemberVars}\label{wxdbtableclearmembervars}
+
+\func{void}{ClearMemberVars}{\void}
+
+\wxheading{Remarks}
+
+
+\membersection{wxDbTable::CloseCursor}\label{wxdbtableclosecursor}
+
+\func{bool}{CloseCursor}{\param{HSTMT}{cursor}}
+
+\wxheading{Parameters}
+
+\docparam{cursor}{}
+
+\wxheading{Remarks}
+
+
+\membersection{wxDbTable::Count}\label{wxdbtablecount}
+
+\func{ULONG}{Count}{\param{const char *}{args="*"}}
+
+\wxheading{Parameters}
+
+\docparam{args}{Default is "*".}
+
+\wxheading{Remarks}
+
+
+\membersection{wxDbTable::CreateIndex}\label{wxdbtablecreateindex}
+
+\func{bool}{CreateIndex}{\param{const char *}{idxName}, \param{bool}{unique}, \param{int }{noIdxCols}, \param{wxDbIdxDef *}{pIdxDefs}, \param{bool }{attemptDrop=TRUE}}
+
+\wxheading{Parameters}
+
+\docparam{idxName}{}
+\docparam{unique}{}
+\docparam{noIdxCols}{}
+\docparam{pIdxDefs}{}
+\docparam{attemptDrop}{Default is TRUE.}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::CreateTable}\label{wxdbtablecreatetable}
+
+\func{bool}{CreateTable}{\param{bool }{attemptDrop=TRUE}}
+
+\wxheading{Parameters}
+
+\docparam{attemptDrop}{Default is TRUE.}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::DB_STATUS}\label{wxdbtabledbstatus}
+
+\func{bool}{DB_STATUS}{\void}
+
+Accessor function for the private member variable DB_STATUS.
+
+\membersection{wxDbTable::IsColNull}\label{wxdbtableiscolnull}
+
+\func{bool}{IsColNull}{\param{int }{colNo}}
+
+\wxheading{Parameters}
+
+\docparam{colNo}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::Delete}\label{wxdbtabledelete}
+
+\func{bool}{Delete}{\void}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::DeleteCursor}\label{wxdbtabledeletecursor}
+
+\func{bool}{DeleteCursor}{\param{HSTMT }{hstmtDel}}
+
+\wxheading{Parameters}
+
+\docparam{hstmtDel}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::DeleteWhere}\label{wxdbtabledeletewhere}
+
+\func{bool}{DeleteWhere}{\param{const char *}{pWhereClause}}
+
+\wxheading{Parameters}
+
+\docparam{pWhereClause}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::DeleteMatching}\label{wxdbtabledeletematching}
+
+\func{bool}{DeleteMatching}{\void}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::DropIndex}\label{wxdbtabledropindex}
+
+\func{bool}{DropIndex}{\param{const char *}{idxName}}
+
+\wxheading{Parameters}
+
+\docparam{idxName}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::DropTable}\label{wxdbtabledroptable}
+
+\func{bool}{DropTable}{\void}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::GetColDefs}\label{wxdbtablegetcoldefs}
+
+\func{wxDbColDef *}{GetColDefs}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::GetCursor}\label{wxdbtablegetcursor}
+
+\func{HSTMT}{GetCursor}{\void}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::GetDb}\label{wxdbtablegetdb}
+
+\func{wxDb *}{GetDb}{}
+
+Accessor function for the private member variable pDb which is a pointer to the datasource connection that this wxDbTable instance uses.
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::GetFirst}\label{wxdbtablegetfirst}
+
+\func{bool}{GetFirst}{\void}
+
+\wxheading{Remarks}
+
+This function can only be used if the datasource connection used by the wxDbTable instance was created with FwdOnlyCursors set to FALSE. If the connection does not allow backward scrolling cursors, this function will return FALSE, and the data contained in the bound columns will be undefined.
+
+\wxheading{See also}
+
+\helpref{wxDb::FwdOnlyCursors}{wxdbfwdonlycursors}
+
+\membersection{wxDbTable::GetFromClause}\label{wxdbtablegetfromclause}
+
+\func{const char *}{GetFromClause}{}
+
+Accessor function that returns the current FROM setting assigned with the \helpref{wxDbTable::SetFromClause}{wxdbtablesetfromclause}.
+
+\membersection{wxDbTable::GetLast}\label{wxdbtablegetlast}
+
+\func{bool}{GetLast}{\void}
+
+\wxheading{Remarks}
+
+This function can only be used if the datasource connection used by the wxDbTable instance was created with FwdOnlyCursors set to FALSE. If the connection does not allow backward scrolling cursors, this function will return FALSE, and the data contained in the bound columns will be undefined.
+
+\wxheading{See also}
+
+\helpref{wxDb::FwdOnlyCursors}{wxdbfwdonlycursors}
+
+\membersection{wxDbTable::GetNewCursor}\label{wxdbtablegetnewcursor}
+
+\func{HSTMT *}{GetNewCursor}{\param{bool }{setCursor=FALSE}, \param{bool }{bindColumns=TRUE}}
+
+\wxheading{Parameters}
+
+\docparam{setCursor}{Default is FALSE.}
+\docparam{bindColumns}{Default is TRUE.}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::GetNext}\label{wxdbtablegetnext}
+
+\func{bool}{GetNext}{\void}
+
+\wxheading{Remarks}
+
+
+\membersection{wxDbTable::GetNumberOfColumns}\label{wxdbtablegetnumberofcolumns}
+
+\func{bool}{GetNumberOfColumns}{}
+
+Accessor function that returns the number of columns that are statically bound for access by the wxDbTable instance.
+
+\membersection{wxDbTable::GetOrderByClause}\label{wxdbtablegetorderbyclause}
+
+\func{const char *}{GetOrderByClause}{}
+
+Accessor function that returns the current ORDER BY setting assigned with the \helpref{wxDbTable::SetOrderByClause}{wxdbtablesetorderbyclause}.
+
+\membersection{wxDbTable::GetPrev}\label{wxdbtablegetprev}
+
+\func{bool}{GetPrev}{\void}
+
+\wxheading{Remarks}
+
+This function can only be used if the datasource connection used by the wxDbTable instance was created with FwdOnlyCursors set to FALSE. If the connection does not allow backward scrolling cursors, this function will return FALSE, and the data contained in the bound columns will be undefined.
+
+\wxheading{See also}
+
+\helpref{wxDb::FwdOnlyCursors}{wxdbfwdonlycursors}
+
+
+\membersection{wxDbTable::GetQueryTableName}\label{wxdbtablegetquerytablename}
+
+\func{const char *}{GetQueryTableName}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::GetRowNum}\label{wxdbtablegetrownum}
+
+\func{UWORD}{GetRowNum}{\void}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::GetTableName}\label{wxdbtablegettablename}
+
+\func{const char *}{GetTableName}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::GetTablePath}\label{wxdbtablegettablepath}
+
+\func{const char *}{GetTablePath}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::GetWhereClause}\label{wxdbtablegetwhereclause}
+
+\func{const char *}{GetWhereClause}{}
+
+Accessor function that returns the current WHERE setting assigned with the \helpref{wxDbTable::SetWhereClause}{wxdbtablesetwhereclause}
+
+\membersection{wxDbTable::Insert}\label{wxdbtableinsert}
+
+\func{int}{Insert}{\void}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::IsCursorClosedOnCommit}\label{wxdbtableiscursorclosedoncommit}
+
+\func{bool}{IsCursorClosedOnCommit}{\void}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::IsQueryOnly}\label{wxdbtableisqueryonly}
+
+\func{bool}{IsQueryOnly}{}
+
+Accessor function that returns a value indicating if this wxDbTable instance was created to allow only queries to be performed on the bound columns. If this function returns TRUE, then no actions may be performed using this wxDbTable instance that would modify (insert/delete/update) the table's data.
+
+\membersection{wxDbTable::Open}\label{wxdbtableopen}
+
+\func{bool}{Open}{\void}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::Query}\label{wxdbtablequery}
+
+\func{virtual bool}{Query}{\param{bool}{forUpdate=FALSE}, \param{bool}{distinct=FALSE}}
+
+\wxheading{Parameters}
+
+\docparam{forUpdate}{Default is FALSE.}
+\docparam{distinct}{Default is FALSE.}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::QueryBySqlStmt}\label{wxdbtablequerybysqlstmt}
+
+\func{bool}{QueryBySqlStmt}{\param{const char *}{pSqlStmt}}
+
+\wxheading{Parameters}
+
+\docparam{pSqlStmt}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::QueryMatching}\label{wxdbtablequerymatching}
+
+\func{virtual bool}{QueryMatching}{\param{bool}{forUpdate=FALSE}, \param{bool}{distinct=FALSE}}
+
+\wxheading{Parameters}
+
+\docparam{forUpdate}{Default is FALSE.}
+\docparam{distinct}{Default is FALSE.}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::QueryOnKeyFields}\label{wxdbtablequeryonkeyfields}
+
+\func{bool}{QueryOnKeyFields}{\param{bool}{forUpdate=FALSE}, \param{bool}{distinct=FALSE}}
+
+\wxheading{Parameters}
+
+\docparam{forUpdate}{Default is FALSE.}
+\docparam{distinct}{Default is FALSE.}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::Refresh}\label{wxdbtablerefresh}
+
+\func{bool}{Refresh}{\void}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::SetColDefs}\label{wxdbtablesetcoldefs}
+
+\func{void}{SetColDefs}{\param{int }{index}, \param{const char *}{fieldName}, \param{int }{dataType}, \param{void *}{pData}, \param{int }{cType}, \param{int }{size}, \param{bool }{keyField = FALSE}, \param{bool }{upd = TRUE}, \param{bool }{insAllow = TRUE}, \param{bool }{derivedCol = FALSE}}
+
+\func{wxDbColDataPtr *}{SetColDefs}{\param{wxDbColInf *}{colInfs}, \param{ULONG }{numCols}}
+
+\wxheading{Parameters}
+
+\docparam{index}{}
+\docparam{fieldName}{}
+\docparam{dataType}{}
+\docparam{pData}{}
+\docparam{cType}{}
+\docparam{size}{}
+\docparam{keyField}{Default is FALSE.}
+\docparam{upd}{Default is TRUE.}
+\docparam{insAllow}{Default is TRUE.}
+\docparam{derivedCol}{Default is FALSE.}
+
+\docparam{colInfs}{}
+\docparam{numCols}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::SetCursor}\label{wxdbtablesetcursor}
+
+\func{bool}{Open}{\param{HSTMT *}{hstmtActivate = (void **) wxDB_DEFAULT_CURSOR}}
+
+\wxheading{Parameters}
+
+\docparam{hstmtActivate}{Default is wxDB_DEFAULT_CURSOR.}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::SetFromClause}\label{wxdbtablesetfromclause}
+
+\func{void}{SetFromClause}{\param{const wxString& }{From}}
+
+\wxheading{Parameters}
+
+\docparam{From}{}
+
+\membersection{wxDbTable::SetNull}\label{wxdbtablesetnull}
+
+\func{bool}{SetNull}{\param{int }{colNo}}
+
+\func{bool}{SetNull}{\param{const char *}{colName}}
+
+\wxheading{Parameters}
+
+\docparam{colNo}{}
+\docparam{colName}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::SetOrderByClause}\label{wxdbtablesetorderbyclause}
+
+\func{void}{SetOrderByClause}{\param{const wxString& }{OrderBy}}
+
+\wxheading{Parameters}
+
+\docparam{OrderBy}{}
+
+\membersection{wxDbTable::SetQueryTimeout}\label{wxdbtablesetquerytimeout}
+
+\func{bool}{SetQueryTimeout}{\param{UDWORD }{nSeconds}}
+
+\wxheading{Parameters}
+
+\docparam{nSeconds}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::SetWhereClause}\label{wxdbtablesetwhereclause}
+
+\func{void}{SetWhereClause}{\param{const wxString& }{Where}}
+
+\wxheading{Parameters}
+
+\docparam{Where}{}
+
+\membersection{wxDbTable::Update}\label{wxdbtableupdate}
+
+\func{bool}{Update}{\void}
+
+\func{bool}{Update}{\param{const char *}{pSqlStmt}}
+
+\wxheading{Parameters}
+
+\docparam{pSqlStmt}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::UpdateWhere}\label{wxdbtableupdatewhere}
+
+\func{bool}{UpdateWhere}{\param{const char *}{pWhereClause}}
+
+\wxheading{Parameters}
+
+\docparam{pWhereClause}{}
+
+\wxheading{Remarks}
+
+\membersection{wxDbTable::operator $++$}\label{wxdbtableplusplus}
+
+\func{bool}{operator $++$}{\void}
+
+Same as \helpref{wxDbTable::GetNext}{wxdbtablegetnext}
+
+\wxheading{See also}
+
+\helpref{wxDbTable::GetNext}{wxdbtablegetnext}
+
+\membersection{wxDbTable::operator $--$}\label{wxdbtableminusminus}
+
+\func{bool}{operator $--$}{\void}
+
+Same as \helpref{wxDbTable::GetPrev}{wxdbtablegetprev}
+
+\wxheading{See also}
+
+\helpref{wxDbTable::GetPrev}{wxdbtablegetprev}
+
+\section{\class{wxDbTableInf}}\label{wxdbtableinf}
+
+Currently only used by wxDb::GetCatalog() internally and wxDbInf class,
+but may be used in future releases for user functions. Contains information
+describing the table (Name, type, etc). A pointer to a wxDbColInf array
+instance is included so a program can create a wxDbColInf array instance
+(using \helpref{wxDb::GetColumns}{wxdbgetcolumns}) to maintain all information about the columns
+of a table in one memory structure.
projects / wxWidgets.git / blobdiff