Main Page   Class Hierarchy   Compound List   File List   Compound Members   Examples  

AxisFile Class Reference

class for allocating file resources for Axis C++ More...

#include <AxisFile.h>

List of all members.

Public Methods

 AxisFile ()
 AxisFile (FILE *pFILEParamFile)
int fileOpen (const char *sFileName, const char *sFilePerm)
int fileGet (char *sLine, int iBufferSize)
int filePuts (const char *pcWrite)
int fileFlush ()


Detailed Description

class for allocating file resources for Axis C++

The purpose of this class is to provide a mechanism which allows Axis C++ to use file resources without worrying about releasing resources. How to use this class: When you need the file resource inside a method do as following AxisFile fileConfig; fileConfig.fileOpen("char* file name parameter", "<char* file Permission parameter") fileGet(<char* line>, <int buffersize>) etc No need to worry about file closing because when fileConfig go out of local scope it's destructor is called and inside it fclose is called

Author:
Damitha Kumarage (damitha@opensource.lk, damitha@jkcsworld.com)


Constructor & Destructor Documentation

AxisFile::AxisFile   [inline]
 

Default constructor

AxisFile::AxisFile FILE *    pFILEParamFile [inline]
 

Constructor with one paratmer

Parameters:
pointer  to a FILE


Member Function Documentation

int AxisFile::fileFlush   [inline]
 

Use this flush the buffer

int AxisFile::fileGet char *    sLine,
int    iBufferSize
[inline]
 

Use this to read a line from the file

Parameters:
char  buffer into which line is read
buffer  size
Returns:
error code

int AxisFile::fileOpen const char *    sFileName,
const char *    sFilePerm
[inline]
 

Use this to open a file

Parameters:
file  name
file  permission
Returns:
error code

int AxisFile::filePuts const char *    pcWrite [inline]
 

Use this to write a line to the file

Parameters:
char  buffer to be written to the file


The documentation for this class was generated from the following file:
Generated on Tue Jun 15 19:13:24 2004 for axiscpp by doxygen1.2.18