Initial commit
[platform/upstream/glib2.0.git] / 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  * 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 of the License, or (at your option) any later version.
12  *
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.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
25 #error "Only <glib.h> can be included directly."
26 #endif
27
28 #ifndef __G_DIR_H__
29 #define __G_DIR_H__
30
31 #include <glib/gerror.h>
32
33 G_BEGIN_DECLS
34
35 typedef struct _GDir GDir;
36
37 #ifdef G_OS_WIN32
38 /* For DLL ABI stability, keep old names for old (non-UTF-8) functionality. */
39 #define g_dir_open g_dir_open_utf8
40 #define g_dir_read_name g_dir_read_name_utf8
41 #endif
42
43 GDir    *                g_dir_open           (const gchar  *path,
44                                                guint         flags,
45                                                GError      **error);
46 G_CONST_RETURN gchar    *g_dir_read_name      (GDir         *dir);
47 void                     g_dir_rewind         (GDir         *dir);
48 void                     g_dir_close          (GDir         *dir);
49
50 G_END_DECLS
51
52 #endif /* __G_DIR_H__ */