Represents a path to a file and a file referred to by this path and provides methods for manipulating it. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include <file_info.h>

Inherits System::IO::FileSystemInfo.

Public Member Functions
	FileInfo (const String &path)
	Constructs a new instance of FileInfo class that represents the specified file. More...

DirectoryInfoPtr	get_Directory ()
	Returns a DirectoryInfo object that represents a directory in which the file represented by the current object is located. More...

String	get_DirectoryName ()
	Returns the full name of the directory in which the file represented by the current object is loctaed. More...

bool	get_IsReadOnly ()
	Returns a value that indicates if the ReadOnly attribute is set. More...

void	set_IsReadOnly (bool value)
	Sets or unsets the ReadOnly attribute on the file. More...

int64_t	get_Length ()
	Returns the size of the file in bytes. More...

virtual bool	get_Exists () override
	Returns a value that indicates if the file exists. More...

virtual String	get_Name () override
	Returns the name of the file. More...

FileInfoPtr	CopyTo (const String &destFileName)
	Copies the file represented by the current object to the specified location. If the destination file already exists, the copying fails. More...

FileInfoPtr	CopyTo (const String &destFileName, bool overwrite)
	Copies the file represented by the current object to the specified location. A parameter specifies if existing destination file should be overwritten. More...

virtual void	Delete () override
	Removes the file represented by the current object. More...

FileInfoPtr	Replace (const String &destinationFileName, const String &destinationBackupFileName)
	Replaces the contents of a specified destination file with the file represented by the current FileInfo object and creates a backup of the replaced file. More...

FileInfoPtr	Replace (const String &destinationFileName, const String &destinationBackupFileName, bool ignoreMetadataErrors)
	Replaces the contents of a specified destination file with the file represented by the current FileInfo object and creates a backup of the replaced file. More...

void	Decrypt ()
	NOT IMPLEMENTED. More...

void	Encrypt ()
	NOT IMPLEMENTED. More...

void	MoveTo (const String &destFileName)
	Moves the file represented by the current object to the specified location. More...

FileStreamPtr	Open (FileMode mode)
	Opens the file represented by the current object in the specified mode for reading and writing and with no sharing. More...

FileStreamPtr	Open (FileMode mode, FileAccess access)
	Opens the file represented by the current object in the specified mode, with the specified access type and with no sharing. More...

FileStreamPtr	Open (FileMode mode, FileAccess access, FileShare share)
	Opens the file represented by the current object in the specified mode, with the specified access type and sharing option. More...

FileStreamPtr	Create ()
	Creates a file at the location specified by the path represented by the current object and opens it for reading and writing, in truncate mode and with no sharing. More...

FileStreamPtr	OpenRead ()
	Opens a file represented by the current object for reading only, in 'Open' mode with shared access for reading. More...

FileStreamPtr	OpenWrite ()
	Opens a file represented by the current object for writing only, in 'OpenOrCreate' mode with no sharing. More...

StreamWriterPtr	AppendText ()
	Opens a file represented by the current object for writing text using UTF-8 encoding, in 'Append' mode with no sharing. More...

StreamWriterPtr	CreateText ()
	Creates a file at the location specified by the path represented by the current object and opens it for writing text using UTF-8 encoding with no sharing. More...

StreamReaderPtr	OpenText ()
	Opens the existing file at the location specified by the path represented by the current object for reading text using UTF-8 encoding with no sharing. More...

String	ToString () const override
	Returns a path represented by the current object. More...

Public Member Functions inherited from System::IO::FileSystemInfo
FileAttributes	get_Attributes ()
	Returns the attributes of the entity represented by the current object. More...

void	set_Attributes (FileAttributes value)
	Sets the specified attributes on the entity represeted by the current object. More...

DateTime	get_CreationTime ()
	Returns the creation time of the entity represented by the current object as local time. More...

void	set_CreationTime (DateTime value)
	Sets the creation time of the entity represented by the current object as local time. More...

DateTime	get_CreationTimeUtc ()
	Returns the creation time of the entity represented by the current object as UTC time. More...

void	set_CreationTimeUtc (DateTime value)
	Sets the creation time of the entity represented by the current object as UTC time. More...

DateTime	get_LastAccessTime ()
	Returns the last access time of the entity represented by the current object as local time. More...

void	set_LastAccessTime (DateTime value)
	Sets the last access time of the entity represented by the current object as local time. More...

DateTime	get_LastAccessTimeUtc ()
	Returns the last access time of the entity represented by the current object as UTC time. More...

void	set_LastAccessTimeUtc (DateTime value)
	Sets the last access time of the entity represented by the current object as UTC time. More...

