Inheritance diagram for plDataDirectory::FileserveDataDirectoryReader:

[legend]

Public Member Functions
	FileserveDataDirectoryReader (plInt32 iDataDirUserData)

Public Member Functions inherited from plDataDirectory::FolderReader
	FolderReader (plInt32 iDataDirUserData)

virtual plUInt64	Skip (plUInt64 uiBytes) override
	Helper method to skip a number of bytes (implementations of the directory reader may implement this more efficiently for example)

virtual plUInt64	Read (void *pBuffer, plUInt64 uiBytes) override

virtual plUInt64	GetFileSize () const override
	Returns the current total size of the file.

Public Member Functions inherited from plDataDirectoryReader
	plDataDirectoryReader (plInt32 iDataDirUserData)

Public Member Functions inherited from plDataDirectoryReaderWriterBase
	plDataDirectoryReaderWriterBase (plInt32 iDataDirUserData, bool bIsReader)
	The derived class should pass along whether it is a reader or writer.

plResult	Open (plStringView sFile, plDataDirectoryType *pOwnerDataDirectory, plFileShareMode::Enum fileShareMode)
	Used by plDataDirectoryType's to try to open the given file. They need to pass along their own pointer.

void	Close ()
	Closes this data stream.

const plString128 &	GetFilePath () const
	Returns the relative path of this file within the owner data directory.

plDataDirectoryType *	GetDataDirectory () const
	Returns the pointer to the data directory, which created this reader/writer.

bool	IsReader () const
	Returns true if this is a reader stream, false if it is a writer stream.

plInt32	GetDataDirUserData () const

Protected Member Functions
virtual plResult	InternalOpen (plFileShareMode::Enum FileShareMode) override
	This function must be implemented by the derived class.

Protected Member Functions inherited from plDataDirectory::FolderReader
virtual void	InternalClose () override
	This function must be implemented by the derived class.

Additional Inherited Members
Protected Attributes inherited from plDataDirectory::FolderReader
bool	m_bIsInUse

plOSFile	m_File

Protected Attributes inherited from plDataDirectoryReaderWriterBase
bool	m_bIsReader

plInt32	m_iDataDirUserData = 0

plDataDirectoryType *	m_pDataDirType

plString128	m_sFilePath

Member Function Documentation

◆ InternalOpen()

plResult plDataDirectory::FileserveDataDirectoryReader::InternalOpen ( plFileShareMode::Enum FileShareMode )

overrideprotectedvirtual

This function must be implemented by the derived class.

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