src/api/ok.c

   1 /* libquvi
   2  * Copyright (C) 2012  Toni Gundogdu <legatvs@gmail.com>
   3  *
   4  * This file is part of libquvi <http://quvi.sourceforge.net/>.
   5  *
   6  * This library is free software: you can redistribute it and/or
   7  * modify it under the terms of the GNU Affero General Public
   8  * License as published by the Free Software Foundation, either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General
  17  * Public License along with this library.  If not, see
  18  * <http://www.gnu.org/licenses/>.
  19  */
  20
  21 /** @file ok.c */
  22
  23 #include "config.h"
  24
  25 #include <glib.h>
  26
  27 #include "quvi.h"
  28 /* -- */
  29 #include "_quvi_s.h"
  30
  31 /** @brief Check if an error occurred
  32 @return QUVI_FALSE if an error occurred, otherwise QUVI_TRUE
  33 @sa @ref getting_started
  34 @ingroup convenience
  35 */
  36 QuviBoolean quvi_ok(quvi_t handle)
  37 {
  38   _quvi_t q = (_quvi_t) handle;
  39
  40   /* If G_DISABLE_CHECKS is defined then the check is not performed. */
  41   g_return_val_if_fail(handle != NULL, FALSE);
  42
  43   return (QuviBoolean) (q->status.rc == QUVI_OK);
  44 }
  45
  46 /* vim: set ts=2 sw=2 tw=72 expandtab: */