diff options
Diffstat (limited to 'main/minimime/mm-docs/latex/mm__header_8c.tex')
| -rw-r--r-- | main/minimime/mm-docs/latex/mm__header_8c.tex | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/main/minimime/mm-docs/latex/mm__header_8c.tex b/main/minimime/mm-docs/latex/mm__header_8c.tex new file mode 100644 index 000000000..651a5a4e9 --- /dev/null +++ b/main/minimime/mm-docs/latex/mm__header_8c.tex @@ -0,0 +1,63 @@ +\section{mm\_\-header.c File Reference} +\label{mm__header_8c}\index{mm_header.c@{mm\_\-header.c}} +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdarg.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include $<$ctype.h$>$}\par +{\tt \#include $<$assert.h$>$}\par +{\tt \#include \char`\"{}mm\_\-internal.h\char`\"{}}\par +{\tt \#include \char`\"{}mm\_\-util.h\char`\"{}}\par +\subsection*{Functions} +\begin{CompactItemize} +\item +mm\_\-mimeheader $\ast$ {\bf mm\_\-mimeheader\_\-new} (void) +\item +void {\bf mm\_\-mimeheader\_\-free} (struct mm\_\-mimeheader $\ast$header) +\item +mm\_\-mimeheader $\ast$ {\bf mm\_\-mimeheader\_\-generate} (const char $\ast$name, const char $\ast$value) +\item +int \textbf{mm\_\-mimeheader\_\-uncomment} (struct mm\_\-mimeheader $\ast$header)\label{mm__header_8c_26657e44385646fde63712d7110492d7} + +\item +int \textbf{mm\_\-mimeheader\_\-uncommentbyname} (struct mm\_\-mimepart $\ast$part, const char $\ast$name)\label{mm__header_8c_2081ee4c43e88d5a318a783069a5d471} + +\item +int \textbf{mm\_\-mimeheader\_\-uncommentall} (struct mm\_\-mimepart $\ast$part)\label{mm__header_8c_9f9bcb0fb26461bd349c15366748ecb7} + +\end{CompactItemize} + + +\subsection{Detailed Description} +This module contains functions for manipulating MIME headers + +\subsection{Function Documentation} +\index{mm_header.c@{mm\_\-header.c}!mm_mimeheader_free@{mm\_\-mimeheader\_\-free}} +\index{mm_mimeheader_free@{mm\_\-mimeheader\_\-free}!mm_header.c@{mm\_\-header.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void mm\_\-mimeheader\_\-free (struct mm\_\-mimeheader $\ast$ {\em header})}\label{mm__header_8c_61e3e62728f720ac381196ec59303064} + + +Frees a MIME header object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em header}]The MIME header object which to free \end{description} +\end{Desc} +\index{mm_header.c@{mm\_\-header.c}!mm_mimeheader_generate@{mm\_\-mimeheader\_\-generate}} +\index{mm_mimeheader_generate@{mm\_\-mimeheader\_\-generate}!mm_header.c@{mm\_\-header.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}struct mm\_\-mimeheader$\ast$ mm\_\-mimeheader\_\-generate (const char $\ast$ {\em name}, const char $\ast$ {\em value})}\label{mm__header_8c_07a7f7dcebc91aa86f5478e1d84341a1} + + +Creates a new MIME header, but does no checks whatsoever (create as-is) \index{mm_header.c@{mm\_\-header.c}!mm_mimeheader_new@{mm\_\-mimeheader\_\-new}} +\index{mm_mimeheader_new@{mm\_\-mimeheader\_\-new}!mm_header.c@{mm\_\-header.c}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}struct mm\_\-mimeheader$\ast$ mm\_\-mimeheader\_\-new (void)}\label{mm__header_8c_2f2c5f2f640111caf3096ed46b5986a4} + + +Creates a new MIME header object + +\begin{Desc} +\item[Returns:]A new and initialized MIME header object \end{Desc} +\begin{Desc} +\item[See also:]\doxyref{mm\_\-mimeheader\_\-free}{p.}{mm__header_8c_61e3e62728f720ac381196ec59303064}\end{Desc} +This function creates and initializes a new MIME header object, which must later be freed using \doxyref{mm\_\-mimeheader\_\-free()}{p.}{mm__header_8c_61e3e62728f720ac381196ec59303064}
\ No newline at end of file |