diff options
Diffstat (limited to 'doc/man/man3/tqsqldatabase.3qt')
-rw-r--r-- | doc/man/man3/tqsqldatabase.3qt | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/man/man3/tqsqldatabase.3qt b/doc/man/man3/tqsqldatabase.3qt index ec9d10c66..27f1d1da7 100644 --- a/doc/man/man3/tqsqldatabase.3qt +++ b/doc/man/man3/tqsqldatabase.3qt @@ -121,7 +121,7 @@ Inherits TQObject. .BI "TQSqlDatabase * \fBaddDatabase\fR ( TQSqlDriver * driver, const TQString & connectionName = defaultConnection )" .br .ti -1c -.BI "TQSqlDatabase * \fBdatabase\fR ( const TQString & connectionName = defaultConnection, bool open = TRUE )" +.BI "TQSqlDatabase * \fBdatabase\fR ( const TQString & connectionName = defaultConnection, bool open = true )" .br .ti -1c .BI "void \fBremoveDatabase\fR ( const TQString & connectionName )" @@ -278,15 +278,15 @@ Closes the database connection, freeing any resources acquired. .PP See also removeDatabase(). .SH "bool TQSqlDatabase::commit ()" -Commits a transaction to the database if the driver supports transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. +Commits a transaction to the database if the driver supports transactions. Returns true if the operation succeeded; otherwise returns false. .PP See also TQSqlDriver::hasFeature() and rollback(). .SH "TQString TQSqlDatabase::connectOptions () const" Returns the database connect options. See the "connectOptions" property for details. .SH "bool TQSqlDatabase::contains ( const TQString & connectionName = defaultConnection )\fC [static]\fR" -Returns TRUE if the list of database connections contains \fIconnectionName\fR; otherwise returns FALSE. -.SH "TQSqlDatabase * TQSqlDatabase::database ( const TQString & connectionName = defaultConnection, bool open = TRUE )\fC [static]\fR" -Returns the database connection called \fIconnectionName\fR. The database connection must have been previously added with addDatabase(). If \fIopen\fR is TRUE (the default) and the database connection is not already open it is opened now. If no \fIconnectionName\fR is specified the default connection is used. If \fIconnectionName\fR does not exist in the list of databases, 0 is returned. The pointer returned is owned by TQSqlDatabase and should \fInot\fR be deleted. +Returns true if the list of database connections contains \fIconnectionName\fR; otherwise returns false. +.SH "TQSqlDatabase * TQSqlDatabase::database ( const TQString & connectionName = defaultConnection, bool open = true )\fC [static]\fR" +Returns the database connection called \fIconnectionName\fR. The database connection must have been previously added with addDatabase(). If \fIopen\fR is true (the default) and the database connection is not already open it is opened now. If no \fIconnectionName\fR is specified the default connection is used. If \fIconnectionName\fR does not exist in the list of databases, 0 is returned. The pointer returned is owned by TQSqlDatabase and should \fInot\fR be deleted. .PP \fBWarning:\fR There are restrictions on the use of database connections in threaded applications. Please see the Thread Support in TQt document for more information about threading and SQL databases. .PP @@ -325,20 +325,20 @@ See also TQSqlQuery and lastError(). .SH "TQString TQSqlDatabase::hostName () const" Returns the host name where the database resides. See the "hostName" property for details. .SH "bool TQSqlDatabase::isDriverAvailable ( const TQString & name )\fC [static]\fR" -Returns TRUE if a driver called \fIname\fR is available; otherwise returns FALSE. +Returns true if a driver called \fIname\fR is available; otherwise returns false. .PP See also drivers(). .SH "bool TQSqlDatabase::isOpen () const" -Returns TRUE if the database connection is currently open; otherwise returns FALSE. +Returns true if the database connection is currently open; otherwise returns false. .SH "bool TQSqlDatabase::isOpenError () const" -Returns TRUE if there was an error opening the database connection; otherwise returns FALSE. Error information can be retrieved using the lastError() function. +Returns true if there was an error opening the database connection; otherwise returns false. Error information can be retrieved using the lastError() function. .SH "TQSqlError TQSqlDatabase::lastError () const" Returns information about the last error that occurred on the database. See TQSqlError for more information. .PP Examples: .)l sql/overview/connection.cpp and sql/sqltable/main.cpp. .SH "bool TQSqlDatabase::open ()" -Opens the database connection using the current connection values. Returns TRUE on success; otherwise returns FALSE. Error information can be retrieved using the lastError() function. +Opens the database connection using the current connection values. Returns true on success; otherwise returns false. Error information can be retrieved using the lastError() function. .PP See also lastError(). .PP @@ -347,7 +347,7 @@ Examples: .SH "bool TQSqlDatabase::open ( const TQString & user, const TQString & password )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Opens the database connection using the given \fIuser\fR name and \fIpassword\fR. Returns TRUE on success; otherwise returns FALSE. Error information can be retrieved using the lastError() function. +Opens the database connection using the given \fIuser\fR name and \fIpassword\fR. Returns true on success; otherwise returns false. Error information can be retrieved using the lastError() function. .PP This function does not store the password it is given. Instead, the password is passed directly to the driver for opening a connection and is then discarded. .PP @@ -405,7 +405,7 @@ Removes the database connection \fIdb\fR from the list of database connections. .PP \fBWarning:\fR The \fIdb\fR pointer is not valid after this function has been called. There should be no open queries on the database connection when this function is called, otherwise a resource leak will occur. .SH "bool TQSqlDatabase::rollback ()" -Rolls a transaction back on the database if the driver supports transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. +Rolls a transaction back on the database if the driver supports transactions. Returns true if the operation succeeded; otherwise returns false. .PP See also TQSqlDriver::hasFeature(), commit(), and transaction(). .SH "void TQSqlDatabase::setConnectOptions ( const TQString & options = TQString::null )" @@ -465,7 +465,7 @@ Note that if you want to iterate over the list, you should iterate over a copy, .br .fi .SH "bool TQSqlDatabase::transaction ()" -Begins a transaction on the database if the driver supports transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. +Begins a transaction on the database if the driver supports transactions. Returns true if the operation succeeded; otherwise returns false. .PP See also TQSqlDriver::hasFeature(), commit(), and rollback(). .SH "TQString TQSqlDatabase::userName () const" |