nsIFile Interface Reference

Inheritance diagram for nsIFile:

Collaboration diagram for nsIFile:

Classes
struct	PRFileDesc

Public Types
typedef struct nsIFile::PRFileDesc	PRLibrary
typedef struct nsIFile::PRFileDesc	widl_FILE

Public Member Functions
nsresult	Append (const nsAString *node)
nsresult	AppendNative (const nsAString *node)
nsresult	Normalize ()
nsresult	Create (uint32_t type, uint32_t permission)
nsresult	GetLeafName (nsAString *aLeafName)
nsresult	SetLeafName (const nsAString *aLeafName)
nsresult	GetNativeLeafName (nsAString *aLeafName)
nsresult	SetNativeLeafName (const nsAString *aLeafName)
nsresult	CopyTo (nsIFile *newParentDir, const nsAString *newName)
nsresult	CopyToNative (nsIFile *newParentDir, const nsAString *newName)
nsresult	CopyToFollowingLinks (nsIFile *newParentDir, const nsAString *newName)
nsresult	CopyToFollowingLinksNative (nsIFile *newParentDir, const nsAString *newName)
nsresult	MoveTo (nsIFile *newParentDir, const nsAString *newName)
nsresult	MoveToNative (nsIFile *newParentDir, const nsAString *newName)
nsresult	RenameTo (nsIFile *newParentDir, const nsAString *newName)
nsresult	Remove (bool recursive)
nsresult	GetPermissions (uint32_t *aPermissions)
nsresult	SetPermissions (uint32_t pPermissions)
nsresult	GetPermissionsOfLink (uint32_t *aPermissions)
nsresult	SetPermissionsOfLink (uint32_t pPermissions)
nsresult	GetLastModifiedTime (PRTime *aLastModifiedTime)
nsresult	SetLastModifiedTime (PRTime aLastModifiedTime)
nsresult	GetLastModifiedTimeOfLink (PRTime *aLastModifiedTimeOfLink)
nsresult	SetLastModifiedTimeOfLink (PRTime aLastModifiedTimeOfLink)
nsresult	GetFileSize (int64_t *aFileSize)
nsresult	SetFileSize (int64_t aFileSize)
nsresult	GetFileSizeOfLink (int64_t *aFileSizeOfLink)
nsresult	GetTarget (nsAString *aTarget)
nsresult	GetNativeTarget (nsACString *aNativeTarget)
nsresult	GetPath (nsAString *aPath)
nsresult	GetNativePath (nsACString *aNativePath)
nsresult	Exists (bool *_retval)
nsresult	IsWritable (bool *_retval)
nsresult	IsReadable (bool *_retval)
nsresult	IsExecutable (bool *_retval)
nsresult	IsHidden (bool *_retval)
nsresult	IsDirectory (bool *_retval)
nsresult	IsFile (bool *_retval)
nsresult	IsSymlink (bool *_retval)
nsresult	IsSpecial (bool *_retval)
nsresult	CreateUnique (uint32_t type, uint32_t permission)
nsresult	Clone (nsIFile **_retval)
nsresult	Equals (nsIFile *inFile, bool *_retval)
nsresult	Contains (nsIFile *inFile, bool *_retval)
nsresult	GetParent (nsIFile **aParent)
nsresult	GetDirectoryEntries (nsISimpleEnumerator **aDirectoryEntries)
nsresult	InitWithPath (const nsAString *filePath)
nsresult	InitWithNativePath (const nsACString *filePath)
nsresult	InitWithFile (nsIFile *aFile)
nsresult	GetFollowLinks (bool *aFollowLinks)
nsresult	SetFollowLinks (bool aFollowLinks)
nsresult	OpenNSPRFileDesc (int32_t flags, int32_t mode, PRFileDesc **_retval)
nsresult	OpenANSIFileDesc (const char *mode, FILE **_retval)
nsresult	Load (PRLibrary **_retval)
nsresult	GetDiskSpaceAvailable (int64_t *aDiskSpaceAvailable)
nsresult	AppendRelativePath (const nsAString *relativeFilePath)
nsresult	AppendRelativeNativePath (const nsACString *relativeFilePath)
nsresult	GetPersistentDescriptor (nsACString *aPersistentDescriptor)
nsresult	SetPersistentDescriptor (const nsACString *aPersistentDescriptor)
nsresult	Reveal ()
nsresult	Launch ()
nsresult	GetRelativeDescriptor (nsIFile *fromFile, nsACString *_retval)
nsresult	SetRelativeDescriptor (nsIFile *fromFile, const nsACString *relativeDesc)
Public Member Functions inherited from nsISupports
nsresult	QueryInterface (nsIIDRef riid, void **result)
nsrefcnt	AddRef ()
nsrefcnt	Release ()

