SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Provides file statistical information in a portable manner. More...
#include <rw/stat.h>
Public Types | |
typedef struct _stat | stat_type |
typedef short | nlink_type |
typedef unsigned short | mode_type |
typedef struct stat | stat_type |
typedef nlink_t | nlink_type |
typedef mode_t | mode_type |
typedef dev_t | device_type |
typedef ino_t | inode_type |
typedef off_t | offset_type |
Public Member Functions | |
RWFileStat (const char *s, bool follow_links=true) | |
inode_type | inode () const |
nlink_type | nlink () const |
offset_type | size () const |
device_type | dev () const |
time_t | atime () const |
time_t | mtime () const |
time_t | ctime () const |
bool | isSymlink () const |
bool | isFile () const |
bool | isBlock () const |
bool | isDirectory () const |
bool | isCharacter () const |
bool | isFifo () const |
mode_type | mode () const |
const stat_type * | stat () const |
The class RWFileStat provides file statistical information in a portable manner. RWFileStat is:
#include <rw/stat.h> RWFileStat st;
None
typedef dev_t RWFileStat::device_type |
Type for the device
number (integer).
typedef ino_t RWFileStat::inode_type |
Type for the inode
number (integer).
typedef mode_t RWFileStat::mode_type |
Type for the mode.
typedef unsigned short RWFileStat::mode_type |
Type for the mode.
typedef nlink_t RWFileStat::nlink_type |
Type for the number of hard links.
typedef short RWFileStat::nlink_type |
Type for the number of hard links.
typedef off_t RWFileStat::offset_type |
Type for the offset (integer).
typedef struct stat RWFileStat::stat_type |
Type of the underlying data structure.
typedef struct _stat RWFileStat::stat_type |
Type of the underlying data structure.
RWFileStat::RWFileStat | ( | const char * | s, | |
bool | follow_links = true | |||
) | [explicit] |
Constructs the object by using a stat function on the filename given in s. The call succeeds or throws an exception of type (or derived of) RWInternalErr
. The error can be inspected by looking at errno
. If the filename indicates a symbolic link, it uses a stat function on the target of the symbolic link rather than the symbolic link itself when the parameter follow_links is true
(default). Otherwise, it uses a stat function on the symbolic link.
time_t RWFileStat::atime | ( | ) | const |
Returns the time of the last access.
time_t RWFileStat::ctime | ( | ) | const |
Returns the time of the last status change.
device_type RWFileStat::dev | ( | ) | const |
Returns the device
number for the file.
inode_type RWFileStat::inode | ( | ) | const |
Returns the inode
number for the file.
bool RWFileStat::isBlock | ( | ) | const |
Returns true
if the file is a block device.
bool RWFileStat::isCharacter | ( | ) | const |
Returns true
if the file is a character device.
bool RWFileStat::isDirectory | ( | ) | const |
Returns true
if the file is a directory.
bool RWFileStat::isFifo | ( | ) | const |
Returns true
if the file is a FIFO
named pipe.
bool RWFileStat::isFile | ( | ) | const |
Returns true
if the file is a regular file.
bool RWFileStat::isSymlink | ( | ) | const |
Returns true
if the file is a symlink
. This member function always returns false
for objects of type RWFileStat.
mode_type RWFileStat::mode | ( | ) | const |
Returns an integer which is a bit mask value indicating the type of the file and the permissions for it.
time_t RWFileStat::mtime | ( | ) | const |
Returns the time of the last modification.
nlink_type RWFileStat::nlink | ( | ) | const |
Returns the number or hard links for the file.
offset_type RWFileStat::size | ( | ) | const |
Returns the size
of the file.
const stat_type* RWFileStat::stat | ( | ) | const |
Returns a pointer to the underlying type. The type is a struct stat
but it may change in the future. Using the returned type directly is not supported.
© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.