CMemoryFilter Class Reference

Memory filter. More...

#include <MemoryFilter.h>

Inheritance diagram for CMemoryFilter:

CXSIFilter List of all members.

Public Member Functions
  CMemoryFilter ()
virtual  ~CMemoryFilter ()
int  Open (CSIBCString in_szFilename, _SI_FILE_MODE in_Mode)
int  Close ()
int  Read (SI_Char *out_pBuffer, SI_Long in_lSize)
int  Write (SI_Char *in_pBuffer, SI_Long in_lSize)
int  Eof ()
int  Tell ()
void  WriteHeader ()
void  SetHeader (CSIBCString in_szHeader)
CSIBCString  GetHeader ()

Detailed Description

Memory filter.

Constructor & Destructor Documentation

CMemoryFilter (  ) 

Constructor

virtual ~CMemoryFilter (  )  [virtual]

Destructor

Member Function Documentation

int Open ( CSIBCString  in_szFilename,
_SI_FILE_MODE  in_Mode  
) [virtual]

Opens the file for either reading or writing

Parameters:
in_szFilename  Filename
in_Mode  mode

Reimplemented from CXSIFilter.

int Close (  )  [virtual]

Closes the file when finished

Reimplemented from CXSIFilter.

int Read ( SI_Char *  out_pBuffer,
SI_Long  in_lSize  
) [virtual]

Reads a number of bytes into the buffer passed in.

Parameters:
out_pBuffer  output buffer
in_lSize  number of bytes to read
Returns:
int number of bytes read.

Reimplemented from CXSIFilter.

int Write ( SI_Char *  in_pBuffer,
SI_Long  in_lSize  
) [virtual]

Writes a number of bytes to the file

Parameters:
in_pBuffer  input buffer
in_lSize  number of bytes to write
Returns:
int number of bytes written

Reimplemented from CXSIFilter.

int Eof (  )  [virtual]

Tests whether we have reached the end of file

Returns:
int flag for end of file (1 - end of file, 0 - not end of file)

Reimplemented from CXSIFilter.

int Tell (  )  [virtual]

Returns the current position in the file.

Returns:
int position in the file (0 - beginning)

Reimplemented from CXSIFilter.

void WriteHeader (  )  [virtual]

Writes out the header, this is called when we are about to write the file, to make sure the header is the first thing written in the file.

Reimplemented from CXSIFilter.

void SetHeader ( CSIBCString  in_szHeader  )  [virtual]

Sets the header to be used for the file ("xsi 0360txt") for example

Parameters:
in_szHeader  header

Reimplemented from CXSIFilter.

CSIBCString GetHeader (  )  [inline]

returns the current header

Returns:
SIBCString Header

Reimplemented from CXSIFilter.

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