DateTime	get_LastWriteTime ()
	Returns the last write time of the entity represented by the current object as local time. More...

void	set_LastWriteTime (DateTime value)
	Sets the last write time of the entity represented by the current object as local time. More...

DateTime	get_LastWriteTimeUtc ()
	Returns the last write time of the entity represented by the current object as UTC time. More...

void	set_LastWriteTimeUtc (DateTime value)
	Sets the last write time of the entity represented by the current object as UTC time. More...

virtual bool	get_Exists ()=0
	Determines if the entity referenced by the path represented by the current object exists. More...

String	get_Extension ()
	Returns the extension of the file represented by the current object. More...

virtual String	get_FullName ()
	Returns the full name (including path) of the entity represented by the current object. More...

virtual String	get_Name ()=0
	Returns a name of the entity represented by the current object. More...

virtual void	Delete ()=0
	Deletes the entity represented by the current object. More...

virtual void	Finalize ()
	Does nothing. More...

void	Refresh ()
	Refreshes the state of the current object. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Protected Member Functions inherited from System::IO::FileSystemInfo
	FileSystemInfo ()
	Constructs a new instance of FileSystemInfo class. More...

void	Refresh (bool force)
	Refreshes the state of the current object. More...

Protected Attributes inherited from System::IO::FileSystemInfo
String	FullPath
	The full path of the entity represented by the current object. More...

String	OriginalPath
	The original path, passed to the current object's constructor, of the entity represented by the current object. More...

FileSystemInfoStat	info
	Information describing the entity represented by the current object. More...

bool	valid
	Indicates if the path represented by the current object references an existing entity. More...

Detailed Description

Represents a path to a file and a file referred to by this path and provides methods for manipulating it. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ FileInfo()

System::IO::FileInfo::FileInfo ( const String & path )

Constructs a new instance of FileInfo class that represents the specified file.

Parameters

path	The path to the file

Member Function Documentation

◆ AppendText()

StreamWriterPtr System::IO::FileInfo::AppendText ( )

Opens a file represented by the current object for writing text using UTF-8 encoding, in 'Append' mode with no sharing.

Returns: A shared pointer to a StreamWriter object associated with the opened file

◆ CopyTo() [1/2]

FileInfoPtr System::IO::FileInfo::CopyTo ( const String & destFileName )

Copies the file represented by the current object to the specified location. If the destination file already exists, the copying fails.

Parameters

destFileName The destination file name

Returns: A FileInfo object that represents the copy

◆ CopyTo() [2/2]

FileInfoPtr System::IO::FileInfo::CopyTo	(	const String &	destFileName,
		bool	overwrite
	)

Copies the file represented by the current object to the specified location. A parameter specifies if existing destination file should be overwritten.

Parameters

destFileName	The destination file name
overwrite	True if the existing destination file should be overwritten, false if copying should fail if the destination file already exists

Returns: A FileInfo object that represents the copy

◆ Create()

FileStreamPtr System::IO::FileInfo::Create ( )

Creates a file at the location specified by the path represented by the current object and opens it for reading and writing, in truncate mode and with no sharing.

Returns: A FileStream object associated with the created file

◆ CreateText()

StreamWriterPtr System::IO::FileInfo::CreateText ( )

Creates a file at the location specified by the path represented by the current object and opens it for writing text using UTF-8 encoding with no sharing.

Returns: A shared pointer to a StreamWriter object associated with the created file

◆ Decrypt()

void System::IO::FileInfo::Decrypt ( )

NOT IMPLEMENTED.

Exceptions

IOException Always

◆ Delete()

virtual void System::IO::FileInfo::Delete ( )

overridevirtual

Removes the file represented by the current object.

Implements System::IO::FileSystemInfo.

◆ Encrypt()

void System::IO::FileInfo::Encrypt ( )

NOT IMPLEMENTED.

Exceptions

IOException Always

◆ get_Directory()

DirectoryInfoPtr System::IO::FileInfo::get_Directory ( )

Returns a DirectoryInfo object that represents a directory in which the file represented by the current object is located.

◆ get_DirectoryName()

String System::IO::FileInfo::get_DirectoryName ( )

Returns the full name of the directory in which the file represented by the current object is loctaed.

◆ get_Exists()

virtual bool System::IO::FileInfo::get_Exists ( )

overridevirtual

Returns a value that indicates if the file exists.

Implements System::IO::FileSystemInfo.

◆ get_IsReadOnly()

bool System::IO::FileInfo::get_IsReadOnly ( )

