File Namespace Reference

Interface for several file and directory related services. More...

Classes
class	LocalFileSystemAccess
class	Monitor
	Monitors files and directories for changes. More...
class	MultiSpec
	Specification for one or more files. More...
class	Path
	File pathname tools. More...
class	SystemAccess
class	ViewPars

Enumerations
enum	ViewStyle { Text, Table, Log, Bin }

Functions
bool	exists (const char *)
bool	isReadable (const char *)
bool	isEmpty (const char *)
bool	isDirEmpty (const char *)
bool	isFile (const char *)
bool	isDirectory (const char *)
bool	isURI (const char *&)
	if local, will remove 'file://' More...
const char *	getCanonicalPath (const char *)
const char *	getRelativePath (const char *reltodir, const char *fnm)
void	makeRecursiveFileList (const char *dir, BufferStringSet &filelist, bool followlinks=false)
bool	createLink (const char *from, const char *to)
bool	isLink (const char *)
const char *	linkTarget (const char *linkname)
	Direct, first target. More...
const char *	linkEnd (const char *linkname)
const char *	linkValue (const char *linkname)
	not sure why and when to use - used by zip More...
void	hide (const char *, bool yn)
	only Windows More...
bool	isHidden (const char *)
bool	isWritable (const char *)
bool	makeWritable (const char *, bool yesno, bool recursive)
bool	isExecutable (const char *)
bool	makeExecutable (const char *, bool yesno)
bool	setPermissions (const char *, const char *perms, bool recursive)
bool	isInUse (const char *fnm)
bool	createDir (const char *)
bool	rename (const char *oldname, const char *newname)
bool	copy (const char *from, const char *to, uiString *errmsg=0)
Executor *	getRecursiveCopier (const char *from, const char *to)
Executor *	getRecursiveDeleter (const char *dirnm, const BufferStringSet *externallist=0, bool filesonly=false)
bool	resize (const char *, int64_t)
bool	remove (const char *)
bool	saveCopy (const char *from, const char *to)
bool	copyDir (const char *from, const char *to, uiString *errmsg=0)
bool	removeDir (const char *)
bool	changeDir (const char *path)
bool	checkDirectory (const char *fnm, bool forread, uiString &errmsg)
bool	getContent (const char *, BufferString &)
int64_t	getFileSize (const char *fnm, bool followlink=true)
	bytes More...
int64_t	getKbSize (const char *)
BufferString	getFileSizeString (int64_t fileszinkb)
BufferString	getFileSizeString (const char *fnm)
const char *	timeCreated (const char *filenm, const char *fmt=Time::defDateTimeFmt())
const char *	timeLastModified (const char *filenm, const char *fmt=Time::defDateTimeFmt())
int64_t	getTimeInSeconds (const char *, bool modif=true)
const char *	getCurrentPath ()
const char *	getHomePath ()
const char *	getTempPath ()
const char *	getRootPath (const char *path)
Export_Basic const EnumDefImpl< ViewStyle > &	ViewStyleDef ()
Export_Basic const char **	ViewStyleNames ()
Export_Basic bool	parseEnum (const IOPar &, const char *, ViewStyle &)
Export_Basic bool	parseEnum (const char *, ViewStyle &)
Export_Basic bool	parseEnumViewStyle (const char *, ViewStyle &)
Export_Basic ViewStyle	parseEnumViewStyle (const char *)
Export_Basic const char *	toString (ViewStyle)
Export_Basic uiString	toUiString (ViewStyle)
Export_Basic const char *	getViewStyleString (ViewStyle)
bool	launchViewer (const char *, const ViewPars &vp=ViewPars())

Detailed Description

Interface for several file and directory related services.

Enumeration Type Documentation

enum File::ViewStyle

Enumerator
Text
Table
Log
Bin

Function Documentation

bool File::changeDir

(

const char *

path

)

bool File::checkDirectory	(	const char *	fnm,
		bool	forread,
		uiString &	errmsg
	)

checks if the parent directory of a file is readable/writable

