\hypertarget{classBWAPI_1_1Error}{\section{\-B\-W\-A\-P\-I\-:\-:\-Error \-Class \-Reference}
\label{classBWAPI_1_1Error}\index{\-B\-W\-A\-P\-I\-::\-Error@{\-B\-W\-A\-P\-I\-::\-Error}}
}


{\ttfamily \#include $<$\-Error.\-h$>$}



\-Inheritance diagram for \-B\-W\-A\-P\-I\-:\-:\-Error\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=160pt]{classBWAPI_1_1Error__inherit__graph}
\end{center}
\end{figure}


\-Collaboration diagram for \-B\-W\-A\-P\-I\-:\-:\-Error\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=160pt]{classBWAPI_1_1Error__coll__graph}
\end{center}
\end{figure}
\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classBWAPI_1_1Error_a8d6ea68786257fa4ed3c46807e14ef30}{\-Error} ()
\item 
\hyperlink{classBWAPI_1_1Error_a09e77519ed788b5a311fee2375b59294}{\-Error} (\hyperlink{Detours_8h_ab5a791e918b09a41addbf5b813175633}{int} id)
\item 
std\-::string \hyperlink{classBWAPI_1_1Error_a9e748120e40d33a3148598ba57a1e14b}{to\-String} () const 
\item 
const char $\ast$ \hyperlink{classBWAPI_1_1Error_a703e4d57ab6a24b03849ed5cbf6a3287}{c\-\_\-str} () const 
\end{DoxyCompactItemize}


\subsection{\-Detailed \-Description}
\-Functions in \hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} may set an error code. \-To retrieve the error code, call \hyperlink{classBWAPI_1_1Game_aa14c105116d29b94c2afb25c1291fe33}{\-Game\-::get\-Last\-Error}. 

\subsection{\-Constructor \& \-Destructor \-Documentation}
\hypertarget{classBWAPI_1_1Error_a8d6ea68786257fa4ed3c46807e14ef30}{\index{\-B\-W\-A\-P\-I\-::\-Error@{\-B\-W\-A\-P\-I\-::\-Error}!\-Error@{\-Error}}
\index{\-Error@{\-Error}!BWAPI::Error@{\-B\-W\-A\-P\-I\-::\-Error}}
\subsubsection[{\-Error}]{\setlength{\rightskip}{0pt plus 5cm}{\bf \-B\-W\-A\-P\-I\-::\-Error\-::\-Error} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{classBWAPI_1_1Error_a8d6ea68786257fa4ed3c46807e14ef30}
\hypertarget{classBWAPI_1_1Error_a09e77519ed788b5a311fee2375b59294}{\index{\-B\-W\-A\-P\-I\-::\-Error@{\-B\-W\-A\-P\-I\-::\-Error}!\-Error@{\-Error}}
\index{\-Error@{\-Error}!BWAPI::Error@{\-B\-W\-A\-P\-I\-::\-Error}}
\subsubsection[{\-Error}]{\setlength{\rightskip}{0pt plus 5cm}{\bf \-B\-W\-A\-P\-I\-::\-Error\-::\-Error} (
\begin{DoxyParamCaption}
\item[{{\bf int}}]{id}
\end{DoxyParamCaption}
)}}\label{classBWAPI_1_1Error_a09e77519ed788b5a311fee2375b59294}


\subsection{\-Member \-Function \-Documentation}
\hypertarget{classBWAPI_1_1Error_a703e4d57ab6a24b03849ed5cbf6a3287}{\index{\-B\-W\-A\-P\-I\-::\-Error@{\-B\-W\-A\-P\-I\-::\-Error}!c\-\_\-str@{c\-\_\-str}}
\index{c\-\_\-str@{c\-\_\-str}!BWAPI::Error@{\-B\-W\-A\-P\-I\-::\-Error}}
\subsubsection[{c\-\_\-str}]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ {\bf \-B\-W\-A\-P\-I\-::\-Error\-::c\-\_\-str} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{classBWAPI_1_1Error_a703e4d57ab6a24b03849ed5cbf6a3287}


\-Here is the call graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=328pt]{classBWAPI_1_1Error_a703e4d57ab6a24b03849ed5cbf6a3287_cgraph}
\end{center}
\end{figure}




\-Here is the caller graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classBWAPI_1_1Error_a703e4d57ab6a24b03849ed5cbf6a3287_icgraph}
\end{center}
\end{figure}


\hypertarget{classBWAPI_1_1Error_a9e748120e40d33a3148598ba57a1e14b}{\index{\-B\-W\-A\-P\-I\-::\-Error@{\-B\-W\-A\-P\-I\-::\-Error}!to\-String@{to\-String}}
\index{to\-String@{to\-String}!BWAPI::Error@{\-B\-W\-A\-P\-I\-::\-Error}}
\subsubsection[{to\-String}]{\setlength{\rightskip}{0pt plus 5cm}std\-::string {\bf \-B\-W\-A\-P\-I\-::\-Error\-::to\-String} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{classBWAPI_1_1Error_a9e748120e40d33a3148598ba57a1e14b}
\-Returns the name of the error. \-For example \hyperlink{namespaceBWAPI_1_1Errors_a5cc7859dfb875074e3af9f0a2884a2a6}{\-Errors\-::\-Insufficient\-\_\-\-Minerals}?.\hyperlink{classBWAPI_1_1Error_a9e748120e40d33a3148598ba57a1e14b}{to\-String()} will return a std\-::string object containing \char`\"{}\-Insufficient Minerals\char`\"{}. 

\-Here is the call graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=340pt]{classBWAPI_1_1Error_a9e748120e40d33a3148598ba57a1e14b_cgraph}
\end{center}
\end{figure}




\-Here is the caller graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classBWAPI_1_1Error_a9e748120e40d33a3148598ba57a1e14b_icgraph}
\end{center}
\end{figure}




\-The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
trunk/bwapi/include/\-B\-W\-A\-P\-I/\hyperlink{Error_8h}{\-Error.\-h}\item 
trunk/bwapi/\-B\-W\-A\-P\-I\-L\-I\-B/\-Source/\hyperlink{Error_8cpp}{\-Error.\-cpp}\end{DoxyCompactItemize}
