--------------------------------------------- PTMDB MODULE - db_delete_row_where() FUNCTION --------------------------------------------- ------------ USAGE FORMAT ------------ Where $ret is a return value of 1 or 0 (zero): $ret = &db_delete_row_where($db_object, $table, $where); ----------- DESCRIPTION ----------- Removes a row from a given database table based on a WHERE statement comparison match. Use caution when using this function as all matched rows will be removed from your database table. Ensure that you use the most precise match comparisons possible. Returns 1 if successful. Returns 0 (zero) if not successful. --------- ARGUMENTS --------- $db_object REQUIRED A database handler object. This object stores connection information and is returned from a db_connect() function call. This object is of the same type as is returned by a DBI->connect function call. $table REQUIRED The name of the table from which you would like to remove row information. $where REQUIRED Any SQL "WHERE" statement to be used as part of the "DELETE" statement. e.g. "((`column1` = 'value1') AND (`column2` = 'value2'))" ------- RETURNS ------- 1 if row(s) was/were deleted successfully 0 (zero) if deletion was not successful or if no rows were matched. -------------- USAGE EXAMPLES -------------- ------------------------------------------------------------ Example 1: Remove Rows from 'MyTable' with a WHERE Statement ------------------------------------------------------------ -------- SEE ALSO -------- MODULES PTMDB FUNCTIONS PTMDB - db_connect() PTMDB - db_delete_row() PTMDB - db_delete_row_like()