\hypertarget{fo_8c}{
\section{fo.c File Reference}
\label{fo_8c}\index{fo.c@{fo.c}}
}
Wrapper functions to stdio calls for creating a file. 

{\tt \#include \char`\"{}fo\_\-p.h\char`\"{}}\par
{\tt \#include \char`\"{}error.h\char`\"{}}\par
{\tt \#include \char`\"{}PBS/BSWP.h\char`\"{}}\par
{\tt \#include $<$string.h$>$}\par
{\tt \#include $<$sys/types.h$>$}\par
{\tt \#include $<$sys/stat.h$>$}\par
{\tt \#include $<$fcntl.h$>$}\par
{\tt \#include $<$unistd.h$>$}\par


Include dependency graph for fo.c:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=198pt]{fo_8c__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
unsigned \hyperlink{fo_8c_a0}{file\_\-create} (int $\ast$fd, const char $\ast$name)
\begin{CompactList}\small\item\em Create a new file and insert version information. \item\end{CompactList}\item 
unsigned \hyperlink{fo_8c_a1}{file\_\-finish} (int fd)
\begin{CompactList}\small\item\em Closes the file. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Wrapper functions to stdio calls for creating a file. 

\begin{Desc}
\item[Author:]James Swain -- \href{mailto:jswain@slac.stanford.edu}{\tt jswain@slac.stanford.edu}\end{Desc}


\subsection{Function Documentation}
\hypertarget{fo_8c_a0}{
\index{fo.c@{fo.c}!file_create@{file\_\-create}}
\index{file_create@{file\_\-create}!fo.c@{fo.c}}
\subsubsection[file\_\-create]{\setlength{\rightskip}{0pt plus 5cm}unsigned file\_\-create (int $\ast$ {\em fd}, const char $\ast$ {\em name})}}
\label{fo_8c_a0}


Create a new file and insert version information. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em fd}]Pointer to the location to place the file descriptor \item[{\em name}]Full pathname of the file to open \end{description}
\end{Desc}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em QCFG\_\-SUCCESS}]if the file opens successfully for writing \item[{\em RIM\_\-FILE\_\-WRITE}]if writing the version information to the file fails \item[{\em RIM\_\-FILE\_\-OPEN}]if the file fails to open\end{description}
\end{Desc}
\hypertarget{fo_8c_a1}{
\index{fo.c@{fo.c}!file_finish@{file\_\-finish}}
\index{file_finish@{file\_\-finish}!fo.c@{fo.c}}
\subsubsection[file\_\-finish]{\setlength{\rightskip}{0pt plus 5cm}unsigned file\_\-finish (int {\em fd})}}
\label{fo_8c_a1}


Closes the file. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em fd}]File descriptor of the file to close \end{description}
\end{Desc}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em RIM\_\-FILE\_\-CLOSE}]if the file close failed \item[{\em QCFG\_\-SUCCESS}]if all goes well\end{description}
\end{Desc}