source: trunk/libs/mini-libc/dirent.h @ 449

Last change on this file since 449 was 449, checked in by alain, 4 years ago

Introduce several missing user libs.

File size: 3.1 KB
Line 
1/*
2 * dirent.h - User level <dirent> library definition.
3 *
4 * Author     Alain Greiner (2016,2017,2018)
5 *
6 * Copyright (c) UPMC Sorbonne Universites
7 *
8 * This file is part of ALMOS-MKH.
9 *
10 * ALMOS-MKH is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2.0 of the License.
13 *
14 * ALMOS-MKH is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#ifndef _DIRENT_H_
25#define _DIRENT_H_
26
27/*****************************************************************************************
28 * This file defines the user level, directory entry related library.
29 * All these functions make a system call to access the kernel VFS.
30 * The user/kernel shared structures and mnemonics are defined in
31 * the <syscalls/shared_include/shared_dirent.h> file.
32 ****************************************************************************************/
33
34#include <shared_dirent.h>
35
36/*****************************************************************************************
37 * This function opens the directory identified by the <pathname> argument,
38 * associates a directory stream with it and returns an user space pointer to identify
39 * this directory stream in subsequent readdir() or closedir() operations. 
40 *****************************************************************************************
41 * @ pathname   : pathname (can be relative or absolute).
42 * @ returns DIR* pointer if success / returns NULL if pathname cannot be accessed.
43 ****************************************************************************************/
44DIR * opendir( const char * pathname );
45
46/*****************************************************************************************
47 * This function returns a pointer to the next directory entry.
48 *****************************************************************************************
49 * @ dirp     : DIR pointer identifying the directory.
50 * @ returns dirent* pointer / returns NULL upon reaching end of directory or on error.
51 ****************************************************************************************/
52struct dirent * readdir( DIR * dirp );
53
54/*****************************************************************************************
55 * This function closes the directory identified by the <dirp> argument, and releases
56 * all structures associated with the <dirp> pointer.
57 *****************************************************************************************
58 * @ dirp     : DIR pointer identifying the directory.
59 * @ returns 0 if success / returns -1 if failure.
60 ****************************************************************************************/
61int closedir( DIR * dirp );
62
63#endif
Note: See TracBrowser for help on using the repository browser.