Detailed Description

Definition at line 2603 of file nsiface.idl.

Member Typedef Documentation

PRLibrary

typedef struct nsIFile::PRFileDesc nsIFile::PRLibrary

widl_FILE

typedef struct nsIFile::PRFileDesc nsIFile::widl_FILE

Member Function Documentation

Append()

nsresult nsIFile::Append

(

const nsAString *

node

)

AppendNative()

nsresult nsIFile::AppendNative

(

const nsAString *

node

)

AppendRelativeNativePath()

nsresult nsIFile::AppendRelativeNativePath

(

const nsACString *

relativeFilePath

)

AppendRelativePath()

nsresult nsIFile::AppendRelativePath

(

const nsAString *

relativeFilePath

)

Clone()

nsresult nsIFile::Clone

(

nsIFile **

_retval

)

Contains()

nsresult nsIFile::Contains	(	nsIFile *	inFile,
		bool *	_retval
	)

CopyTo()

nsresult nsIFile::CopyTo	(	nsIFile *	newParentDir,
		const nsAString *	newName
	)

CopyToFollowingLinks()

nsresult nsIFile::CopyToFollowingLinks	(	nsIFile *	newParentDir,
		const nsAString *	newName
	)

CopyToFollowingLinksNative()

nsresult nsIFile::CopyToFollowingLinksNative	(	nsIFile *	newParentDir,
		const nsAString *	newName
	)

CopyToNative()

nsresult nsIFile::CopyToNative	(	nsIFile *	newParentDir,
		const nsAString *	newName
	)

Create()

nsresult nsIFile::Create	(	uint32_t	type,
		uint32_t	permission
	)

CreateUnique()

nsresult nsIFile::CreateUnique	(	uint32_t	type,
		uint32_t	permission
	)

Equals()

nsresult nsIFile::Equals	(	nsIFile *	inFile,
		bool *	_retval
	)

Exists()

nsresult nsIFile::Exists

(

bool *

_retval

)

GetDirectoryEntries()

nsresult nsIFile::GetDirectoryEntries

(

nsISimpleEnumerator **

aDirectoryEntries

)

GetDiskSpaceAvailable()

nsresult nsIFile::GetDiskSpaceAvailable

(

int64_t *

aDiskSpaceAvailable

)

GetFileSize()

nsresult nsIFile::GetFileSize

(

int64_t *

aFileSize

)

GetFileSizeOfLink()

nsresult nsIFile::GetFileSizeOfLink

(

int64_t *

aFileSizeOfLink

)

GetFollowLinks()

nsresult nsIFile::GetFollowLinks

(

bool *

aFollowLinks

)

GetLastModifiedTime()

nsresult nsIFile::GetLastModifiedTime

(

PRTime *

aLastModifiedTime

)

GetLastModifiedTimeOfLink()

nsresult nsIFile::GetLastModifiedTimeOfLink

(

PRTime *

aLastModifiedTimeOfLink

)

GetLeafName()

nsresult nsIFile::GetLeafName

(

nsAString *

aLeafName

)

GetNativeLeafName()

nsresult nsIFile::GetNativeLeafName

(

nsAString *

aLeafName

)

GetNativePath()

nsresult nsIFile::GetNativePath

(

nsACString *

aNativePath

)

GetNativeTarget()

nsresult nsIFile::GetNativeTarget

(

nsACString *

aNativeTarget

)

GetParent()

nsresult nsIFile::GetParent

(

nsIFile **

aParent

)

GetPath()

nsresult nsIFile::GetPath

(

nsAString *

aPath

)

