File system

Collaboration diagram for File system:

Modules
	File descriptors
	Directories

Files
file	vlc_fs.h
	The functions in this file help with using low-level Unix-style file descriptors, BSD sockets and directories.

Functions
int	vlc_stat (const char *filename, struct stat *st)
	Finds file/inode information - like stat().
int	vlc_lstat (const char *filename, struct stat *st)
	Finds file/inode information, as lstat().
int	vlc_unlink (const char *filename)
	Removes a file.
int	vlc_rename (const char *oldpath, const char *newpath)
	Moves a file atomically.
FILE *	vlc_fopen (const char *filename, const char *mode)
	Opens a FILE pointer.

Detailed Description

Function Documentation

vlc_fopen()

FILE * vlc_fopen	(	const char *	filename,
		const char *	mode
	)

Opens a FILE pointer.

Parameters

filename	file path, using UTF-8 encoding
mode	fopen file open mode

Returns

NULL on error, an open FILE pointer on success.

References vlc_close(), and vlc_open().

Referenced by config_OpenConfigFile(), hash_from_binary_file(), ImageWriteUrl(), input_FindArtInCacheUsingItemUID(), input_SaveArt(), TsStorageNew(), update_DownloadReal(), vlc_playlist_Export(), and vout_snapshot_SaveImage().

vlc_lstat()

int vlc_lstat	(	const char *	filename,
		struct stat *	st
	)

Finds file/inode information, as lstat().

Consider using fstat() instead, if possible.

Parameters

filename	UTF-8 file path
st	the POSIX stat structure to fill

References vlc_stat(), and vlc_statEx().

vlc_rename()

int vlc_rename	(	const char *	oldpath,
		const char *	newpath
	)

Moves a file atomically.

This only works within a single file system.

Parameters

oldpath	path to the file before the move
newpath	intended path to the file after the move

Returns

A 0 return value indicates success. A -1 return value indicates an error, and an error code is stored in errno

References ToLocaleDup, and widen_path().

Referenced by config_SaveConfigFile().

vlc_stat()

int vlc_stat	(	const char *	filename,
		struct stat *	st
	)

Finds file/inode information - like stat().

Note

As far as possible, fstat() should be used instead.

Parameters

filename	UTF-8 file path
st	the POSIX stat structure to fill

References vlc_statEx(), and widen_path().

Referenced by input_SaveArt(), input_SubtitleFile2Uri(), InputGetExtraFilesPattern(), subtitles_Detect(), vlc_lstat(), and vout_snapshot_SaveImage().

vlc_unlink()

int vlc_unlink

(

const char *

filename

)

Removes a file.

Parameters

filename

a UTF-8 string with the name of the file you want to delete.

Returns

A 0 return value indicates success. A -1 return value indicates an error, and an error code is stored in errno

References ToLocaleDup, unlikely, and widen_path().

Referenced by config_SaveConfigFile(), TsStorageDelete(), TsStorageNew(), and update_DownloadReal().