GSettings docs: clarify what is a good path
[glib.git] / glib / gdir.h
blob79b3038ddb944df5907a3a53bd57c30727d46de5
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 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, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
25 #error "Only <glib.h> can be included directly."
26 #endif
28 #ifndef __G_DIR_H__
29 #define __G_DIR_H__
31 #include <glib/gerror.h>
33 G_BEGIN_DECLS
35 typedef struct _GDir GDir;
37 #ifndef __GTK_DOC_IGNORE__
38 #ifdef G_OS_WIN32
39 /* For DLL ABI stability, keep old names for old (non-UTF-8) functionality. */
40 #define g_dir_open g_dir_open_utf8
41 #define g_dir_read_name g_dir_read_name_utf8
42 #endif
43 #endif
45 GDir * g_dir_open (const gchar *path,
46 guint flags,
47 GError **error);
48 const gchar * g_dir_read_name (GDir *dir);
49 void g_dir_rewind (GDir *dir);
50 void g_dir_close (GDir *dir);
52 G_END_DECLS
54 #endif /* __G_DIR_H__ */