\section{Axis\-File Class Reference}
\label{classAxisFile}\index{AxisFile@{AxisFile}}
class for allocating file resources for Axis C++ 


{\tt \#include $<$Axis\-File.h$>$}

\subsection*{Public Methods}
\begin{CompactItemize}
\item 
{\bf Axis\-File} ()
\item 
{\bf Axis\-File} (FILE $\ast$p\-FILEParam\-File)
\item 
int {\bf file\-Open} (const char $\ast$s\-File\-Name, const char $\ast$s\-File\-Perm)
\item 
int {\bf file\-Get} (char $\ast$s\-Line, int i\-Buffer\-Size)
\item 
int {\bf file\-Puts} (const char $\ast$pc\-Write)
\item 
int {\bf file\-Flush} ()
\end{CompactItemize}


\subsection{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 Axis\-File file\-Config; file\-Config.file\-Open(\char`\"{}char$\ast$ file name parameter\char`\"{}, \char`\"{}$<$char$\ast$ file Permission parameter\char`\"{}) file\-Get($<$char$\ast$ line$>$, $<$int buffersize$>$) etc No need to worry about file closing because when file\-Config go out of local scope it's destructor is called and inside it fclose is called

\begin{Desc}
\item[Author: ]\par
Damitha Kumarage ({\tt damitha@opensource.lk}, {\tt damitha@jkcsworld.com}) \end{Desc}




\subsection{Constructor \& Destructor Documentation}
\index{AxisFile@{Axis\-File}!AxisFile@{AxisFile}}
\index{AxisFile@{AxisFile}!AxisFile@{Axis\-File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Axis\-File::Axis\-File ()\hspace{0.3cm}{\tt  [inline]}}\label{classAxisFile_a0}


Default constructor \index{AxisFile@{Axis\-File}!AxisFile@{AxisFile}}
\index{AxisFile@{AxisFile}!AxisFile@{Axis\-File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Axis\-File::Axis\-File (FILE $\ast$ {\em p\-FILEParam\-File})\hspace{0.3cm}{\tt  [inline]}}\label{classAxisFile_a1}


Constructor with one paratmer \begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
pointer}]to a FILE \end{description}
\end{Desc}


\subsection{Member Function Documentation}
\index{AxisFile@{Axis\-File}!fileFlush@{fileFlush}}
\index{fileFlush@{fileFlush}!AxisFile@{Axis\-File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Axis\-File::file\-Flush ()\hspace{0.3cm}{\tt  [inline]}}\label{classAxisFile_a5}


Use this flush the buffer \index{AxisFile@{Axis\-File}!fileGet@{fileGet}}
\index{fileGet@{fileGet}!AxisFile@{Axis\-File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Axis\-File::file\-Get (char $\ast$ {\em s\-Line}, int {\em i\-Buffer\-Size})\hspace{0.3cm}{\tt  [inline]}}\label{classAxisFile_a3}


Use this to read a line from the file \begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
char}]buffer into which line is read \item[{\em 
buffer}]size \end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
error code \end{Desc}
\index{AxisFile@{Axis\-File}!fileOpen@{fileOpen}}
\index{fileOpen@{fileOpen}!AxisFile@{Axis\-File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Axis\-File::file\-Open (const char $\ast$ {\em s\-File\-Name}, const char $\ast$ {\em s\-File\-Perm})\hspace{0.3cm}{\tt  [inline]}}\label{classAxisFile_a2}


Use this to open a file \begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
file}]name \item[{\em 
file}]permission \end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
error code \end{Desc}
\index{AxisFile@{Axis\-File}!filePuts@{filePuts}}
\index{filePuts@{filePuts}!AxisFile@{Axis\-File}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Axis\-File::file\-Puts (const char $\ast$ {\em pc\-Write})\hspace{0.3cm}{\tt  [inline]}}\label{classAxisFile_a4}


Use this to write a line to the file \begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
char}]buffer to be written to the file \end{description}
\end{Desc}


The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
{\bf Axis\-File.h}\end{CompactItemize}
