System::IO::FileInfo Class Reference

Inherits System::IO::FileSystemInfo.

Public Member Functions

ASPOSECPP_SHARED_API FileInfo (const String &path)
 
ASPOSECPP_SHARED_API DirectoryInfoPtr get_Directory ()
 
ASPOSECPP_SHARED_API String get_DirectoryName ()
 
ASPOSECPP_SHARED_API bool get_IsReadOnly ()
 
ASPOSECPP_SHARED_API void set_IsReadOnly (bool value)
 
ASPOSECPP_SHARED_API int64_t get_Length ()
 Returns the size of the file in bytes. More...
 
virtual ASPOSECPP_SHARED_API bool get_Exists () override
 Returns a value that indicates if the file exists. More...
 
virtual ASPOSECPP_SHARED_API String get_Name () override
 Returns the name of the file. More...
 
ASPOSECPP_SHARED_API FileInfoPtr CopyTo (const String &destFileName)
 
ASPOSECPP_SHARED_API FileInfoPtr CopyTo (const String &destFileName, bool overwrite)
 
virtual ASPOSECPP_SHARED_API void Delete () override
 Removes the file represented by the current object. More...
 
ASPOSECPP_SHARED_API FileInfoPtr Replace (const String &destinationFileName, const String &destinationBackupFileName)
 
ASPOSECPP_SHARED_API FileInfoPtr Replace (const String &destinationFileName, const String &destinationBackupFileName, bool ignoreMetadataErrors)
 
ASPOSECPP_SHARED_API void Decrypt ()
 
ASPOSECPP_SHARED_API void Encrypt ()
 
ASPOSECPP_SHARED_API void MoveTo (const String &destFileName)
 
ASPOSECPP_SHARED_API FileStreamPtr Open (FileMode mode)
 
ASPOSECPP_SHARED_API FileStreamPtr Open (FileMode mode, FileAccess access)
 
ASPOSECPP_SHARED_API FileStreamPtr Open (FileMode mode, FileAccess access, FileShare share)
 
ASPOSECPP_SHARED_API FileStreamPtr Create ()
 
ASPOSECPP_SHARED_API FileStreamPtr OpenRead ()
 
ASPOSECPP_SHARED_API FileStreamPtr OpenWrite ()
 
ASPOSECPP_SHARED_API StreamWriterPtr AppendText ()
 
ASPOSECPP_SHARED_API StreamWriterPtr CreateText ()
 
ASPOSECPP_SHARED_API StreamReaderPtr OpenText ()
 
ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST override
 Returns a path represented by the current object. More...
 
- Public Member Functions inherited from System::IO::FileSystemInfo
ASPOSECPP_SHARED_API FileAttributes get_Attributes ()
 Returns the attributes of the entity represented by the current object. More...
 
ASPOSECPP_SHARED_API void set_Attributes (FileAttributes value)
 
ASPOSECPP_SHARED_API DateTime get_CreationTime ()
 Returns the creation time of the entity represented by the current object as local time. More...
 
ASPOSECPP_SHARED_API void set_CreationTime (DateTime value)
 
ASPOSECPP_SHARED_API DateTime get_CreationTimeUtc ()
 Returns the creation time of the entity represented by the current object as UTC time. More...
 
ASPOSECPP_SHARED_API void set_CreationTimeUtc (DateTime value)
 
ASPOSECPP_SHARED_API DateTime get_LastAccessTime ()
 Returns the last access time of the entity represented by the current object as local time. More...
 
ASPOSECPP_SHARED_API void set_LastAccessTime (DateTime value)
 
ASPOSECPP_SHARED_API DateTime get_LastAccessTimeUtc ()
 Returns the last access time of the entity represented by the current object as UTC time. More...
 
ASPOSECPP_SHARED_API void set_LastAccessTimeUtc (DateTime value)
 
ASPOSECPP_SHARED_API DateTime get_LastWriteTime ()
 Returns the last write time of the entity represented by the current object as local time. More...
 
ASPOSECPP_SHARED_API void set_LastWriteTime (DateTime value)
 
ASPOSECPP_SHARED_API DateTime get_LastWriteTimeUtc ()
 Returns the last write time of the entity represented by the current object as UTC time. More...
 
ASPOSECPP_SHARED_API void set_LastWriteTimeUtc (DateTime value)
 
ASPOSECPP_SHARED_API String get_Extension ()
 Returns the extension of the file represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API String get_FullName ()
 Returns the full name (including path) of the entity represented by the current object. More...
 
virtual ASPOSECPP_SHARED_API void Finalize ()
 Does nothing. More...
 
ASPOSECPP_SHARED_API void Refresh ()
 Refreshes the state of the current object. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. 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()

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

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

Parameters
pathThe path to the file

Member Function Documentation

◆ AppendText()

ASPOSECPP_SHARED_API 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]

ASPOSECPP_SHARED_API 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
destFileNameThe destination file name
Returns
A FileInfo object that represents the copy

◆ CopyTo() [2/2]

ASPOSECPP_SHARED_API 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
destFileNameThe destination file name
overwriteTrue 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

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

NOT IMPLEMENTED.

Exceptions
IOExceptionAlways

◆ Delete()

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

Removes the file represented by the current object.

Implements System::IO::FileSystemInfo.

◆ Encrypt()

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

NOT IMPLEMENTED.

Exceptions
IOExceptionAlways

◆ get_Directory()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API bool System::IO::FileInfo::get_Exists ( )
overridevirtual

Returns a value that indicates if the file exists.

Implements System::IO::FileSystemInfo.

◆ get_IsReadOnly()

ASPOSECPP_SHARED_API 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()

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

Returns the size of the file in bytes.

◆ get_Name()

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

Returns the name of the file.

Implements System::IO::FileSystemInfo.

◆ MoveTo()

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

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

Parameters
destFileNameThe destination file name

◆ Open() [1/3]

ASPOSECPP_SHARED_API 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
modeSpecifies the mode in which to open the flie
Returns
A FileStream object associated with the file represented by the current object

◆ Open() [2/3]

ASPOSECPP_SHARED_API 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
modeSpecifies the mode in which to open the flie
accessThe requested access type
Returns
A FileStream object associated with the file represented by the current object

◆ Open() [3/3]

ASPOSECPP_SHARED_API 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
modeSpecifies the mode in which to open the flie
accessThe requested access type
shareThe 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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]

ASPOSECPP_SHARED_API 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
destinationFileNameA name of the file to replace
destinationBackupFileNameA name of the backup file
Returns
A FileInfor object that represents the file pointed to by destinationFileName

◆ Replace() [2/2]

ASPOSECPP_SHARED_API 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
destinationFileNameA name of the file to replace
destinationBackupFileNameA name of the backup file
ignoreMetadataErrorsSpecifies 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()

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

Sets or unsets the ReadOnly attribute on the file.

Parameters
valueTrue if the ReadOnly attribute has to be set, false if the ReadOnly attribute has to be unset

◆ ToString()

ASPOSECPP_SHARED_API String System::IO::FileInfo::ToString ( )
overridevirtual

Returns a path represented by the current object.

Reimplemented from System::Object.