\doxysection{Dwarf\+\_\+\+Error Functions }
\hypertarget{group__dwarferror}{}\label{group__dwarferror}\index{Dwarf\_Error Functions@{Dwarf\_Error Functions}}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
DW\+\_\+\+API \doxymbox{\hyperlink{group__basicdatatypes_ga5de64bb9627534a24dcbccc327916265}{Dwarf\+\_\+\+Unsigned}} \doxymbox{\hyperlink{group__dwarferror_ga494aa4910e76c78c8e39de5003f30853}{dwarf\+\_\+errno}} (\doxymbox{\hyperlink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error}} dw\+\_\+error)
\begin{DoxyCompactList}\small\item\em What DW\+\_\+\+DLE code does the error have? \end{DoxyCompactList}\item 
DW\+\_\+\+API char \texorpdfstring{$\ast$}{*} \doxymbox{\hyperlink{group__dwarferror_ga61e9111a5ffc64b7e4cb338e3ed07f6e}{dwarf\+\_\+errmsg}} (\doxymbox{\hyperlink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error}} dw\+\_\+error)
\begin{DoxyCompactList}\small\item\em What message string is in the error? \end{DoxyCompactList}\item 
DW\+\_\+\+API char \texorpdfstring{$\ast$}{*} \doxymbox{\hyperlink{group__dwarferror_ga92a849f720ead9cf9cd84b51ccc1b983}{dwarf\+\_\+errmsg\+\_\+by\+\_\+number}} (\doxymbox{\hyperlink{group__basicdatatypes_ga5de64bb9627534a24dcbccc327916265}{Dwarf\+\_\+\+Unsigned}} dw\+\_\+errornum)
\begin{DoxyCompactList}\small\item\em What message string is associated with the error number. \end{DoxyCompactList}\item 
DW\+\_\+\+API void \doxymbox{\hyperlink{group__dwarferror_ga3f529bb627eb7a47b511704e2bf96f56}{dwarf\+\_\+error\+\_\+creation}} (\doxymbox{\hyperlink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}} dw\+\_\+dbg, \doxymbox{\hyperlink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error}} \texorpdfstring{$\ast$}{*}dw\+\_\+error, char \texorpdfstring{$\ast$}{*}dw\+\_\+errmsg)
\begin{DoxyCompactList}\small\item\em Creating an error. This is very rarely helpful. It lets the library user create a \doxylink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error} and associate any string with that error. Your code could then return DW\+\_\+\+DLV\+\_\+\+ERROR to your caller when your intent is to let your caller clean up whatever seems wrong. \end{DoxyCompactList}\item 
DW\+\_\+\+API void \doxymbox{\hyperlink{group__dwarferror_gaa6b5e63031b88831d0f40051f7f3e1c8}{dwarf\+\_\+dealloc\+\_\+error}} (\doxymbox{\hyperlink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}} dw\+\_\+dbg, \doxymbox{\hyperlink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error}} dw\+\_\+error)
\begin{DoxyCompactList}\small\item\em Free (dealloc) an \doxylink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error} something created. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
These functions aid in understanding handling. 

\label{doc-func-members}
\Hypertarget{group__dwarferror_doc-func-members}
\doxysubsection{Function Documentation}
\Hypertarget{group__dwarferror_gaa6b5e63031b88831d0f40051f7f3e1c8}\index{Dwarf\_Error Functions@{Dwarf\_Error Functions}!dwarf\_dealloc\_error@{dwarf\_dealloc\_error}}
\index{dwarf\_dealloc\_error@{dwarf\_dealloc\_error}!Dwarf\_Error Functions@{Dwarf\_Error Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_dealloc\_error()}{dwarf\_dealloc\_error()}}
{\footnotesize\ttfamily \label{group__dwarferror_gaa6b5e63031b88831d0f40051f7f3e1c8} 
DW\+\_\+\+API void dwarf\+\_\+dealloc\+\_\+error (\begin{DoxyParamCaption}\item[{\doxymbox{\hyperlink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}}}]{dw\+\_\+dbg}{, }\item[{\doxymbox{\hyperlink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error}}}]{dw\+\_\+error}{}\end{DoxyParamCaption})}



Free (dealloc) an \doxylink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error} something created. 


\begin{DoxyParams}{Parameters}
{\em dw\+\_\+dbg} & The relevant \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug} pointer. \\
\hline
{\em dw\+\_\+error} & A pointer to a \doxylink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error}. The pointer is then stale so you should immediately zero that pointer passed in. \\
\hline
\end{DoxyParams}
\Hypertarget{group__dwarferror_ga61e9111a5ffc64b7e4cb338e3ed07f6e}\index{Dwarf\_Error Functions@{Dwarf\_Error Functions}!dwarf\_errmsg@{dwarf\_errmsg}}
\index{dwarf\_errmsg@{dwarf\_errmsg}!Dwarf\_Error Functions@{Dwarf\_Error Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_errmsg()}{dwarf\_errmsg()}}
{\footnotesize\ttfamily \label{group__dwarferror_ga61e9111a5ffc64b7e4cb338e3ed07f6e} 
DW\+\_\+\+API char \texorpdfstring{$\ast$}{*} dwarf\+\_\+errmsg (\begin{DoxyParamCaption}\item[{\doxymbox{\hyperlink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error}}}]{dw\+\_\+error}{}\end{DoxyParamCaption})}



