Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages

File information status
Used on kodi::vfs::StatFile() to get detailed information about a file. More...

Classes

class  kodi::vfs::FileStatus
 

Functions

void kodi::vfs::FileStatus::SetDeviceId (uint32_t deviceId)
 Set ID of device containing file.
 
uint32_t kodi::vfs::FileStatus::GetDeviceId () const
 Get ID of device containing file.
 
void kodi::vfs::FileStatus::SetFileSerialNumber (uint64_t fileSerialNumber)
 Set the file serial number, which distinguishes this file from all other files on the same device.
 
uint64_t kodi::vfs::FileStatus::GetFileSerialNumber () const
 Get the file serial number, which distinguishes this file from all other files on the same device.
 
void kodi::vfs::FileStatus::SetSize (uint64_t size)
 Set total size, in bytes.
 
uint64_t kodi::vfs::FileStatus::GetSize () const
 Get total size, in bytes.
 
void kodi::vfs::FileStatus::SetAccessTime (time_t accessTime)
 Set time of last access.
 
time_t kodi::vfs::FileStatus::GetAccessTime () const
 Get time of last access.
 
void kodi::vfs::FileStatus::SetModificationTime (time_t modificationTime)
 Set time of last modification.
 
time_t kodi::vfs::FileStatus::GetModificationTime () const
 Get time of last modification.
 
void kodi::vfs::FileStatus::SetStatusTime (time_t statusTime)
 Set time of last status change.
 
time_t kodi::vfs::FileStatus::GetStatusTime () const
 Get time of last status change.
 
void kodi::vfs::FileStatus::SetIsDirectory (bool isDirectory)
 Set the stat url is a directory.
 
bool kodi::vfs::FileStatus::GetIsDirectory () const
 The stat url is a directory if returns true.
 
void kodi::vfs::FileStatus::SetIsSymLink (bool isSymLink)
 Set stat url as a symbolic link.
 
bool kodi::vfs::FileStatus::GetIsSymLink () const
 Get stat url is a symbolic link.
 
void kodi::vfs::FileStatus::SetIsBlock (bool isBlock)
 Set stat url as a block special.
 
bool kodi::vfs::FileStatus::GetIsBlock () const
 Get stat url is a block special.
 
void kodi::vfs::FileStatus::SetIsCharacter (bool isCharacter)
 Set stat url as a character special.
 
bool kodi::vfs::FileStatus::GetIsCharacter () const
 Get stat url is a character special.
 
void kodi::vfs::FileStatus::SetIsFifo (bool isFifo)
 Set stat url as a FIFO special.
 
bool kodi::vfs::FileStatus::GetIsFifo () const
 Get stat url is a FIFO special.
 
void kodi::vfs::FileStatus::SetIsRegular (bool isRegular)
 Set stat url as a regular.
 
bool kodi::vfs::FileStatus::GetIsRegular () const
 Get stat url is a regular.
 
void kodi::vfs::FileStatus::SetIsSocket (bool isSocket)
 Set stat url is a socket.
 
bool kodi::vfs::FileStatus::GetIsSocket () const
 Get stat url is a regular.
 

Detailed Description

File information status
Used on kodi::vfs::StatFile() to get detailed information about a file.

@ingroup cpp_kodi_vfs_Defs_FileStatus

The following table contains values that can be set with class FileStatus :

Name Type Set call Get call
ID of device containing file uint32_t SetDeviceId GetDeviceId
Represent file serial numbers uint64_t SetFileSerialNumber GetFileSerialNumber
Total size, in bytes uint64_t SetSize GetSize
Time of last access time_t SetAccessTime GetAccessTime
Time of last modification time_t SetModificationTime GetModificationTime
Time of last status change time_t SetStatusTime GetStatusTime
Stat url is a directory bool SetIsDirectory GetIsDirectory
Stat url as a symbolic link bool SetIsSymLink GetIsSymLink
Stat url as a block special bool SetIsBlock GetIsBlock
Stat url as a character special bool SetIsCharacter GetIsCharacter
Stat url as a FIFO special bool SetIsFifo GetIsFifo
Stat url as a regular bool SetIsRegular GetIsRegular
Stat url as a socket bool SetIsSocket GetIsSocket

