RVCFILEHANDLE Class Reference

RVCFILEHANDLE class used to encapsulate an "open" RVC file handle. More...

#include <mi32/rvcdefns.h>

List of all members.

Public Member Functions
ERRVALUE	Close ()
bool	IsOpen () const
ERRVALUE	Make (const FILEPATH &filepath, RVCBASICINFO &basicinfo)
ERRVALUE	MakeTemp (UINT32 tempflags=RVCFILE_DeleteOnClose)
ERRVALUE	Open (const FILEPATH &filepath, UINT32 lockflags=RVCFILE_ReadLock, MDLGPARENT dlgparent=0)
	operator int () const
	RVCFILEHANDLE ()
	~RVCFILEHANDLE ()

---

Detailed Description

RVCFILEHANDLE class used to encapsulate an "open" RVC file handle.

The file will be automatically closed when object goes out of scope. A cast operator to "int" is provided so an instance of this class may be passed to any existing function expecting an open file handle.

Deprecated:

Replaced by RVC::OBJECT

Definition at line 2805 of file rvcdefns.h.

---

Constructor & Destructor Documentation

RVCFILEHANDLE::RVCFILEHANDLE (   )  [inline]

Constructor. Definition at line 2809 of file rvcdefns.h.

RVCFILEHANDLE::~RVCFILEHANDLE (   )  [inline]

Destructor. Definition at line 2814 of file rvcdefns.h.

---

Member Function Documentation

ERRVALUE RVCFILEHANDLE::Close (   )  [inline]

Close currently open file. Definition at line 2828 of file rvcdefns.h.

bool RVCFILEHANDLE::IsOpen (   )  const [inline]

Determine if file is currently open. Definition at line 2837 of file rvcdefns.h.

ERRVALUE RVCFILEHANDLE::Make (  const FILEPATH &  filepath, RVCBASICINFO &  basicinfo )  [inline]

Create file, closing previous file if any. If the file already exists it will be erased. Parameters: filepath  File name basicinfo  Basic info Definition at line 2842 of file rvcdefns.h.

ERRVALUE RVCFILEHANDLE::MakeTemp (  UINT32  tempflags = RVCFILE_DeleteOnClose  )  [inline]

Make temporary file, closing previous open file if any. Parameters: tempflags  Flags Definition at line 2852 of file rvcdefns.h.

ERRVALUE RVCFILEHANDLE::Open (  const FILEPATH &  filepath, UINT32  lockflags = RVCFILE_ReadLock, MDLGPARENT  dlgparent = 0 )  [inline]

Open file, closing previous file if any. Parameters: filepath  File name lockflags  Lock flags dlgparent  Parent widget Definition at line 2861 of file rvcdefns.h.

RVCFILEHANDLE::operator int (   )  const [inline]

Cast to int - Returns actual file handle for use in other RVC functions. Definition at line 2822 of file rvcdefns.h.

---

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

• mi32/rvcdefns.h

---