blob: c9c49034e46657aba1a86cf29b3b979c3e838188 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
\section{Mini\-MIME error functions}
\label{group__error}\index{MiniMIME error functions@{MiniMIME error functions}}
\subsection*{Functions}
\begin{CompactItemize}
\item
void {\bf mm\_\-error\_\-init} (void)
\item
void {\bf mm\_\-error\_\-setmsg} (const char $\ast$fmt,...)
\item
char $\ast$ {\bf mm\_\-error\_\-string} (void)
\end{CompactItemize}
\subsection{Function Documentation}
\index{error@{error}!mm_error_init@{mm\_\-error\_\-init}}
\index{mm_error_init@{mm\_\-error\_\-init}!error@{error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void mm\_\-error\_\-init (void)}\label{group__error_g69de7c9bee1d535593a55807590de543}
Initializes the global error object
This function initializes the global error object mm\_\-error. This must be done when the library is initialized, and is automatically called from mm\_\-init\_\-library(). \index{error@{error}!mm_error_setmsg@{mm\_\-error\_\-setmsg}}
\index{mm_error_setmsg@{mm\_\-error\_\-setmsg}!error@{error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void mm\_\-error\_\-setmsg (const char $\ast$ {\em fmt}, {\em ...})}\label{group__error_g92006c97728639d8f32f5bc4c6e2a47f}
Sets a descriptive error message
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em fmt}]The error message as format string\end{description}
\end{Desc}
This function is called from the various Mini\-MIME modules in case an error occured. Should never be called by the user. \index{error@{error}!mm_error_string@{mm\_\-error\_\-string}}
\index{mm_error_string@{mm\_\-error\_\-string}!error@{error}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ mm\_\-error\_\-string (void)}\label{group__error_g8654857a3ac349b87d798902912371a3}
Retrieves the current error message
\begin{Desc}
\item[Returns:]The currently set error message\end{Desc}
This function can be used to retrieve a descriptive error message for the current error, much like strerror() function of libc. When this function is called without an error being set, it returns the string \char`\"{}No error\char`\"{}. The string returned does not need to be freed, since it is not dynamically allocated by the library.
|
