src/api/ok.c

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