Changeset 4589 for trunk/psLib/src/db/psDB.h
- Timestamp:
- Jul 20, 2005, 3:40:10 PM (21 years ago)
- File:
-
- 1 edited
-
trunk/psLib/src/db/psDB.h (modified) (18 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/psLib/src/db/psDB.h
r4540 r4589 10 10 * @author Joshua Hoblitt 11 11 * 12 * @version $Revision: 1.1 1$ $Name: not supported by cvs2svn $13 * @date $Date: 2005-07- 12 19:12:00 $12 * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ 13 * @date $Date: 2005-07-21 01:40:10 $ 14 14 * 15 15 * Copyright 2005 Joshua Hoblitt, University of Hawaii … … 40 40 /** Opens a new database connection 41 41 * 42 * @return A new psDB object if the database connection is successful or NULL on42 * @return psDB*: A new psDB object if the database connection is successful or NULL on 43 43 * failure. 44 44 */ … … 50 50 ); 51 51 52 /** Closes a database connection 53 */ 52 /** Closes a database connection */ 54 53 void psDBCleanup( 55 54 psDB *dbh ///< Database handle … … 58 57 /** Creates a new database namespace 59 58 * 60 * @return true on success59 * @return bool: true on success 61 60 */ 62 61 bool psDBCreate( … … 67 66 /** Changes the current database namespace 68 67 * 69 * @return true on success68 * @return bool: true on success 70 69 */ 71 70 bool psDBChange( … … 76 75 /** Drops a database namespace 77 76 * 78 * @return true on success77 * @return bool: true on success 79 78 */ 80 79 bool psDBDrop( … … 89 88 * dialect is provided. Caveat emptor. 90 89 * 91 * @return true on success90 * @return bool: true on success 92 91 */ 93 92 bool p_psDBRunQuery( … … 114 113 * Key" or "Key". Comments are otherwise ignored. 115 114 * 116 * @return true on success115 * @return bool: true on success 117 116 */ 118 117 bool psDBCreateTable( … … 124 123 /** Deletes a database table 125 124 * 126 * @return true on success125 * @return bool: true on success 127 126 */ 128 127 bool psDBDropTable( … … 137 136 * entire range is returned. 138 137 * 139 * @return A psArray of strings or NULL on failure138 * @return psArray*: A psArray of strings or NULL on failure 140 139 */ 141 140 psArray *psDBSelectColumn( … … 152 151 * entire range is returned. The data in the column is cast to to "pType". 153 152 * 154 * @return A psVector or NULL on failure153 * @return psVector*: A psVector or NULL on failure 155 154 */ 156 155 psVector *psDBSelectColumnNum( … … 174 173 * string, e.g. "", to match NULL field values. 175 174 * 176 * @return A psArray of psMetadata or NULL on failure175 * @return psArray*: A psArray of psMetadata or NULL on failure 177 176 */ 178 177 psArray *psDBSelectRows( … … 192 191 * specified in "row" that do not exist in "tableName", the insert will fail. 193 192 * 194 * @return true on success193 * @return bool: true on success 195 194 */ 196 195 bool psDBInsertOneRow( … … 207 206 * those used in psDBInsertOneRow(). 208 207 * 209 * @return true on success208 * @return bool: true on success 210 209 */ 211 210 bool psDBInsertRows( … … 220 219 * the same psMetadata format as used in psDBInsertOneRow() & psDBInsertRows(). 221 220 * 222 * @return A psArray of psMetadata or NULL on failure221 * @return psArray*: A psArray of psMetadata or NULL on failure 223 222 */ 224 223 psArray *psDBDumpRows( … … 233 232 * psMetadata structure where psMetadataItem.name contains the column's name. 234 233 * 235 * @return A psMetadata containing either a psArrays or psVector per column234 * @return psMetadata*: A psMetadata containing either a psArrays or psVector per column 236 235 */ 237 236 psMetadata *psDBDumpCols( … … 249 248 * used in psDBInsertOneRow(), etc. 250 249 * 251 * @return The number of rows modified or a negative value on error252 */ 253 psS64psDBUpdateRows(250 * @return long: The number of rows modified or a negative value on error 251 */ 252 long psDBUpdateRows( 254 253 psDB *dbh, ///< Database handle 255 254 const char *tableName, ///< Table name … … 266 265 * the number of rows that were dropped, only 1 will be returned on success. 267 266 * 268 * @return The number of rows removed or a negative value on error269 */ 270 psS64psDBDeleteRows(267 * @return long: The number of rows removed or a negative value on error 268 */ 269 long psDBDeleteRows( 271 270 psDB *dbh, ///< Database handle 272 271 const char *tableName, ///< Table name
Note:
See TracChangeset
for help on using the changeset viewer.
