CSIBCFileRam Class Reference

This class implements a memory file object. More...

#include <SIBCFileRam.h>

List of all members.

Public Member Functions
  CSIBCFileRam ()
  CSIBCFileRam (SI_Char *pFileName, _SI_FILE_MODE pAccessRights, void *pMemoryBlock, SI_Int nMemorySize)
  ~CSIBCFileRam ()
SI_Void  Init ()
SI_Bool  IsValid ()
SI_Void  Open (SI_Char *pFileName, _SI_FILE_MODE pAccessRights, SI_Void *pMemoryBlock, SI_Int nMemorySize)
SI_Void  Close ()
SI_Int  Read (void *pDest, SI_Int nDestSize, SI_Int nCount)

Detailed Description

This class implements a memory file object.

Constructor & Destructor Documentation

CSIBCFileRam (  )  [inline]

Constructor

Returns:
An instance of CSIBCFileRam

CSIBCFileRam ( SI_Char *  pFileName,
_SI_FILE_MODE  pAccessRights,
void *  pMemoryBlock,
SI_Int  nMemorySize  
) [inline]

Constructor with user specified parameters

Parameters:
[in]  pFileName  pointer to a character array storing the file name
[in]  pAccessRights  file access modes:
  • __SI_FILE_READ_TEXT : opens a text file in read mode
  • __SI_FILE_READ_BINARY : opens a binary file in read mode
  • __SI_FILE_WRITE_TEXT : unsupported mode
  • __SI_FILE_WRITE_BINARY : unsupported mode
[in]  pMemoryBlock  pointer to the read/write memory block to use
[in]  nMemorySize  size of the memory block

~CSIBCFileRam (  )  [inline]

Destructor

Member Function Documentation

SI_Void Init (  )  [inline]

Sets a CSIBCFileRam instance default values

SI_Bool IsValid (  )  [inline]

Checks if the memory file object is valid

Return values:
SI_Bool::TRUE  memory file object is valid
SI_Bool::FALSE  memory file object is invalid

SI_Void Open ( SI_Char *  pFileName,
_SI_FILE_MODE  pAccessRights,
SI_Void *  pMemoryBlock,
SI_Int  nMemorySize  
) [inline]

Opens a memory file

Parameters:
[in]  pFileName  Pointer to a character array storing the name of the file.
[in]  pAccessRights  Pointer to access rights.
[in]  pMemoryBlock  Pointer to a memory block.
[in]  nMemorySize  the memory block size.

SI_Void Close (  )  [inline]

Close the memory file

SI_Int Read ( void *  pDest,
SI_Int  nDestSize,
SI_Int  nCount  
) [inline]

Read from the open memory file

Parameters:
[in]  pDest  Pointer to the read buffer
[in]  nDestSize  size in bytes of the buffer element
[in]  nCount  counts how many items have been read
Returns:
The percentage of the file read

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