FILE_RAW Class Reference

Class for platform-independent "raw" file read/write. More...

#include <mi32/fileraw.h>

Inheritance diagram for FILE_RAW:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FILE_RAW ()
virtual ~FILE_RAW ()
void Close ()
bool GetPath (FILEPATH &path) const
bool IsOpen () const
ERRVALUE Open (const FILEPATH &filepath, FILE_ACCESS access=FILE_ACCESS_Read, FILE_SHARE share=FILE_SHARE_Any)

Detailed Description

Class for platform-independent "raw" file read/write.


Constructor & Destructor Documentation

FILE_RAW::FILE_RAW (  ) 

Default constructor.

virtual FILE_RAW::~FILE_RAW (  )  [virtual]

Destructor, closes file if open.


Member Function Documentation

void FILE_RAW::Close (  ) 

Close file if open.

bool FILE_RAW::GetPath ( FILEPATH path  )  const

Get current path if file is open.

Returns:
'true' if open, 'false' if not.
Parameters:
path Path returned
bool FILE_RAW::IsOpen (  )  const

Determine if file is currently open.

ERRVALUE FILE_RAW::Open ( const FILEPATH filepath,
FILE_ACCESS  access = FILE_ACCESS_Read,
FILE_SHARE  share = FILE_SHARE_Any 
)

Open or create specified file.

If file is already open the previous file will be closed. If file is on a network file system, 'share' is treated as 'FILE_SHARE_Any', regardless of parameter setting. If a share mechanism is needed, you will need to implement your own scheme.

Parameters:
filepath Path to file to be opened or created
access Desired access
share Sharing mode

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

Generated on Sun Oct 7 21:33:21 2012 for TNTsdk 2012 by  doxygen 1.6.1