DFile Class

File class, used in the C++ Support Classes and sample code to provide a portable way to read and write files.

File

File: dfile.h

Namespace: dtSearch

attach Method

Syntax

C++

class DFile : public DStreamBase;

Data Members

Show:Protected

No members matching the current filter

Data Member	Description
inode	From stat

Group

Classes

Members

Methods

Show:InheritedProtected

No members matching the current filter

Method	Description
attach(const char *, t_FileHandle, int, bool)	Attach a file handle
attach(t_FileHandle, int, bool)	Attach a file handle
canRead	Returns true if the the file was opened with read access
canRead	Returns true if the stream was opened with read access (Inherited from DStreamBase)
canSeek	Returns true if the stream supports seek()
canSeek	Returns true if the stream supports seek() (Inherited from DStreamBase)
canWrite	Returns true if the the file was opened with write access
canWrite	Returns true if the stream was opened with write access (Inherited from DStreamBase)
close	Close the file
createTemp	Open a temporary file
flush	Close and reopen the file handle. DFile does not maintain buffers so all I/O is unbuffered.
flushFileBuffers	Force file changes to be written to disk
freeze	Close the file so it can be reopened without changing state
getCreatedDate	Get the created date of the file
getHandle	Returns an operating system handle to the file
getLastAccessDate	Get the last access date of the file
getLastError	Get the last system error that occurred when trying to access this file
getLength	Return the length of the file
getLength	Return the length of the stream (Inherited from DStreamBase)
getModifiedDate	Get the last-modified date of the file
getName	Get the name that was used to open the file
good	Returns true if the file was opened successfully
isOpen	True if the file is open
logAndSaveError	After an operation has completed, throw a DFileException if an error occurred
open	Open a file, using a UTF-8 filename
openUi	Open a file, using a TCHAR or CString filename
openW	Open a file, using a Unicode filename
read	Read data from the file
read	Read data from the stream (Inherited from DStreamBase)
read32	! Obsolete
seek	Change the file position
seek	Change the file position in the stream (Inherited from DStreamBase)
setDates	Set the created and modified date of the file
setLastAccessDate	Set the last access date of the file
setLength	Set the length of the file (this can be used to truncate a file)
setLength	Set the length of the stream (Inherited from DStreamBase)
setModifiedDate	Set the last-modified date of the file
tell	Get the file position
tell	Return the current file position (Inherited from DStreamBase)
write	Write data to the file
write	Write data to the stream (Inherited from DStreamBase)
write32	! Obsolete

Data Members

Show:Protected

No members matching the current filter

Data Member	Description
inode	From stat

Methods

Show:InheritedProtected

No members matching the current filter

Method	Description
attach(const char *, t_FileHandle, int, bool)	Attach a file handle
attach(t_FileHandle, int, bool)	Attach a file handle
canRead	Returns true if the the file was opened with read access
canRead	Returns true if the stream was opened with read access (Inherited from DStreamBase)
canSeek	Returns true if the stream supports seek()
canSeek	Returns true if the stream supports seek() (Inherited from DStreamBase)
canWrite	Returns true if the the file was opened with write access
canWrite	Returns true if the stream was opened with write access (Inherited from DStreamBase)
close	Close the file
createTemp	Open a temporary file
flush	Close and reopen the file handle. DFile does not maintain buffers so all I/O is unbuffered.
flushFileBuffers	Force file changes to be written to disk
freeze	Close the file so it can be reopened without changing state
getCreatedDate	Get the created date of the file
getHandle	Returns an operating system handle to the file
getLastAccessDate	Get the last access date of the file
getLastError	Get the last system error that occurred when trying to access this file
getLength	Return the length of the file
getLength	Return the length of the stream (Inherited from DStreamBase)
getModifiedDate	Get the last-modified date of the file
getName	Get the name that was used to open the file
good	Returns true if the file was opened successfully
isOpen	True if the file is open
logAndSaveError	After an operation has completed, throw a DFileException if an error occurred
open	Open a file, using a UTF-8 filename
openUi	Open a file, using a TCHAR or CString filename
openW	Open a file, using a Unicode filename
read	Read data from the file
read	Read data from the stream (Inherited from DStreamBase)
read32	! Obsolete
seek	Change the file position
seek	Change the file position in the stream (Inherited from DStreamBase)
setDates	Set the created and modified date of the file
setLastAccessDate	Set the last access date of the file
setLength	Set the length of the file (this can be used to truncate a file)
setLength	Set the length of the stream (Inherited from DStreamBase)
setModifiedDate	Set the last-modified date of the file
tell	Get the file position
tell	Return the current file position (Inherited from DStreamBase)
write	Write data to the file
write	Write data to the stream (Inherited from DStreamBase)
write32	! Obsolete

Remarks

DFile supports 64-bit file sizes and offsets.

DFile supports Unicode filenames on operating systems that have Unicode support

Class Hierarchy

dtSearch::DStreamBase | dtSearch::DFile