bool File::copy	(	const char *	from,
		const char *	to,
		uiString *	errmsg = 0
	)

bool File::copyDir	(	const char *	from,
		const char *	to,
		uiString *	errmsg = 0
	)

bool File::createDir

(

const char *

)

bool File::createLink	(	const char *	from,
		const char *	to
	)

bool File::exists

(

const char *

)

const char* File::getCanonicalPath

(

const char *

)

bool File::getContent	(	const char *	,
		BufferString &
	)

const char* File::getCurrentPath

(

)

int64_t File::getFileSize	(	const char *	fnm,
		bool	followlink = true
	)

bytes

BufferString File::getFileSizeString

(

int64_t

fileszinkb

)

BufferString File::getFileSizeString

(

const char *

fnm

)

const char* File::getHomePath

(

)

int64_t File::getKbSize

(

const char *

)

Executor* File::getRecursiveCopier	(	const char *	from,
		const char *	to
	)

Executor* File::getRecursiveDeleter	(	const char *	dirnm,
		const BufferStringSet *	externallist = 0,
		bool	filesonly = false
	)

const char* File::getRelativePath	(	const char *	reltodir,
		const char *	fnm
	)

const char* File::getRootPath

(

const char *

path

)

const char* File::getTempPath

(

)

int64_t File::getTimeInSeconds	(	const char *	,
		bool	modif = true
	)

Export_Basic const char* File::getViewStyleString

(

ViewStyle

)

void File::hide	(	const char *	,
		bool	yn
	)

only Windows

bool File::isDirectory

(

const char *

)

bool File::isDirEmpty

(

const char *

)

bool File::isEmpty

(

const char *

)

bool File::isExecutable

(

const char *

)

bool File::isFile

(

const char *

)

bool File::isHidden

(

const char *

)

bool File::isInUse

(

const char *

fnm

)

bool File::isLink

(

const char *

)

bool File::isReadable

(

const char *

)

bool File::isURI

(

const char *&

)

if local, will remove 'file://'

bool File::isWritable

(

const char *

)

bool File::launchViewer	(	const char *	,
		const ViewPars &	vp = ViewPars()
	)

const char* File::linkEnd

(

const char *

linkname

)

'Final' destination of link protected against circular links

const char* File::linkTarget

(

const char *

linkname

)

Direct, first target.

const char* File::linkValue

(

const char *

linkname

)

not sure why and when to use - used by zip

bool File::makeExecutable	(	const char *	,
		bool	yesno
	)

void File::makeRecursiveFileList	(	const char *	dir,
		BufferStringSet &	filelist,
		bool	followlinks = false
	)

bool File::makeWritable	(	const char *	,
		bool	yesno,
		bool	recursive
	)

Export_Basic bool File::parseEnum	(	const char *	,
		ViewStyle &
	)

Export_Basic bool File::parseEnum	(	const IOPar &	,
		const char *	,
		ViewStyle &
	)

Export_Basic bool File::parseEnumViewStyle	(	const char *	,
		ViewStyle &
	)

Export_Basic ViewStyle File::parseEnumViewStyle

(

const char *

)

bool File::remove

(

const char *

)

bool File::removeDir

(

const char *

)

bool File::rename	(	const char *	oldname,
		const char *	newname
	)

bool File::resize	(	const char *	,
		int64_t
	)

bool File::saveCopy	(	const char *	from,
		const char *	to
	)

bool File::setPermissions	(	const char *	,
		const char *	perms,
		bool	recursive
	)

const char* File::timeCreated	(	const char *	filenm,
		const char *	fmt = Time::defDateTimeFmt()
	)

const char* File::timeLastModified	(	const char *	filenm,
		const char *	fmt = Time::defDateTimeFmt()
	)

Export_Basic const char* File::toString

(

ViewStyle

)

Export_Basic uiString File::toUiString

(

ViewStyle

)

Export_Basic const EnumDefImpl< ViewStyle >& File::ViewStyleDef

(

)

Export_Basic const char** File::ViewStyleNames

(

)