CBINFilter Class Reference



Your Ad Here

This class supports both the legacy and the new binary format. More...

#include <BINFilter.h>

Inheritance diagram for CBINFilter:

CXSIFilter List of all members.

Public Member Functions
  CBINFilter (bool in_bLegacy)
virtual  ~CBINFilter ()
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 ()

Detailed Description

This class supports both the legacy and the new binary format.

Constructor & Destructor Documentation

CBINFilter ( bool  in_bLegacy  ) 

Constructor

Parameters:
in_bLegacy  (in legacy mode (3.0), we have to read the ENTIRE file in before we can decompress)...

virtual ~CBINFilter (  )  [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.

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

Return to Softimage XSI Index


Your Ad Here