glib-2.0/glib/gdir.h

0001 /* GLIB - Library of useful routines for C programming
0002  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
0003  *
0004  * gdir.c: Simplified wrapper around the DIRENT functions.
0005  *
0006  * Copyright 2001 Hans Breuer
0007  *
0008  * SPDX-License-Identifier: LGPL-2.1-or-later
0009  *
0010  * This library is free software; you can redistribute it and/or
0011  * modify it under the terms of the GNU Lesser General Public
0012  * License as published by the Free Software Foundation; either
0013  * version 2.1 of the License, or (at your option) any later version.
0014  *
0015  * This library is distributed in the hope that it will be useful,
0016  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0018  * Lesser General Public License for more details.
0019  *
0020  * You should have received a copy of the GNU Lesser General Public
0021  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
0022  */
0023
0024 #ifndef __G_DIR_H__
0025 #define __G_DIR_H__
0026
0027 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
0028 #error "Only <glib.h> can be included directly."
0029 #endif
0030
0031 #include <glib/gerror.h>
0032
0033 #ifdef G_OS_UNIX
0034 #include <dirent.h>
0035 #endif
0036
0037 G_BEGIN_DECLS
0038
0039 typedef struct _GDir GDir;
0040
0041 GLIB_AVAILABLE_IN_ALL
0042 GDir    *                g_dir_open           (const gchar  *path,
0043                            guint         flags,
0044                            GError      **error);
0045 GLIB_AVAILABLE_IN_ALL
0046 const gchar *            g_dir_read_name      (GDir         *dir);
0047 GLIB_AVAILABLE_IN_ALL
0048 void                     g_dir_rewind         (GDir         *dir);
0049 GLIB_AVAILABLE_IN_ALL
0050 void                     g_dir_close          (GDir         *dir);
0051
0052 GLIB_AVAILABLE_IN_2_80
0053 GDir *                   g_dir_ref             (GDir        *dir);
0054 GLIB_AVAILABLE_IN_2_80
0055 void                     g_dir_unref           (GDir        *dir);
0056
0057 G_END_DECLS
0058
0059 #endif /* __G_DIR_H__ */