\hypertarget{retrieve_8c}{
\section{retrieve.c File Reference}
\label{retrieve_8c}\index{retrieve.c@{retrieve.c}}
}
Function to retrieve and IMM from LSF datagram contributions. 

{\tt \#include \char`\"{}RIM/record.h\char`\"{}}\par
{\tt \#include \char`\"{}RIM/error.h\char`\"{}}\par
{\tt \#include \char`\"{}AG\_\-init\-RIM\_\-p.h\char`\"{}}\par
{\tt \#include \char`\"{}descriptions.ic\char`\"{}}\par
{\tt \#include \char`\"{}number.ic\char`\"{}}\par
{\tt \#include $<$string.h$>$}\par


Include dependency graph for retrieve.c:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=351pt]{retrieve_8c__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
unsigned \hyperlink{retrieve_8c_a0}{RIM\_\-retrieve} (\hyperlink{rim_8h_a0}{RIM} $\ast$rim, char $\ast$dat, size\_\-t len, unsigned id, int verb)
\begin{CompactList}\small\item\em Recover a portion of the RIM from a data buffer (actually an LSF contribution). \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Function to retrieve and IMM from LSF datagram contributions. 

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


\subsection{Function Documentation}
\hypertarget{retrieve_8c_a0}{
\index{retrieve.c@{retrieve.c}!RIM_retrieve@{RIM\_\-retrieve}}
\index{RIM_retrieve@{RIM\_\-retrieve}!retrieve.c@{retrieve.c}}
\subsubsection[RIM\_\-retrieve]{\setlength{\rightskip}{0pt plus 5cm}unsigned RIM\_\-retrieve (\hyperlink{rim_8h_a0}{RIM} $\ast$ {\em rim}, char $\ast$ {\em dat}, size\_\-t {\em len}, unsigned {\em id}, int {\em verb})}}
\label{retrieve_8c_a0}


Recover a portion of the RIM from a data buffer (actually an LSF contribution). 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em rim}]Pointer to the RIM to populate \item[{\em dat}]Pointer to a block of data to use \item[{\em len}]Length of the data \item[{\em id}]Contribution identfier \item[{\em verb}]1 - print information messages, 0 - don't \end{description}
\end{Desc}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em RIM\_\-TYPE\_\-UK}]If the type ID in the contribution indicates a component type that does not have configuration data \item[{\em RIM\_\-MAP\_\-NONE}]If the type ID in the contribution indicates a component map for a single component \item[{\em RIM\_\-BUF\_\-SHORT}]If the contribution is too short to contain the specified data \item[{\em RIM\_\-SUCCESSS}]If the contribution is successfully handled\end{description}
\end{Desc}