\rhead{\bf MC\_GetAgentStatus()}
\noindent
\vspace{5pt}
\rule{6.5in}{0.015in}
\noindent
{\LARGE \bf MC\_GetAgentStatus()\index{MC\_GetAgentStatus()}}\\
\phantomsection
\addcontentsline{toc}{section}{MC\_GetAgentStatus()}
\label{api:MC_GetAgentStatus}

\noindent
{\bf Synopsis}\\
{\bf \#include $<$libmc.h$>$}\\
{\bf int MC\_GetAgentStatus}({\bf MCAgent\_t} $agent$);\\

\noindent
{\bf Purpose}\\
Get the status of a mobile agent in an agency.\\

\noindent
{\bf Return Value}\\
The return value is of an enumerated type, ``enum MC\_AgentStatus\_e''.
The enum may be seen in Table \vref{mobilec_macro}.
The values are
\vspace{-0.1in}
\begin{description}
\item               
\begin{tabular}{p{55 mm}p{120 mm}}
0 , MC\_WAIT\_CH : & Mobile agent is currently waiting to be executed.\\
1 , MC\_WAIT\_MESSGSEND : & Mobile agent is currently waiting to be exported to another agency.\\
2 , MC\_AGENT\_ACTIVE : & Mobile agent is currently being executed.\\
3 , MC\_AGENT\_NEUTRAL : & Mobile agent is waiting for an unspecified reason.\\
4 , MC\_AGENT\_SUSPENDED : & Mobile agent is currently being suspended.\\ 
5 , MC\_WAIT\_FINISHED : & Mobile agent has finished execution and is waiting for removal.
\end{tabular}
\end{description}

\noindent
{\bf Parameters}
\vspace{-0.1in}
\begin{description}
\item               
\begin{tabular}{p{10 mm}p{145 mm}}
$agent$ & The mobile agent from which to retrieve status information.
\end{tabular}
\end{description}

\noindent
{\bf Description}\\
This function gets a mobile agent's status. 
The status is used to determine the mobile agent's current state of execution.\\

\noindent
{\bf Example}\\
\noindent
{\footnotesize\verbatiminput{../demos/mobilec_c-space_functionality/cspace_misc_examples/server.c}}

\noindent
{\bf See Also}\\

%\CPlot::\DataThreeD(), \CPlot::\DataFile(), \CPlot::\Plotting(), \plotxy().\\
