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