What message string is in the error? 


\begin{DoxyParams}{Parameters}
{\em dw\+\_\+error} & The dw\+\_\+error should be non-\/null and a valid \doxylink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A string with a message related to the error. 
\end{DoxyReturn}
\Hypertarget{group__dwarferror_ga92a849f720ead9cf9cd84b51ccc1b983}\index{Dwarf\_Error Functions@{Dwarf\_Error Functions}!dwarf\_errmsg\_by\_number@{dwarf\_errmsg\_by\_number}}
\index{dwarf\_errmsg\_by\_number@{dwarf\_errmsg\_by\_number}!Dwarf\_Error Functions@{Dwarf\_Error Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_errmsg\_by\_number()}{dwarf\_errmsg\_by\_number()}}
{\footnotesize\ttfamily \label{group__dwarferror_ga92a849f720ead9cf9cd84b51ccc1b983} 
DW\+\_\+\+API char \texorpdfstring{$\ast$}{*} dwarf\+\_\+errmsg\+\_\+by\+\_\+number (\begin{DoxyParamCaption}\item[{\doxymbox{\hyperlink{group__basicdatatypes_ga5de64bb9627534a24dcbccc327916265}{Dwarf\+\_\+\+Unsigned}}}]{dw\+\_\+errornum}{}\end{DoxyParamCaption})}



What message string is associated with the error number. 


\begin{DoxyParams}{Parameters}
{\em dw\+\_\+errornum} & The dw\+\_\+error should be an integer from the DW\+\_\+\+DLE set. For example, DW\+\_\+\+DLE\+\_\+\+DIE\+\_\+\+NULL. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The generic string describing that error number. 
\end{DoxyReturn}
\Hypertarget{group__dwarferror_ga494aa4910e76c78c8e39de5003f30853}\index{Dwarf\_Error Functions@{Dwarf\_Error Functions}!dwarf\_errno@{dwarf\_errno}}
\index{dwarf\_errno@{dwarf\_errno}!Dwarf\_Error Functions@{Dwarf\_Error Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_errno()}{dwarf\_errno()}}
{\footnotesize\ttfamily \label{group__dwarferror_ga494aa4910e76c78c8e39de5003f30853} 
DW\+\_\+\+API \doxymbox{\hyperlink{group__basicdatatypes_ga5de64bb9627534a24dcbccc327916265}{Dwarf\+\_\+\+Unsigned}} dwarf\+\_\+errno (\begin{DoxyParamCaption}\item[{\doxymbox{\hyperlink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error}}}]{dw\+\_\+error}{}\end{DoxyParamCaption})}



What DW\+\_\+\+DLE code does the error have? 


\begin{DoxyParams}{Parameters}
{\em dw\+\_\+error} & The dw\+\_\+error should be non-\/null and a valid \doxylink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A DW\+\_\+\+DLE value of some kind. For example:\+ DW\+\_\+\+DLE\+\_\+\+DIE\+\_\+\+NULL. 
\end{DoxyReturn}
\Hypertarget{group__dwarferror_ga3f529bb627eb7a47b511704e2bf96f56}\index{Dwarf\_Error Functions@{Dwarf\_Error Functions}!dwarf\_error\_creation@{dwarf\_error\_creation}}
\index{dwarf\_error\_creation@{dwarf\_error\_creation}!Dwarf\_Error Functions@{Dwarf\_Error Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_error\_creation()}{dwarf\_error\_creation()}}
{\footnotesize\ttfamily \label{group__dwarferror_ga3f529bb627eb7a47b511704e2bf96f56} 
DW\+\_\+\+API void dwarf\+\_\+error\+\_\+creation (\begin{DoxyParamCaption}\item[{\doxymbox{\hyperlink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}}}]{dw\+\_\+dbg}{, }\item[{\doxymbox{\hyperlink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error}} \texorpdfstring{$\ast$}{*}}]{dw\+\_\+error}{, }\item[{char \texorpdfstring{$\ast$}{*}}]{dw\+\_\+errmsg}{}\end{DoxyParamCaption})}



Creating an error. This is very rarely helpful. It lets the library user create a \doxylink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error} and associate any string with that error. Your code could then return DW\+\_\+\+DLV\+\_\+\+ERROR to your caller when your intent is to let your caller clean up whatever seems wrong. 


\begin{DoxyParams}{Parameters}
{\em dw\+\_\+dbg} & The relevant \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}. \\
\hline
{\em dw\+\_\+error} & a \doxylink{group__allstructs_ga8d4fac0e48040b6ca91e06ffda09766a}{Dwarf\+\_\+\+Error} is returned through this pointer. \\
\hline
{\em dw\+\_\+errmsg} & The message string you provide. \\
\hline
\end{DoxyParams}
