---------------------------------------
PTMDB MODULE - db_disconnect() FUNCTION
---------------------------------------

  ------------
  USAGE FORMAT
  ------------

    Where $ret is returned 1 or 0, depending on success or failure:

    $ret = &db_disconnect($db_object);

  -----------
  DESCRIPTION
  -----------

    Disconnects from a database connection.

  ---------
  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.

  -------
  RETURNS
  -------

    1 if disconnection was successful
    0 (zero) if disconnection was not successful

  --------------
  USAGE EXAMPLES
  --------------

    --------------------------------------------------------------------------
    Example 1: Disconnecting from a MySQL Database, Where $mysql is the Object
    --------------------------------------------------------------------------

      <? $ret = &db_disconnect($mysql); ?>

  --------
  SEE ALSO
  --------

    TAGS

      DO

    MODULES

      PTMDB