Function Documentation

◆ GetAccessTime()

time_t kodi::vfs::FileStatus::GetAccessTime ( ) const
inline

Get time of last access.

◆ GetDeviceId()

uint32_t kodi::vfs::FileStatus::GetDeviceId ( ) const
inline

Get ID of device containing file.

◆ GetFileSerialNumber()

uint64_t kodi::vfs::FileStatus::GetFileSerialNumber ( ) const
inline

Get the file serial number, which distinguishes this file from all other files on the same device.

◆ GetIsBlock()

bool kodi::vfs::FileStatus::GetIsBlock ( ) const
inline

Get stat url is a block special.

◆ GetIsCharacter()

bool kodi::vfs::FileStatus::GetIsCharacter ( ) const
inline

Get stat url is a character special.

◆ GetIsDirectory()

bool kodi::vfs::FileStatus::GetIsDirectory ( ) const
inline

The stat url is a directory if returns true.

◆ GetIsFifo()

bool kodi::vfs::FileStatus::GetIsFifo ( ) const
inline

Get stat url is a FIFO special.

◆ GetIsRegular()

bool kodi::vfs::FileStatus::GetIsRegular ( ) const
inline

Get stat url is a regular.

◆ GetIsSocket()

bool kodi::vfs::FileStatus::GetIsSocket ( ) const
inline

Get stat url is a regular.

◆ GetIsSymLink()

bool kodi::vfs::FileStatus::GetIsSymLink ( ) const
inline

Get stat url is a symbolic link.

◆ GetModificationTime()

time_t kodi::vfs::FileStatus::GetModificationTime ( ) const
inline

Get time of last modification.

◆ GetSize()

uint64_t kodi::vfs::FileStatus::GetSize ( ) const
inline

Get total size, in bytes.

◆ GetStatusTime()

time_t kodi::vfs::FileStatus::GetStatusTime ( ) const
inline

Get time of last status change.

◆ SetAccessTime()

void kodi::vfs::FileStatus::SetAccessTime ( time_t accessTime)
inline

Set time of last access.

◆ SetDeviceId()

void kodi::vfs::FileStatus::SetDeviceId ( uint32_t deviceId)
inline

Set ID of device containing file.

◆ SetFileSerialNumber()

void kodi::vfs::FileStatus::SetFileSerialNumber ( uint64_t fileSerialNumber)
inline

Set the file serial number, which distinguishes this file from all other files on the same device.

◆ SetIsBlock()

void kodi::vfs::FileStatus::SetIsBlock ( bool isBlock)
inline

Set stat url as a block special.

◆ SetIsCharacter()

void kodi::vfs::FileStatus::SetIsCharacter ( bool isCharacter)
inline

Set stat url as a character special.

◆ SetIsDirectory()

void kodi::vfs::FileStatus::SetIsDirectory ( bool isDirectory)
inline

Set the stat url is a directory.

◆ SetIsFifo()

void kodi::vfs::FileStatus::SetIsFifo ( bool isFifo)
inline

Set stat url as a FIFO special.

◆ SetIsRegular()

void kodi::vfs::FileStatus::SetIsRegular ( bool isRegular)
inline

Set stat url as a regular.

◆ SetIsSocket()

void kodi::vfs::FileStatus::SetIsSocket ( bool isSocket)
inline

Set stat url is a socket.

◆ SetIsSymLink()

void kodi::vfs::FileStatus::SetIsSymLink ( bool isSymLink)
inline

Set stat url as a symbolic link.

◆ SetModificationTime()

void kodi::vfs::FileStatus::SetModificationTime ( time_t modificationTime)
inline

Set time of last modification.

◆ SetSize()

void kodi::vfs::FileStatus::SetSize ( uint64_t size)
inline

Set total size, in bytes.

◆ SetStatusTime()

void kodi::vfs::FileStatus::SetStatusTime ( time_t statusTime)
inline

Set time of last status change.