FILE_LEGACY_STREAM Class Reference

Class to provide open/close access as "file pointer" (FILE*) for 3rd-party libraries. More...

#include <mi32/filelegacy.h>

List of all members.

Public Types
enum	TRANSLATION { TRANSLATION_None = 0, TRANSLATION_Text = 1 }
Public Member Functions
	FILE_LEGACY_STREAM ()
	~FILE_LEGACY_STREAM ()
void	Close ()
FILE *	GetFilePointer () const
bool	IsOpen () const
ERRVALUE	Open (const FILEPATH &filepath, TRANSLATION translation, FILE_ACCESS access=FILE_ACCESS_Read)
	operator FILE * () const

---

Detailed Description

Class to provide open/close access as "file pointer" (FILE*) for 3rd-party libraries.

Provides implicit cast to FILE*.

---

Member Enumeration Documentation

enum FILE_LEGACY_STREAM::TRANSLATION

Enumerator:

TRANSLATION_None	No translation (raw binary.
TRANSLATION_Text	Text translation with platform-specific EOL and EOF support, use with caution.

---

Constructor & Destructor Documentation

FILE_LEGACY_STREAM::FILE_LEGACY_STREAM

(

)

Default constructor.

FILE_LEGACY_STREAM::~FILE_LEGACY_STREAM

(

)

Destructor, closes file if open.

---

Member Function Documentation

void FILE_LEGACY_STREAM::Close

(

)

Close file if open.

FILE* FILE_LEGACY_STREAM::GetFilePointer

(

)

const [inline]

Get legacy file pointer.

bool FILE_LEGACY_STREAM::IsOpen

(

)

const [inline]

Determine if file is currently open.

ERRVALUE FILE_LEGACY_STREAM::Open	(	const FILEPATH &	filepath,
		TRANSLATION	translation,
		FILE_ACCESS	access = FILE_ACCESS_Read
	)

Open or create specified file.

If file is already open the previous file will be closed.

Parameters:

	filepath	Path to file to be opened or created
	translation	Translation mode
	access	Desired access

FILE_LEGACY_STREAM::operator FILE *

(

)

const [inline]

Cast to legacy "handle".

---

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

• mi32/filelegacy.h