The Sleuth Kit: TskFsName Class Reference

The Sleuth Kit 4.13.0

Public Member Functions | Friends | List of all members

TskFsName Class Reference

C++ File System Classes

Stores the file name information that is stored in a directory. More...

#include <tsk_fs.h>

Public Member Functions

TSK_FS_NAME_FLAG_ENUM getFlags () const

Return flags that describe allocation status etc. More...

TSK_INUM_T getMetaAddr () const

Return the address of the metadata structure that the name points to. More...

uint32_t getMetaSeq () const

Return the sequence number for metadata structure (NTFS only) More...

const char * getName () const

Return the name of the file (in UTF-8) More...

TSK_INUM_T getParentAddr () const

Return the metadata address of the parent directory (equal to meta_addr if this entry is for root directory). More...

const char * getShortName () const

Return the short name of the file or null (in UTF-8) More...

TSK_FS_NAME_TYPE_ENUM getType () const

Return the file type information (directory, file, etc.) More...

TskFsName (TSK_FS_NAME *a_fsName)

construct a TskFsName object More...

Friends

class TskFsInfo

Detailed Description

Stores the file name information that is stored in a directory.

Most file systems separate the file name from the metadata, but some do not (such as FAT). This structure contains the file name and the address of the metadata. See TSK_FS_NAME for more details.

Constructor & Destructor Documentation

TskFsName::TskFsName ( TSK_FS_NAME * a_fsName )

inline

construct a TskFsName object

Parameters: a_fsName a pointer of TSK_FS_NAME. If NULL, the getX() return values are undefined.

Member Function Documentation

TSK_FS_NAME_FLAG_ENUM TskFsName::getFlags ( ) const

inline

Return flags that describe allocation status etc.

Returns: flags that describe allocation status

References TSK_FS_NAME::flags.

TSK_INUM_T TskFsName::getMetaAddr ( ) const

inline

Return the address of the metadata structure that the name points to.

Returns: address of the metadata structure that the name points to

References TSK_FS_NAME::meta_addr.

uint32_t TskFsName::getMetaSeq ( ) const

inline

Return the sequence number for metadata structure (NTFS only)

Returns: sequence number for metadata structure

References TSK_FS_NAME::meta_seq.

const char* TskFsName::getName ( ) const

inline

Return the name of the file (in UTF-8)

Returns: the name of the file

References TSK_FS_NAME::name.

TSK_INUM_T TskFsName::getParentAddr ( ) const

inline

Return the metadata address of the parent directory (equal to meta_addr if this entry is for root directory).

Returns: metadata address of parent directory

References TSK_FS_NAME::par_addr.

const char* TskFsName::getShortName ( ) const

inline

Return the short name of the file or null (in UTF-8)

Returns: the short name of the file

References TSK_FS_NAME::shrt_name.

TSK_FS_NAME_TYPE_ENUM TskFsName::getType ( ) const

inline

Return the file type information (directory, file, etc.)

Returns: file type information

References TSK_FS_NAME::type.

The documentation for this class was generated from the following file:

tsk/fs/tsk_fs.h