mbed source development branch
Fork of mbed-dev by
DirHandle Class Reference
[Drivers]
Represents a directory stream. More...
#include <DirHandle.h>
Inherited by BaseDirHandle, and LocalDirHandle.
Public Member Functions | |
virtual int | closedir ()=0 |
Closes the directory. | |
virtual struct dirent * | readdir ()=0 |
Return the directory entry at the current position, and advances the position to the next entry. | |
virtual void | rewinddir ()=0 |
Resets the position to the beginning of the directory. | |
virtual off_t | telldir () |
Returns the current position of the DirHandle. | |
virtual void | seekdir (off_t location) |
Sets the position of the DirHandle. | |
Protected Member Functions | |
virtual void | lock () |
Acquire exclusive access to this object. | |
virtual void | unlock () |
Release exclusive access to this object. |
Detailed Description
Represents a directory stream.
Objects of this type are returned by a FileSystemLike's opendir method. Implementations must define at least closedir, readdir and rewinddir.
If a FileSystemLike class defines the opendir method, then the directories of an object of that type can be accessed by DIR *d = opendir("/example/directory") (or opendir("/example") to open the root of the filesystem), and then using readdir(d) etc.
The root directory is considered to contain all FileLike and FileSystemLike objects, so the DIR* returned by opendir("/") will reflect this.
Synchronization level: Set by subclass
Definition at line 52 of file DirHandle.h.
Member Function Documentation
virtual int closedir | ( | ) | [pure virtual] |
Closes the directory.
- Returns:
- 0 on success, -1 on error.
Generated on Tue Jul 12 2022 19:34:54 by 1.7.2