Kodi Development  20.0
for Binary and Script based Add-Ons

Detailed Description

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

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

Modules

 Value Help
 

Function Documentation

◆ SetDeviceId()

void SetDeviceId ( uint32_t  deviceId)
inline

Set ID of device containing file.

◆ GetDeviceId()

uint32_t GetDeviceId ( ) const
inline

Get ID of device containing file.

◆ SetFileSerialNumber()

void SetFileSerialNumber ( uint64_t  fileSerialNumber)
inline

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

◆ GetFileSerialNumber()

uint64_t GetFileSerialNumber ( ) const
inline

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

◆ SetSize()

void SetSize ( uint64_t  size)
inline

Set total size, in bytes.

◆ GetSize()

uint64_t GetSize ( ) const
inline

Get total size, in bytes.

◆ SetAccessTime()

void SetAccessTime ( time_t  accessTime)
inline

Set time of last access.

◆ GetAccessTime()

time_t GetAccessTime ( ) const
inline

Get time of last access.

◆ SetModificationTime()

void SetModificationTime ( time_t  modificationTime)
inline

Set time of last modification.

◆ GetModificationTime()

time_t GetModificationTime ( ) const
inline

Get time of last modification.

◆ SetStatusTime()

void SetStatusTime ( time_t  statusTime)
inline

Set time of last status change.

◆ GetStatusTime()

time_t GetStatusTime ( ) const
inline

Get time of last status change.

◆ SetIsDirectory()

void SetIsDirectory ( bool  isDirectory)
inline

Set the stat url is a directory.

◆ GetIsDirectory()

bool GetIsDirectory ( ) const
inline

The stat url is a directory if returns true.

◆ SetIsSymLink()

void SetIsSymLink ( bool  isSymLink)
inline

Set stat url as a symbolic link.

◆ GetIsSymLink()

bool GetIsSymLink ( ) const
inline

Get stat url is a symbolic link.

◆ SetIsBlock()

void SetIsBlock ( bool  isBlock)
inline

Set stat url as a block special.

◆ GetIsBlock()

bool GetIsBlock ( ) const
inline

Get stat url is a block special.

◆ SetIsCharacter()

void SetIsCharacter ( bool  isCharacter)
inline

Set stat url as a character special.

◆ GetIsCharacter()

bool GetIsCharacter ( ) const
inline

Get stat url is a character special.

◆ SetIsFifo()

void SetIsFifo ( bool  isFifo)
inline

Set stat url as a FIFO special.

◆ GetIsFifo()

bool GetIsFifo ( ) const
inline

Get stat url is a FIFO special.

◆ SetIsRegular()

void SetIsRegular ( bool  isRegular)
inline

Set stat url as a regular.

◆ GetIsRegular()

bool GetIsRegular ( ) const
inline

Get stat url is a regular.

◆ SetIsSocket()

void SetIsSocket ( bool  isSocket)
inline

Set stat url is a socket.

◆ GetIsSocket()

bool GetIsSocket ( ) const
inline

Get stat url is a regular.