GetPermissions()

nsresult nsIFile::GetPermissions

(

uint32_t *

aPermissions

)

GetPermissionsOfLink()

nsresult nsIFile::GetPermissionsOfLink

(

uint32_t *

aPermissions

)

GetPersistentDescriptor()

nsresult nsIFile::GetPersistentDescriptor

(

nsACString *

aPersistentDescriptor

)

GetRelativeDescriptor()

nsresult nsIFile::GetRelativeDescriptor	(	nsIFile *	fromFile,
		nsACString *	_retval
	)

GetTarget()

nsresult nsIFile::GetTarget

(

nsAString *

aTarget

)

InitWithFile()

nsresult nsIFile::InitWithFile

(

nsIFile *

aFile

)

InitWithNativePath()

nsresult nsIFile::InitWithNativePath

(

const nsACString *

filePath

)

InitWithPath()

nsresult nsIFile::InitWithPath

(

const nsAString *

filePath

)

IsDirectory()

nsresult nsIFile::IsDirectory

(

bool *

_retval

)

IsExecutable()

nsresult nsIFile::IsExecutable

(

bool *

_retval

)

IsFile()

nsresult nsIFile::IsFile

(

bool *

_retval

)

IsHidden()

nsresult nsIFile::IsHidden

(

bool *

_retval

)

IsReadable()

nsresult nsIFile::IsReadable

(

bool *

_retval

)

IsSpecial()

nsresult nsIFile::IsSpecial

(

bool *

_retval

)

IsSymlink()

nsresult nsIFile::IsSymlink

(

bool *

_retval

)

IsWritable()

nsresult nsIFile::IsWritable

(

bool *

_retval

)

Launch()

nsresult nsIFile::Launch

(

)

Load()

nsresult nsIFile::Load

(

PRLibrary **

_retval

)

MoveTo()

nsresult nsIFile::MoveTo	(	nsIFile *	newParentDir,
		const nsAString *	newName
	)

MoveToNative()

nsresult nsIFile::MoveToNative	(	nsIFile *	newParentDir,
		const nsAString *	newName
	)

Normalize()

nsresult nsIFile::Normalize

(

)

OpenANSIFileDesc()

nsresult nsIFile::OpenANSIFileDesc	(	const char *	mode,
		FILE **	_retval
	)

OpenNSPRFileDesc()

nsresult nsIFile::OpenNSPRFileDesc	(	int32_t	flags,
		int32_t	mode,
		PRFileDesc **	_retval
	)

Remove()

nsresult nsIFile::Remove

(

bool

recursive

)

RenameTo()

nsresult nsIFile::RenameTo	(	nsIFile *	newParentDir,
		const nsAString *	newName
	)

Reveal()

nsresult nsIFile::Reveal

(

)

SetFileSize()

nsresult nsIFile::SetFileSize

(

int64_t

aFileSize

)

SetFollowLinks()

nsresult nsIFile::SetFollowLinks

(

bool

aFollowLinks

)

SetLastModifiedTime()

nsresult nsIFile::SetLastModifiedTime

(

PRTime

aLastModifiedTime

)

SetLastModifiedTimeOfLink()

nsresult nsIFile::SetLastModifiedTimeOfLink

(

PRTime

aLastModifiedTimeOfLink

)

SetLeafName()

nsresult nsIFile::SetLeafName

(

const nsAString *

aLeafName

)

SetNativeLeafName()

nsresult nsIFile::SetNativeLeafName

(

const nsAString *

aLeafName

)

SetPermissions()

nsresult nsIFile::SetPermissions

(

uint32_t

pPermissions

)

SetPermissionsOfLink()

nsresult nsIFile::SetPermissionsOfLink

(

uint32_t

pPermissions

)

SetPersistentDescriptor()

nsresult nsIFile::SetPersistentDescriptor

(

const nsACString *

aPersistentDescriptor

)

SetRelativeDescriptor()

nsresult nsIFile::SetRelativeDescriptor	(	nsIFile *	fromFile,
		const nsACString *	relativeDesc
	)

---

The documentation for this interface was generated from the following file:

• dll/win32/mshtml/nsiface.idl