Returns a value that indicates if the ReadOnly attribute is set.

Returns: True if the ReadOnly attribute is set, otherwise - false

◆ get_Length()

int64_t System::IO::FileInfo::get_Length ( )

Returns the size of the file in bytes.

◆ get_Name()

virtual String System::IO::FileInfo::get_Name ( )

overridevirtual

Returns the name of the file.

Implements System::IO::FileSystemInfo.

◆ MoveTo()

void System::IO::FileInfo::MoveTo ( const String & destFileName )

Moves the file represented by the current object to the specified location.

Parameters

destFileName The destination file name

◆ Open() [1/3]

FileStreamPtr System::IO::FileInfo::Open ( FileMode mode )

Opens the file represented by the current object in the specified mode for reading and writing and with no sharing.

Parameters

mode	Specifies the mode in which to open the flie

Returns: A FileStream object associated with the file represented by the current object

◆ Open() [2/3]

FileStreamPtr System::IO::FileInfo::Open	(	FileMode	mode,
		FileAccess	access
	)

Opens the file represented by the current object in the specified mode, with the specified access type and with no sharing.

Parameters

mode	Specifies the mode in which to open the flie
access	The requested access type

Returns: A FileStream object associated with the file represented by the current object

◆ Open() [3/3]

FileStreamPtr System::IO::FileInfo::Open	(	FileMode	mode,
		FileAccess	access,
		FileShare	share
	)

Opens the file represented by the current object in the specified mode, with the specified access type and sharing option.

Parameters

mode	Specifies the mode in which to open the flie
access	The requested access type
share	The type of access that other FileStream objects have to the opened file

Returns: A FileStream object associated with the file represented by the current object

◆ OpenRead()

FileStreamPtr System::IO::FileInfo::OpenRead ( )

Opens a file represented by the current object for reading only, in 'Open' mode with shared access for reading.

Returns: A FileStream object associated with the opened file

◆ OpenText()

StreamReaderPtr System::IO::FileInfo::OpenText ( )

Opens the existing file at the location specified by the path represented by the current object for reading text using UTF-8 encoding with no sharing.

Returns: A shared pointer to a StreamWriter object associated with the opened file

◆ OpenWrite()

FileStreamPtr System::IO::FileInfo::OpenWrite ( )

Opens a file represented by the current object for writing only, in 'OpenOrCreate' mode with no sharing.

Returns: A FileStream object associated with the opened file

◆ Replace() [1/2]

FileInfoPtr System::IO::FileInfo::Replace	(	const String &	destinationFileName,
		const String &	destinationBackupFileName
	)

Replaces the contents of a specified destination file with the file represented by the current FileInfo object and creates a backup of the replaced file.

Parameters

destinationFileName	A name of the file to replace
destinationBackupFileName	A name of the backup file

Returns: A FileInfor object that represents the file pointed to by destinationFileName

◆ Replace() [2/2]

FileInfoPtr System::IO::FileInfo::Replace	(	const String &	destinationFileName,
		const String &	destinationBackupFileName,
		bool	ignoreMetadataErrors
	)

Replaces the contents of a specified destination file with the file represented by the current FileInfo object and creates a backup of the replaced file.

Parameters

destinationFileName	A name of the file to replace
destinationBackupFileName	A name of the backup file
ignoreMetadataErrors	Specifies if the merge errors from the replaced file to the replacement file should be ignored (true) or not (false)

Returns: A FileInfor object that represents the file pointed to by destinationFileName

◆ set_IsReadOnly()

void System::IO::FileInfo::set_IsReadOnly ( bool value )

Sets or unsets the ReadOnly attribute on the file.

Parameters

value True if the ReadOnly attribute has to be set, false if the ReadOnly attribute has to be unset

◆ ToString()

String System::IO::FileInfo::ToString ( ) const

overridevirtual

Returns a path represented by the current object.

Reimplemented from System::Object.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileInfo()

Member Function Documentation

◆ AppendText()

◆ CopyTo() [1/2]

◆ CopyTo() [2/2]

◆ Create()

◆ CreateText()

◆ Decrypt()

◆ Delete()

◆ Encrypt()

◆ get_Directory()

◆ get_DirectoryName()

◆ get_Exists()

◆ get_IsReadOnly()

◆ get_Length()

◆ get_Name()

◆ MoveTo()

◆ Open() [1/3]

◆ Open() [2/3]

◆ Open() [3/3]

◆ OpenRead()

◆ OpenText()

◆ OpenWrite()

◆ Replace() [1/2]

◆ Replace() [2/2]

◆ set_IsReadOnly()

◆ ToString()