lsf Namespace Reference

Classes
class	CFileMap
	A wrapper class for file-mapping routines. More...
class	CFilesEx
	High-level file functions. More...
class	CFileLib
	Cross-platform file functions. More...
Enumerations
enum	LSF_OPEN_FILE
Functions
virtual LSUINT32 LSE_CALL	ReadBytes (LSUINT8 *_pui8Buffer, LSUINT32 _ui32BytesToRead) const
virtual LSUINT64 LSE_CALL	ReadUInt64 () const
virtual LSUINT32 LSE_CALL	ReadUInt32 () const
virtual LSUINT16 LSE_CALL	ReadUInt16 () const
virtual LSUINT8 LSE_CALL	ReadUInt8 () const
virtual LSFLOAT LSE_CALL	ReadFloat () const
virtual LSDOUBLE LSE_CALL	ReadDouble () const
virtual LSUINT32 LSE_CALL	WriteBytes (const LSUINT8 *_pui8Buffer, LSUINT32 _ui32BytesToWrite)
virtual LSBOOL LSE_CALL	WriteUInt64 (const LSUINT64 &_ui64Value)
virtual LSBOOL LSE_CALL	WriteUInt32 (LSUINT32 _ui32Value)
virtual LSBOOL LSE_CALL	WriteUInt16 (LSUINT16 _ui16Value)
virtual LSBOOL LSE_CALL	WriteUInt8 (LSUINT8 _ui8Value)
virtual LSBOOL LSE_CALL	WriteFloat (LSFLOAT _fValue)
virtual LSBOOL LSE_CALL	WriteDouble (const LSDOUBLE &_dValue)
Variables
F	__pad0__
F LSF_OPEN_FILE	_ofOpenType
F LSF_OPEN_FILE LSBOOL	_bOpenAlways
LSF_FILE	m_fFile

---

Detailed Description

Copyright L. Spiro 2012 All rights reserved.

Written by: Shawn (L. Spiro) Wilcoxen

This code may not be sold or traded for any personal gain without express written consent. You may use this code in your own projects and modify it to suit your needs as long as this disclaimer remains intact. You may not take credit for having written this code.

Description: File streaming using standard CFileLib calls.

Copyright L. Spiro 2011 All rights reserved.

Written by: Shawn (L. Spiro) Wilcoxen

This code may not be sold or traded for any personal gain without express written consent. You may use this code in your own projects and modify it to suit your needs as long as this disclaimer remains intact. You may not take credit for having written this code.

Description: A wrapper class for file-mapping routines. This class makes it easy to map files and use the maps in an efficient and safe way.

Copyright L. Spiro 2011 All rights reserved.

Written by: Shawn (L. Spiro) Wilcoxen

This code may not be sold or traded for any personal gain without express written consent. You may use this code in your own projects and modify it to suit your needs as long as this disclaimer remains intact. You may not take credit for having written this code.

Description: Building off the low-level file routines, this class provides higher-level file functionality such as loading files to RAM.

---

Enumeration Type Documentation

enum lsf::LSF_OPEN_FILE

Ways to open a file.

---

Function Documentation

virtual LSUINT32 LSE_CALL lsf::ReadBytes	(	LSUINT8 *	_pui8Buffer,
		LSUINT32	_ui32BytesToRead
	)		const [virtual]

Read bytes from the stream. Stream position is advanced by the amount read.

Parameters:

_pui8Buffer	Buffer to hold the bytes read from the stream.
_ui32BytesToRead	Number of bytes to read.

Returns:

Returns the actual number of bytes read or LSSTD_SE_ERROR on error.

virtual LSDOUBLE LSE_CALL lsf::ReadDouble

(

)

const [virtual]

Reads a 64-bit double from the stream and advances the stream position.

Returns:

Returns the 64-bit double at the current position in the stream.

virtual LSFLOAT LSE_CALL lsf::ReadFloat

(

)

const [virtual]

Reads a 32-bit float from the stream and advances the stream position.

Returns:

Returns the 32-bit float at the current position in the stream.

virtual LSUINT16 LSE_CALL lsf::ReadUInt16

(

)

const [virtual]

Reads a 16-bit unsigned integer from the stream and advances the stream position.

Returns:

Returns the 16-bit unsigned integer at the current position in the stream.

virtual LSUINT32 LSE_CALL lsf::ReadUInt32

(

)

const [virtual]

Reads a 32-bit unsigned integer from the stream and advances the stream position.

Returns:

Returns the 32-bit unsigned integer at the current position in the stream.

virtual LSUINT64 LSE_CALL lsf::ReadUInt64

(

)

const [virtual]

Reads a 64-bit unsigned integer from the stream and advances the stream position.

Returns:

Returns the 64-bit unsigned integer at the current position in the stream.

virtual LSUINT8 LSE_CALL lsf::ReadUInt8

(

)

const [virtual]

Reads an 8-bit unsigned integer from the stream and advances the stream position.

Returns:

Returns the 8-bit unsigned integer at the current position in the stream.

virtual LSUINT32 LSE_CALL lsf::WriteBytes	(	const LSUINT8 *	_pui8Buffer,
		LSUINT32	_ui32BytesToWrite
	)		[virtual]

Write bytes to the stream. Stream position is advanced by the amount written.

Parameters:

_pui8Buffer	Buffer containing the bytes to write to the stream.
_ui32BytesToWrite	Number of bytes to write.

Returns:

Returns the actual number of bytes written or LSSTD_SE_ERROR on error.

virtual LSBOOL LSE_CALL lsf::WriteDouble

(

const LSDOUBLE &

_dValue

)

[virtual]

Writes a 64-bit double from the stream and advances the stream position.

Returns:

Returns true if the value was fully written to the stream.

virtual LSBOOL LSE_CALL lsf::WriteFloat

(

LSFLOAT

_fValue

)

[virtual]

Writes a 32-bit float from the stream and advances the stream position.

Returns:

Returns true if the value was fully written to the stream.

virtual LSBOOL LSE_CALL lsf::WriteUInt16

(

LSUINT16

_ui16Value

)

[virtual]

Writes a 16-bit unsigned integer to the stream and advances the stream position.

Returns:

Returns true if the value was fully written to the stream.

virtual LSBOOL LSE_CALL lsf::WriteUInt32

(

LSUINT32

_ui32Value

)

[virtual]

Writes a 32-bit unsigned integer to the stream and advances the stream position.

Returns:

Returns true if the value was fully written to the stream.

virtual LSBOOL LSE_CALL lsf::WriteUInt64

(

const LSUINT64 &

_ui64Value

)

[virtual]

Writes a 64-bit unsigned integer to the stream and advances the stream position.

Returns:

Returns true if the value was fully written to the stream.

virtual LSBOOL LSE_CALL lsf::WriteUInt8

(

LSUINT8

_ui8Value

)

[virtual]

Writes an 8-bit unsigned integer from the stream and advances the stream position.

Returns:

Returns true if the value was fully written to the stream.

---

Variable Documentation

LSF_FILE lsf::m_fFile

The currently opened file.