CXStdioFile Class Reference

CXStdioFile reads or write strings from the file. More...

Detailed Description

CXStdioFile reads or write strings from the file.

The string read or write depends on the operating system (unicode on windows, ansi / utf8 on linux and macos). It is recommended to use CXStdioFileEx which is the advanced version that support unicode / ansi file as well as a simple ReadString method.

#include <XStdioFile.h>

Inheritance diagram for CXStdioFile:

Public Member Functions
	CXStdioFile (bool allowException=true)
	CXStdioFile (FILE *pOpenStream, bool allowException=true)
	CXStdioFile (LPCTSTR lpszFileName, unsigned int nOpenFlags)
	nOpenFlags is a combination of CXFile::OpenFlags
virtual void	WriteString (LPCTSTR lpsz)
virtual LPTSTR	ReadString (LPTSTR lpsz, unsigned int nMax)
virtual bool	ReadString (CXString &rString)
virtual fileuint	GetPosition () const
virtual fileuint	GetLength () const
virtual bool	Open (LPCTSTR lpszFileName, unsigned int nOpenFlags, CXFileException *pError=NULL)
	nOpenFlags is a combination of CXFile::OpenFlags
virtual unsigned int	Read (void *buffer, unsigned int maxByteToRead)
virtual void	Write (const void *buffer, unsigned int byteToWrite)
virtual fileuint	Seek (longint lOff, CXFile::SeekPosition nFrom)
virtual void	Abort ()
virtual void	Flush ()
virtual void	Close ()
FILE *	GetStream ()
Public Member Functions inherited from CXFile
	CXFile (bool allowException=true)
	CXFile (xFileHandle hFile, bool allowException=true)
	CXFile (LPCTSTR lpszFileName, unsigned int openFlags)
	CXFile (CFile *pfile, bool allowException=true)
	allowException = false then no exception is send by the class which return false instead
virtual CXString	GetFileName () const
virtual CXString	GetFilePath () const
virtual void	SetFilePath (LPCTSTR lpszNewName)
fileuint	SeekToEnd ()
void	SeekToBegin ()
virtual bool	SetLength (fileuint newlength)

Additional Inherited Members
Public Types inherited from CXFile
enum	OpenFlags {   modeRead = 0x00000 , modeWrite = 0x00001 , modeReadWrite = 0x00002 , readFlags = modeRead|modeWrite|modeReadWrite ,   shareExclusive = 0x00010 , shareDenyWrite = 0x00020 , shareDenyRead = 0x00030 , shareDenyNone = 0x00040 ,   shareFlags = shareExclusive| shareDenyWrite|shareDenyRead|shareDenyNone , typeUnicode = 0x00400 , typeUtf8 = 0x00800 , modeCreate = 0x01000 ,   modeNoTruncate = 0x02000 , typeText = 0x04000 , typeBinary = 0x08000 , noException = 0x100000 ,   specificFlags = 0x10000000 }
	Specify the open mode for file. More...
enum	SeekPosition { begin = 0x00 , current = 0x01 , end = 0x02 }
typedef enum CXFile::SeekPosition	SeekPosition

Member Function Documentation

Abort()

virtual void CXStdioFile::Abort ( )

virtual

Reimplemented from CXFile.

Close()

virtual void CXStdioFile::Close ( )

virtual

Reimplemented from CXFile.

Flush()

virtual void CXStdioFile::Flush ( )

virtual

Reimplemented from CXFile.

GetLength()

virtual fileuint CXStdioFile::GetLength ( ) const

virtual

Reimplemented from CXFile.

GetPosition()

virtual fileuint CXStdioFile::GetPosition ( ) const

virtual

Reimplemented from CXFile.

Open()

virtual bool CXStdioFile::Open ( LPCTSTR  lpszFileName, unsigned int  nOpenFlags, CXFileException *  pError = NULL  )

virtual

nOpenFlags is a combination of CXFile::OpenFlags

Reimplemented from CXFile.

Reimplemented in CStdioFileEx.

Read()

virtual unsigned int CXStdioFile::Read ( void *  buffer, unsigned int  maxByteToRead  )

virtual

Reimplemented from CXFile.

ReadString()

virtual bool CXStdioFile::ReadString ( CXString &  rString )

virtual

Reimplemented in CStdioFileEx.

Seek()

virtual fileuint CXStdioFile::Seek ( longint  lOff, CXFile::SeekPosition  nFrom  )

virtual

Reimplemented from CXFile.

Write()

virtual void CXStdioFile::Write ( const void *  buffer, unsigned int  byteToWrite  )

virtual

Reimplemented from CXFile.

WriteString()

virtual void CXStdioFile::WriteString ( LPCTSTR  lpsz )

virtual

Reimplemented in CStdioFileEx.

---

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

• D:/VS2022-PolygonCruncherSDK-Full-IO/SDK/Includes/XStdioFile.h