dirent.h File Reference

#include <sys/types.h>
#include <inttypes.h>

Go to the source code of this file.

Classes
struct	dirent
	Directory entry structure. More...

Typedefs
typedef uintptr_t	DIR
	DIR typedef.

Functions
int	closedir (DIR *dirp)
	Close a directory.
DIR *	opendir (const char *name)
	Open a directory.
struct dirent *	readdir (DIR *dirp)
	Read the next entry in a directory.

Detailed Description

Copyright

Copyright (c) 2018, Stuart W Baker All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This file implements the missing dirent.h functionality.

Author

Stuart W. Baker

Date

21 January 2018

Definition in file dirent.h.

Typedef Documentation

DIR

typedef uintptr_t DIR

DIR typedef.

Definition at line 45 of file dirent.h.

Function Documentation

closedir()

int closedir

(

DIR *

dirp

)

Close a directory.

Parameters

dirp directory pointer to close

Returns

0 upon success, -1 upon failure with errno containing the cause

Definition at line 343 of file FileSystem.cxx.

opendir()

DIR * opendir

(

const char *

name

)

Open a directory.

Parameters

name	directory path

Returns

pointer to the open directory on success, NULL on error

Definition at line 351 of file FileSystem.cxx.

readdir()

struct dirent * readdir

(

DIR *

dirp

)

Read the next entry in a directory.

Parameters

dirp	directory pointer to read.

Returns

pointer to a struct dirent representing the next directory entry

Definition at line 359 of file FileSystem.cxx.