glib/gdir.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * gdir.c: Simplified wrapper around the DIRENT functions.
   5  *
   6  * Copyright 2001 Hans Breuer
   7  *
   8  * SPDX-License-Identifier: LGPL-2.1-or-later
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24 #ifndef __G_DIR_H__
  25 #define __G_DIR_H__
  26
  27 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  28 #error "Only <glib.h> can be included directly."
  29 #endif
  30
  31 #include <glib/gerror.h>
  32
  33 #ifdef G_OS_UNIX
  34 #include <dirent.h>
  35 #endif
  36
  37 G_BEGIN_DECLS
  38
  39 typedef struct _GDir GDir;
  40
  41 GLIB_AVAILABLE_IN_ALL
  42 GDir    *                g_dir_open           (const gchar  *path,
  43                                                guint         flags,
  44                                                GError      **error);
  45 GLIB_AVAILABLE_IN_ALL
  46 const gchar *            g_dir_read_name      (GDir         *dir);
  47 GLIB_AVAILABLE_IN_ALL
  48 void                     g_dir_rewind         (GDir         *dir);
  49 GLIB_AVAILABLE_IN_ALL
  50 void                     g_dir_close          (GDir         *dir);
  51
  52 G_END_DECLS
  53
  54 #endif /* __G_DIR_H__ */