KodiToAddonFuncTable_VFSEntry Struct Reference

#include <kodi_vfs_types.h>

Public Member Functions
void *__cdecl *	open (const AddonInstance_VFSEntry *instance, const VFSURL *url)
void *__cdecl *	open_for_write (const AddonInstance_VFSEntry *instance, const VFSURL *url, bool overwrite)
	ssize_t (__cdecl *read)(const AddonInstance_VFSEntry *instance
	ssize_t (__cdecl *write)(const AddonInstance_VFSEntry *instance
	int64_t (__cdecl *seek)(const AddonInstance_VFSEntry *instance
	int (__cdecl *truncate)(const AddonInstance_VFSEntry *instance
	int64_t (__cdecl *get_length)(const AddonInstance_VFSEntry *instance
	int64_t (__cdecl *get_position)(const AddonInstance_VFSEntry *instance
	int (__cdecl *get_chunk_size)(const AddonInstance_VFSEntry *instance
	int (__cdecl *io_control)(const AddonInstance_VFSEntry *instance
	int (__cdecl *stat)(const AddonInstance_VFSEntry *instance
	bool (__cdecl *close)(const AddonInstance_VFSEntry *instance
	bool (__cdecl *exists)(const AddonInstance_VFSEntry *instance
	void (__cdecl *clear_out_idle)(const AddonInstance_VFSEntry *instance)
	void (__cdecl *disconnect_all)(const AddonInstance_VFSEntry *instance)
	bool (__cdecl *delete_it)(const AddonInstance_VFSEntry *instance
	bool (__cdecl *rename)(const AddonInstance_VFSEntry *instance
	bool (__cdecl *directory_exists)(const AddonInstance_VFSEntry *instance
	bool (__cdecl *remove_directory)(const AddonInstance_VFSEntry *instance
	bool (__cdecl *create_directory)(const AddonInstance_VFSEntry *instance
	bool (__cdecl *get_directory)(const AddonInstance_VFSEntry *instance
	bool (__cdecl *contains_files)(const AddonInstance_VFSEntry *instance
	void (__cdecl *free_directory)(const AddonInstance_VFSEntry *instance
void *__cdecl *	Open (VFSURL *url)
	Open a file for input. More...
void *__cdecl *	OpenForWrite (VFSURL *url, bool bOverWrite)
	Open a file for output. More...
	ssize_t (__cdecl *Read)(void *context
	Read from a file. More...
	ssize_t (__cdecl *Write)(void *context
	Write to a file. More...
	int64_t (__cdecl *Seek)(void *context
	Seek in a file. More...
	int (__cdecl *Truncate)(void *context
	Truncate a file. More...
	int64_t (__cdecl *GetLength)(void *context)
	Get total size of a file. More...
	int64_t (__cdecl *GetPosition)(void *context)
	Get current position in a file. More...
	int (__cdecl *GetChunkSize)(void *context)
	Get chunk size of a file. More...
	int (__cdecl *IoControl)(void *context
	Perform an IO-control on the file. More...
	int (__cdecl *Stat)(VFSURL *url
	Stat a file. More...
	bool (__cdecl *Close)(void *context)
	Close a file. More...
	bool (__cdecl *Exists)(VFSURL *url)
	Check for file existence. More...
	void (__cdecl *ClearOutIdle)()
	Clear out any idle connections. More...
	void (__cdecl *DisconnectAll)()
	Disconnect all connections. More...
	bool (__cdecl *Delete)(VFSURL *url)
	Delete a file. More...
	bool (__cdecl *Rename)(VFSURL *url
	Rename a file. More...
	bool (__cdecl *DirectoryExists)(VFSURL *url)
	Check for directory existence. More...
	bool (__cdecl *RemoveDirectory)(VFSURL *url)
	Remove a directory. More...
	bool (__cdecl *CreateDirectory)(VFSURL *url)
	Create a directory. More...
void *__cdecl *	GetDirectory (VFSURL *url, VFSDirEntry **entries, int *num_entries, VFSCallbacks *callbacks)
	List a directory. More...
	void (__cdecl *FreeDirectory)(void *ctx)
	Free up resources after listing a directory. More...
void *__cdecl *	ContainsFiles (VFSURL *url, VFSDirEntry **entries, int *num_entries, char *rootpath)
	Check if file should be presented as a directory (multiple streams) More...

Public Attributes
kodi::addon::CInstanceVFS *	addonInstance
void *	context
void void *	buffer
void void size_t	buf_size
void const void *	buffer
void const void size_t	buf_size
void int64_t	position
void int64_t int	whence
void int64_t	size
void XFILE::EIoControl	request
void XFILE::EIoControl void *	param
const VFSURL *	url
const VFSURL struct __stat64 *	buffer
const VFSURL const VFSURL *	url2
const VFSURL VFSDirEntry **	entries
const VFSURL VFSDirEntry int *	num_entries
const VFSURL VFSDirEntry int VFSGetDirectoryCallbacks *	callbacks
const VFSURL VFSDirEntry int char *	rootpath
VFSDirEntry *	entries
VFSDirEntry int	num_entries
void *	buffer
void size_t	uiBufSize
const void *	buffer
const void size_t	uiBufSize
int64_t	position
int64_t int	whence
int64_t	size
XFILE::EIoControl	request
XFILE::EIoControl void *	param
struct __stat64 *	buffer
VFSURL *	url2

Member Function Documentation

bool() [1/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

close

)

const

bool() [2/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

exists

)

const

bool() [3/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

delete_it

)

const

bool() [4/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

rename

)

const

bool() [5/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

directory_exists

)

const

bool() [6/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

remove_directory

)

const

bool() [7/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

create_directory

)

const

bool() [8/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

get_directory

)

const

bool() [9/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

contains_files

)

const

bool() [10/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

Close

)

Close a file.

Parameters

context

The context of the file

Returns

True on success, false on failure

See also

IFile::Close

bool() [11/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

Exists

)

Check for file existence.

Parameters

url	The URL of the file

Returns

True if file exists, false otherwise

See also

IFile::Exists

bool() [12/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

Delete

)

Delete a file.

Parameters

url	The URL of the file

Returns

True if deletion was successful, false otherwise

See also

IFile::Delete

bool() [13/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

Rename

)

Rename a file.

Parameters

url	The URL of the source file
url2	The URL of the destination file

Returns

True if deletion was successful, false otherwise

See also

IFile::Rename

bool() [14/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

DirectoryExists

)

Check for directory existence.

Parameters

url	The URL of the file

Returns

True if directory exists, false otherwise

See also

IDirectory::Exists

bool() [15/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

RemoveDirectory

)

Remove a directory.

Parameters

url	The URL of the directory

Returns

True if removal was successful, false otherwise

See also

IDirectory::Remove

bool() [16/16]

KodiToAddonFuncTable_VFSEntry::bool

(

__cdecl *

CreateDirectory

)

Create a directory.

Parameters

url	The URL of the file

Returns

True if creation was successful, false otherwise

See also

IDirectory::Create

ContainsFiles()

void* __cdecl* KodiToAddonFuncTable_VFSEntry::ContainsFiles	(	VFSURL *	url,
		VFSDirEntry **	entries,
		int *	num_entries,
		char *	rootpath
	)

Check if file should be presented as a directory (multiple streams)

Parameters

url	The URL of the file
entries	The entries in the directory
num_entries	Number of entries in the directory
rootpath	Path to root directory if multiple entries

Returns

Context for the directory listing

See also

IFileDirectory::ContainsFiles, FreeDirectory

GetDirectory()

void* __cdecl* KodiToAddonFuncTable_VFSEntry::GetDirectory	(	VFSURL *	url,
		VFSDirEntry **	entries,
		int *	num_entries,
		VFSCallbacks *	callbacks
	)

List a directory.

Parameters

url	The URL of the directory
entries	The entries in the directory
num_entries	Number of entries in the directory
callbacks	A callback structure

Returns

Context for the directory listing

See also

IDirectory::GetDirectory

int() [1/8]

KodiToAddonFuncTable_VFSEntry::int

(

__cdecl *

truncate

)

const

int() [2/8]

KodiToAddonFuncTable_VFSEntry::int

(

__cdecl *

get_chunk_size

)

const

int() [3/8]

KodiToAddonFuncTable_VFSEntry::int

(

__cdecl *

io_control

)

const

int() [4/8]

KodiToAddonFuncTable_VFSEntry::int

(

__cdecl *

stat

)

const

int() [5/8]

KodiToAddonFuncTable_VFSEntry::int

(

__cdecl *

Truncate

)

Truncate a file.

Parameters

context	The context of the file
size	The size to truncate the file to

Returns

0 on success, -1 on error

See also

IFile::Truncate

int() [6/8]

KodiToAddonFuncTable_VFSEntry::int

(

__cdecl *

GetChunkSize

)

Get chunk size of a file.

Parameters

context

The context of the file

Returns

Chunk size

See also

IFile::GetChunkSize()

int() [7/8]

KodiToAddonFuncTable_VFSEntry::int

(

__cdecl *

IoControl

)

Perform an IO-control on the file.

Parameters

context	The context of the file
request	The requested IO-control
param	Parameter attached to the IO-control

Returns

-1 on error, >= 0 on success

See also

IFile::IoControl

int() [8/8]

KodiToAddonFuncTable_VFSEntry::int

(

__cdecl *

Stat

)

Stat a file.

Parameters

url	The URL of the file
buffer	The buffer to store results in

Returns

-1 on error, 0 otherwise

See also

IFile::Stat

int64_t() [1/6]

KodiToAddonFuncTable_VFSEntry::int64_t

(

__cdecl *

seek

)

const

int64_t() [2/6]

KodiToAddonFuncTable_VFSEntry::int64_t

(

__cdecl *

get_length

)

const

int64_t() [3/6]

KodiToAddonFuncTable_VFSEntry::int64_t

(

__cdecl *

get_position

)

const

int64_t() [4/6]

KodiToAddonFuncTable_VFSEntry::int64_t

(

__cdecl *

Seek

)

Seek in a file.

Parameters

context	The context of the file
position	The position to seek to
whence	Position in file 'position' is relative to (SEEK_CUR, SEEK_SET, SEEK_END)

Returns

Offset in file after seek

See also

IFile::Seek

int64_t() [5/6]

KodiToAddonFuncTable_VFSEntry::int64_t

(

__cdecl *

GetLength

)

Get total size of a file.

Parameters

context

The context of the file

Returns

Total file size

See also

IFile::GetLength

int64_t() [6/6]

KodiToAddonFuncTable_VFSEntry::int64_t

(

__cdecl *

GetPosition

)

Get current position in a file.

Parameters

context

The context of the file

Returns

Current position

See also

IFile::GetPosition

open()

void* __cdecl* KodiToAddonFuncTable_VFSEntry::open	(	const AddonInstance_VFSEntry *	instance,
		const VFSURL *	url
	)

Open()

void* __cdecl* KodiToAddonFuncTable_VFSEntry::Open

(

VFSURL *

url

)

Open a file for input.

Parameters

url	The URL of the file

Returns

Context for the opened file

See also

IFile::Open

open_for_write()

void* __cdecl* KodiToAddonFuncTable_VFSEntry::open_for_write	(	const AddonInstance_VFSEntry *	instance,
		const VFSURL *	url,
		bool	overwrite
	)

OpenForWrite()

void* __cdecl* KodiToAddonFuncTable_VFSEntry::OpenForWrite	(	VFSURL *	url,
		bool	bOverWrite
	)

Open a file for output.

Parameters

url	The URL of the file
bOverwrite	Whether or not to overwrite an existing file

Returns

Context for the opened file

See also

IFile::OpenForWrite

ssize_t() [1/4]

KodiToAddonFuncTable_VFSEntry::ssize_t

(

__cdecl *

read

)

const

ssize_t() [2/4]

KodiToAddonFuncTable_VFSEntry::ssize_t

(

__cdecl *

write

)

const

ssize_t() [3/4]

KodiToAddonFuncTable_VFSEntry::ssize_t

(

__cdecl *

Read

)

Read from a file.

Parameters

context	The context of the file
buffer	The buffer to read data into
uiBufSize	Number of bytes to read

Returns

Number of bytes read

See also

IFile::Read

ssize_t() [4/4]

KodiToAddonFuncTable_VFSEntry::ssize_t

(

__cdecl *

Write

)

Write to a file.

Parameters

context	The context of the file
buffer	The buffer to read data from
uiBufSize	Number of bytes to write

Returns

Number of bytes written

See also

IFile::Write

void() [1/6]

KodiToAddonFuncTable_VFSEntry::void

(

__cdecl *

clear_out_idle

)

const

void() [2/6]

KodiToAddonFuncTable_VFSEntry::void

(

__cdecl *

disconnect_all

)

const

void() [3/6]

KodiToAddonFuncTable_VFSEntry::void

(

__cdecl *

free_directory

)

const

void() [4/6]

KodiToAddonFuncTable_VFSEntry::void

(

__cdecl *

ClearOutIdle

)

Clear out any idle connections.

void() [5/6]

KodiToAddonFuncTable_VFSEntry::void

(

__cdecl *

DisconnectAll

)

Disconnect all connections.

void() [6/6]

KodiToAddonFuncTable_VFSEntry::void

(

__cdecl *

FreeDirectory

)

Free up resources after listing a directory.

Member Data Documentation

addonInstance

kodi::addon::CInstanceVFS* KodiToAddonFuncTable_VFSEntry::addonInstance

buf_size [1/2]

void void size_t KodiToAddonFuncTable_VFSEntry::buf_size

buf_size [2/2]

void const void size_t KodiToAddonFuncTable_VFSEntry::buf_size

buffer [1/6]

void void* KodiToAddonFuncTable_VFSEntry::buffer

buffer [2/6]

void const void* KodiToAddonFuncTable_VFSEntry::buffer

buffer [3/6]

const VFSURL struct __stat64* KodiToAddonFuncTable_VFSEntry::buffer

buffer [4/6]

void* KodiToAddonFuncTable_VFSEntry::buffer

buffer [5/6]

const void* KodiToAddonFuncTable_VFSEntry::buffer

buffer [6/6]

struct __stat64* KodiToAddonFuncTable_VFSEntry::buffer

callbacks

const VFSURL VFSDirEntry int VFSGetDirectoryCallbacks* KodiToAddonFuncTable_VFSEntry::callbacks

context

void * KodiToAddonFuncTable_VFSEntry::context

entries [1/2]

const VFSURL VFSDirEntry ** KodiToAddonFuncTable_VFSEntry::entries

entries [2/2]

VFSDirEntry* KodiToAddonFuncTable_VFSEntry::entries

num_entries [1/2]

const VFSURL VFSDirEntry int * KodiToAddonFuncTable_VFSEntry::num_entries

num_entries [2/2]

VFSDirEntry int KodiToAddonFuncTable_VFSEntry::num_entries

param [1/2]

void XFILE::EIoControl void* KodiToAddonFuncTable_VFSEntry::param

param [2/2]

XFILE::EIoControl void* KodiToAddonFuncTable_VFSEntry::param

position [1/2]

void int64_t KodiToAddonFuncTable_VFSEntry::position

position [2/2]

int64_t KodiToAddonFuncTable_VFSEntry::position

request [1/2]

void XFILE::EIoControl KodiToAddonFuncTable_VFSEntry::request

request [2/2]

XFILE::EIoControl KodiToAddonFuncTable_VFSEntry::request

rootpath

const VFSURL VFSDirEntry int char* KodiToAddonFuncTable_VFSEntry::rootpath

size [1/2]

void int64_t KodiToAddonFuncTable_VFSEntry::size

size [2/2]

int64_t KodiToAddonFuncTable_VFSEntry::size

uiBufSize [1/2]

void size_t KodiToAddonFuncTable_VFSEntry::uiBufSize

uiBufSize [2/2]

const void size_t KodiToAddonFuncTable_VFSEntry::uiBufSize

url

const VFSURL * KodiToAddonFuncTable_VFSEntry::url

url2 [1/2]

const VFSURL const VFSURL* KodiToAddonFuncTable_VFSEntry::url2

url2 [2/2]

VFSURL* KodiToAddonFuncTable_VFSEntry::url2

whence [1/2]

void int64_t int KodiToAddonFuncTable_VFSEntry::whence

whence [2/2]

int64_t int KodiToAddonFuncTable_VFSEntry::whence

---

The documentation for this struct was generated from the following files:

• VFS.h
• kodi_vfs_types.h