diff options
Diffstat (limited to 'doc/html/tqsqlquery.html')
| -rw-r--r-- | doc/html/tqsqlquery.html | 102 |
1 files changed, 51 insertions, 51 deletions
diff --git a/doc/html/tqsqlquery.html b/doc/html/tqsqlquery.html index ca4e3314f..fee5aa3b7 100644 --- a/doc/html/tqsqlquery.html +++ b/doc/html/tqsqlquery.html @@ -59,7 +59,7 @@ manipulating SQL statements. <li class=fn>void <a href="#setForwardOnly"><b>setForwardOnly</b></a> ( bool forward )</li> <li class=fn>virtual bool <a href="#exec"><b>exec</b></a> ( const TQString & query )</li> <li class=fn>virtual TQVariant <a href="#value"><b>value</b></a> ( int i ) const</li> -<li class=fn>virtual bool <a href="#seek"><b>seek</b></a> ( int i, bool relative = FALSE )</li> +<li class=fn>virtual bool <a href="#seek"><b>seek</b></a> ( int i, bool relative = false )</li> <li class=fn>virtual bool <a href="#next"><b>next</b></a> ()</li> <li class=fn>virtual bool <a href="#prev"><b>prev</b></a> ()</li> <li class=fn>virtual bool <a href="#first"><b>first</b></a> ()</li> @@ -98,11 +98,11 @@ statements, e.g. <tt>CREATE TABLE</tt>. It can also be used to execute database-specific commands which are not standard SQL (e.g. <tt>SET DATESTYLE=ISO</tt> for PostgreSQL). <p> Successfully executed SQL statements set the query's state to -active (<a href="#isActive">isActive</a>() returns TRUE); otherwise the query's state is +active (<a href="#isActive">isActive</a>() returns true); otherwise the query's state is set to inactive. In either case, when executing a new SQL statement, the query is positioned on an invalid record; an active query must be navigated to a valid record (so that <a href="#isValid">isValid</a>() -returns TRUE) before values can be retrieved. +returns true) before values can be retrieved. <p> Navigating records is performed with the following functions: <p> <ul> <li> <a href="#next">next</a>() @@ -343,9 +343,9 @@ Returns the database driver associated with the query. <h3 class=fn>bool <a name="exec"></a>TQSqlQuery::exec ( const <a href="tqstring.html">TQString</a> & query )<tt> [virtual]</tt> </h3> -Executes the SQL in <em>query</em>. Returns TRUE and sets the query +Executes the SQL in <em>query</em>. Returns true and sets the query state to active if the query was successful; otherwise returns -FALSE and sets the query state to inactive. The <em>query</em> string +false and sets the query state to inactive. The <em>query</em> string must use syntax appropriate for the SQL database being queried, for example, standard SQL. <p> After the query is executed, the query is positioned on an <em>invalid</em> record, and must be navigated to a valid record before @@ -358,8 +358,8 @@ called. <h3 class=fn>bool <a name="exec-2"></a>TQSqlQuery::exec () </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -<p> Executes a previously prepared SQL query. Returns TRUE if the -query executed successfully; otherwise returns FALSE. +<p> Executes a previously prepared SQL query. Returns true if the +query executed successfully; otherwise returns false. <p> <p>See also <a href="#prepare">prepare</a>(), <a href="#bindValue">bindValue</a>(), and <a href="#addBindValue">addBindValue</a>(). <h3 class=fn><a href="tqstring.html">TQString</a> <a name="executedQuery"></a>TQSqlQuery::executedQuery () const @@ -377,51 +377,51 @@ query. Useful for debugging purposes. </h3> Retrieves the first record in the result, if available, and positions the query on the retrieved record. Note that the result -must be in an active state and <a href="#isSelect">isSelect</a>() must return TRUE before -calling this function or it will do nothing and return FALSE. -Returns TRUE if successful. If unsuccessful the query position is -set to an invalid position and FALSE is returned. +must be in an active state and <a href="#isSelect">isSelect</a>() must return true before +calling this function or it will do nothing and return false. +Returns true if successful. If unsuccessful the query position is +set to an invalid position and false is returned. <p> <p>See also <a href="#next">next</a>(), <a href="#prev">prev</a>(), <a href="#last">last</a>(), <a href="#seek">seek</a>(), <a href="#at">at</a>(), <a href="#isActive">isActive</a>(), and <a href="#isValid">isValid</a>(). <p>Example: <a href="sql.html#x2170">sql/overview/navigating/main.cpp</a>. <h3 class=fn>bool <a name="isActive"></a>TQSqlQuery::isActive () const </h3> -Returns TRUE if the query is currently active; otherwise returns -FALSE. +Returns true if the query is currently active; otherwise returns +false. <p>Examples: <a href="sql.html#x2158">sql/overview/basicbrowsing/main.cpp</a>, <a href="sql.html#x2162">sql/overview/basicbrowsing2/main.cpp</a>, <a href="sql.html#x2167">sql/overview/basicdatamanip/main.cpp</a>, <a href="sql.html#x2171">sql/overview/navigating/main.cpp</a>, and <a href="sql.html#x2175">sql/overview/retrieve1/main.cpp</a>. <h3 class=fn>bool <a name="isForwardOnly"></a>TQSqlQuery::isForwardOnly () const </h3> -Returns TRUE if you can only scroll <em>forward</em> through a result -set; otherwise returns FALSE. +Returns true if you can only scroll <em>forward</em> through a result +set; otherwise returns false. <p> <p>See also <a href="#setForwardOnly">setForwardOnly</a>(). <h3 class=fn>bool <a name="isNull"></a>TQSqlQuery::isNull ( int field ) const </h3> -Returns TRUE if the query is active and positioned on a valid -record and the <em>field</em> is NULL; otherwise returns FALSE. Note +Returns true if the query is active and positioned on a valid +record and the <em>field</em> is NULL; otherwise returns false. Note that for some drivers <a href="#isNull">isNull</a>() will not return accurate information until after an attempt is made to retrieve data. <p> <p>See also <a href="#isActive">isActive</a>(), <a href="#isValid">isValid</a>(), and <a href="#value">value</a>(). <h3 class=fn>bool <a name="isSelect"></a>TQSqlQuery::isSelect () const </h3> -Returns TRUE if the current query is a <tt>SELECT</tt> statement; -otherwise returns FALSE. +Returns true if the current query is a <tt>SELECT</tt> statement; +otherwise returns false. <h3 class=fn>bool <a name="isValid"></a>TQSqlQuery::isValid () const </h3> -Returns TRUE if the query is currently positioned on a valid -record; otherwise returns FALSE. +Returns true if the query is currently positioned on a valid +record; otherwise returns false. <h3 class=fn>bool <a name="last"></a>TQSqlQuery::last ()<tt> [virtual]</tt> </h3> Retrieves the last record in the result, if available, and positions the query on the retrieved record. Note that the result -must be in an active state and <a href="#isSelect">isSelect</a>() must return TRUE before -calling this function or it will do nothing and return FALSE. -Returns TRUE if successful. If unsuccessful the query position is -set to an invalid position and FALSE is returned. +must be in an active state and <a href="#isSelect">isSelect</a>() must return true before +calling this function or it will do nothing and return false. +Returns true if successful. If unsuccessful the query position is +set to an invalid position and false is returned. <p> <p>See also <a href="#next">next</a>(), <a href="#prev">prev</a>(), <a href="#first">first</a>(), <a href="#seek">seek</a>(), <a href="#at">at</a>(), <a href="#isActive">isActive</a>(), and <a href="#isValid">isValid</a>(). <p>Example: <a href="sql.html#x2172">sql/overview/navigating/main.cpp</a>. @@ -441,21 +441,21 @@ if there is no current query text. </h3> Retrieves the next record in the result, if available, and positions the query on the retrieved record. Note that the result -must be in an active state and <a href="#isSelect">isSelect</a>() must return TRUE before -calling this function or it will do nothing and return FALSE. +must be in an active state and <a href="#isSelect">isSelect</a>() must return true before +calling this function or it will do nothing and return false. <p> The following rules apply: <p> <ul> <li> If the result is currently located before the first record, e.g. immediately after a query is executed, an attempt is made to retrieve the first record. <p> <li> If the result is currently located after the last record, -there is no change and FALSE is returned. +there is no change and false is returned. <p> <li> If the result is located somewhere in the middle, an attempt is made to retrieve the next record. </ul> <p> If the record could not be retrieved, the result is positioned after -the last record and FALSE is returned. If the record is successfully -retrieved, TRUE is returned. +the last record and false is returned. If the record is successfully +retrieved, true is returned. <p> <p>See also <a href="#prev">prev</a>(), <a href="#first">first</a>(), <a href="#last">last</a>(), <a href="#seek">seek</a>(), <a href="#at">at</a>(), <a href="#isActive">isActive</a>(), and <a href="#isValid">isValid</a>(). <p>Examples: <a href="sql.html#x2159">sql/overview/basicbrowsing/main.cpp</a>, <a href="sql.html#x2163">sql/overview/basicbrowsing2/main.cpp</a>, <a href="sql.html#x2208">sql/overview/delete/main.cpp</a>, <a href="sql.html#x2183">sql/overview/order1/main.cpp</a>, <a href="sql.html#x2176">sql/overview/retrieve1/main.cpp</a>, <a href="sql.html#x2265">sql/overview/subclass4/main.cpp</a>, and <a href="sql.html#x2268">sql/overview/subclass5/main.cpp</a>. @@ -464,7 +464,7 @@ retrieved, TRUE is returned. Returns the number of rows affected by the result's SQL statement, or -1 if it cannot be determined. Note that for <tt>SELECT</tt> statements, the value is undefined; see <a href="#size">size</a>() instead. If the -query is not active (<a href="#isActive">isActive</a>() returns FALSE), -1 is returned. +query is not active (<a href="#isActive">isActive</a>() returns false), -1 is returned. <p> <p>See also <a href="#size">size</a>() and <a href="tqsqldriver.html#hasFeature">TQSqlDriver::hasFeature</a>(). <p>Examples: <a href="sql.html#x2164">sql/overview/basicbrowsing2/main.cpp</a> and <a href="sql.html#x2168">sql/overview/basicdatamanip/main.cpp</a>. @@ -485,66 +485,66 @@ query. See the <a href="#details">Description</a> for examples. </h3> Retrieves the previous record in the result, if available, and positions the query on the retrieved record. Note that the result -must be in an active state and <a href="#isSelect">isSelect</a>() must return TRUE before -calling this function or it will do nothing and return FALSE. +must be in an active state and <a href="#isSelect">isSelect</a>() must return true before +calling this function or it will do nothing and return false. <p> The following rules apply: <p> <ul> <li> If the result is currently located before the first record, -there is no change and FALSE is returned. +there is no change and false is returned. <p> <li> If the result is currently located after the last record, an attempt is made to retrieve the last record. <p> <li> If the result is somewhere in the middle, an attempt is made to retrieve the previous record. </ul> <p> If the record could not be retrieved, the result is positioned -before the first record and FALSE is returned. If the record is -successfully retrieved, TRUE is returned. +before the first record and false is returned. If the record is +successfully retrieved, true is returned. <p> <p>See also <a href="#next">next</a>(), <a href="#first">first</a>(), <a href="#last">last</a>(), <a href="#seek">seek</a>(), <a href="#at">at</a>(), <a href="#isActive">isActive</a>(), and <a href="#isValid">isValid</a>(). <h3 class=fn>const <a href="tqsqlresult.html">TQSqlResult</a> * <a name="result"></a>TQSqlQuery::result () const </h3> Returns the result associated with the query. -<h3 class=fn>bool <a name="seek"></a>TQSqlQuery::seek ( int i, bool relative = FALSE )<tt> [virtual]</tt> +<h3 class=fn>bool <a name="seek"></a>TQSqlQuery::seek ( int i, bool relative = false )<tt> [virtual]</tt> </h3> Retrieves the record at position (offset) <em>i</em>, if available, and positions the query on the retrieved record. The first record is at position 0. Note that the query must be in an active state and -<a href="#isSelect">isSelect</a>() must return TRUE before calling this function. -<p> If <em>relative</em> is FALSE (the default), the following rules apply: +<a href="#isSelect">isSelect</a>() must return true before calling this function. +<p> If <em>relative</em> is false (the default), the following rules apply: <p> <ul> <li> If <em>i</em> is negative, the result is positioned before the -first record and FALSE is returned. +first record and false is returned. <li> Otherwise, an attempt is made to move to the record at position <em>i</em>. If the record at position <em>i</em> could not be retrieved, the -result is positioned after the last record and FALSE is returned. If -the record is successfully retrieved, TRUE is returned. +result is positioned after the last record and false is returned. If +the record is successfully retrieved, true is returned. </ul> -<p> If <em>relative</em> is TRUE, the following rules apply: +<p> If <em>relative</em> is true, the following rules apply: <p> <ul> <li> If the result is currently positioned before the first record or on the first record, and <em>i</em> is negative, there is no -change, and FALSE is returned. +change, and false is returned. <li> If the result is currently located after the last record, and -<em>i</em> is positive, there is no change, and FALSE is returned. +<em>i</em> is positive, there is no change, and false is returned. <li> If the result is currently located somewhere in the middle, and the relative offset <em>i</em> moves the result below zero, the -result is positioned before the first record and FALSE is +result is positioned before the first record and false is returned. <li> Otherwise, an attempt is made to move to the record <em>i</em> records ahead of the current record (or <em>i</em> records behind the current record if <em>i</em> is negative). If the record at offset <em>i</em> could not be retrieved, the result is positioned after the last record if <em>i</em> >= 0, (or before the first record if <em>i</em> is -negative), and FALSE is returned. If the record is successfully -retrieved, TRUE is returned. +negative), and false is returned. If the record is successfully +retrieved, true is returned. </ul> <p> <p>See also <a href="#next">next</a>(), <a href="#prev">prev</a>(), <a href="#first">first</a>(), <a href="#last">last</a>(), <a href="#at">at</a>(), <a href="#isActive">isActive</a>(), and <a href="#isValid">isValid</a>(). <p>Example: <a href="sql.html#x2173">sql/overview/navigating/main.cpp</a>. <h3 class=fn>void <a name="setForwardOnly"></a>TQSqlQuery::setForwardOnly ( bool forward ) </h3> -Sets forward only mode to <em>forward</em>. If forward is TRUE only +Sets forward only mode to <em>forward</em>. If forward is true only <a href="#next">next</a>(), and <a href="#seek">seek</a>() with positive values, are allowed for navigating the results. Forward only mode needs far less memory since results do not need to be cached. @@ -559,8 +559,8 @@ as forward. Returns the size of the result, (number of rows returned), or -1 if the size cannot be determined or if the database does not support reporting information about query sizes. Note that for -non-<tt>SELECT</tt> statements (<a href="#isSelect">isSelect</a>() returns FALSE), <a href="#size">size</a>() will -return -1. If the query is not active (<a href="#isActive">isActive</a>() returns FALSE), +non-<tt>SELECT</tt> statements (<a href="#isSelect">isSelect</a>() returns false), <a href="#size">size</a>() will +return -1. If the query is not active (<a href="#isActive">isActive</a>() returns false), -1 is returned. <p> To determine the number of rows affected by a non-SELECT statement, use <a href="#numRowsAffected">numRowsAffected</a>(). |