aboutsummaryrefslogtreecommitdiffstats
path: root/vnfs/VES5.0/doxygen-1.8.12/html/examples/structcmd/latex/structcmd_8h.tex
diff options
context:
space:
mode:
Diffstat (limited to 'vnfs/VES5.0/doxygen-1.8.12/html/examples/structcmd/latex/structcmd_8h.tex')
-rw-r--r--vnfs/VES5.0/doxygen-1.8.12/html/examples/structcmd/latex/structcmd_8h.tex153
1 files changed, 153 insertions, 0 deletions
diff --git a/vnfs/VES5.0/doxygen-1.8.12/html/examples/structcmd/latex/structcmd_8h.tex b/vnfs/VES5.0/doxygen-1.8.12/html/examples/structcmd/latex/structcmd_8h.tex
new file mode 100644
index 00000000..7c716df2
--- /dev/null
+++ b/vnfs/VES5.0/doxygen-1.8.12/html/examples/structcmd/latex/structcmd_8h.tex
@@ -0,0 +1,153 @@
+\hypertarget{structcmd_8h}{}\subsection{structcmd.\+h File Reference}
+\label{structcmd_8h}\index{structcmd.\+h@{structcmd.\+h}}
+
+
+A Documented file.
+
+
+\subsubsection*{Macros}
+\begin{DoxyCompactItemize}
+\item
+\#define \hyperlink{structcmd_8h_afa99ec4acc4ecb2dc3c2d05da15d0e3f}{M\+AX}(a, b)~(((a)$>$(b))?(a)\+:(b))
+\begin{DoxyCompactList}\small\item\em A macro that returns the maximum of {\itshape a} and {\itshape b}. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsubsection*{Typedefs}
+\begin{DoxyCompactItemize}
+\item
+typedef unsigned int \hyperlink{structcmd_8h_ae1e6edbbc26d6fbc71a90190d0266018}{U\+I\+N\+T32}
+\begin{DoxyCompactList}\small\item\em A type definition for a . \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsubsection*{Functions}
+\begin{DoxyCompactItemize}
+\item
+int \hyperlink{structcmd_8h_a2c4414339f388561554c2deab11a1a07}{open} (const char $\ast$, int)
+\begin{DoxyCompactList}\small\item\em Opens a file descriptor. \end{DoxyCompactList}\item
+int \hyperlink{structcmd_8h_ae152484c890a24e4d9b4980e7b965be0}{close} (int)
+\begin{DoxyCompactList}\small\item\em Closes the file descriptor {\itshape fd}. \end{DoxyCompactList}\item
+size\+\_\+t \hyperlink{structcmd_8h_af2a3ea719b83f672637febdd87c36c36}{write} (int, const char $\ast$, size\+\_\+t)
+\begin{DoxyCompactList}\small\item\em Writes {\itshape count} bytes from {\itshape buf} to the filedescriptor {\itshape fd}. \end{DoxyCompactList}\item
+int \hyperlink{structcmd_8h_a9c7b76d5266903891c803132d51ccb90}{read} (int, char $\ast$, size\+\_\+t)
+\begin{DoxyCompactList}\small\item\em Read bytes from a file descriptor. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsubsection*{Variables}
+\begin{DoxyCompactItemize}
+\item
+int \hyperlink{structcmd_8h_ad65a8842cc674e3ddf69355898c0ecbf}{errno}
+\begin{DoxyCompactList}\small\item\em Contains the last error code. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsubsection{Detailed Description}
+A Documented file.
+
+Details.
+
+\subsubsection{Macro Definition Documentation}
+\hypertarget{structcmd_8h_afa99ec4acc4ecb2dc3c2d05da15d0e3f}{}\label{structcmd_8h_afa99ec4acc4ecb2dc3c2d05da15d0e3f}
+\index{structcmd.\+h@{structcmd.\+h}!M\+AX@{M\+AX}}
+\index{M\+AX@{M\+AX}!structcmd.\+h@{structcmd.\+h}}
+\paragraph{\texorpdfstring{M\+AX}{MAX}}
+{\footnotesize\ttfamily \#define M\+AX(\begin{DoxyParamCaption}\item[{}]{a, }\item[{}]{b }\end{DoxyParamCaption})~(((a)$>$(b))?(a)\+:(b))}
+
+
+
+A macro that returns the maximum of {\itshape a} and {\itshape b}.
+
+Details.
+
+\subsubsection{Typedef Documentation}
+\hypertarget{structcmd_8h_ae1e6edbbc26d6fbc71a90190d0266018}{}\label{structcmd_8h_ae1e6edbbc26d6fbc71a90190d0266018}
+\index{structcmd.\+h@{structcmd.\+h}!U\+I\+N\+T32@{U\+I\+N\+T32}}
+\index{U\+I\+N\+T32@{U\+I\+N\+T32}!structcmd.\+h@{structcmd.\+h}}
+\paragraph{\texorpdfstring{U\+I\+N\+T32}{UINT32}}
+{\footnotesize\ttfamily typedef unsigned int \hyperlink{structcmd_8h_ae1e6edbbc26d6fbc71a90190d0266018}{U\+I\+N\+T32}}
+
+
+
+A type definition for a .
+
+Details.
+
+\subsubsection{Function Documentation}
+\hypertarget{structcmd_8h_ae152484c890a24e4d9b4980e7b965be0}{}\label{structcmd_8h_ae152484c890a24e4d9b4980e7b965be0}
+\index{structcmd.\+h@{structcmd.\+h}!close@{close}}
+\index{close@{close}!structcmd.\+h@{structcmd.\+h}}
+\paragraph{\texorpdfstring{close()}{close()}}
+{\footnotesize\ttfamily int close (\begin{DoxyParamCaption}\item[{int}]{fd }\end{DoxyParamCaption})}
+
+
+
+Closes the file descriptor {\itshape fd}.
+
+
+\begin{DoxyParams}{Parameters}
+{\em fd} & The descriptor to close. \\
+\hline
+\end{DoxyParams}
+\hypertarget{structcmd_8h_a2c4414339f388561554c2deab11a1a07}{}\label{structcmd_8h_a2c4414339f388561554c2deab11a1a07}
+\index{structcmd.\+h@{structcmd.\+h}!open@{open}}
+\index{open@{open}!structcmd.\+h@{structcmd.\+h}}
+\paragraph{\texorpdfstring{open()}{open()}}
+{\footnotesize\ttfamily int open (\begin{DoxyParamCaption}\item[{const char $\ast$}]{pathname, }\item[{int}]{flags }\end{DoxyParamCaption})}
+
+
+
+Opens a file descriptor.
+
+
+\begin{DoxyParams}{Parameters}
+{\em pathname} & The name of the descriptor. \\
+\hline
+{\em flags} & Opening flags. \\
+\hline
+\end{DoxyParams}
+\hypertarget{structcmd_8h_a9c7b76d5266903891c803132d51ccb90}{}\label{structcmd_8h_a9c7b76d5266903891c803132d51ccb90}
+\index{structcmd.\+h@{structcmd.\+h}!read@{read}}
+\index{read@{read}!structcmd.\+h@{structcmd.\+h}}
+\paragraph{\texorpdfstring{read()}{read()}}
+{\footnotesize\ttfamily int read (\begin{DoxyParamCaption}\item[{int}]{fd, }\item[{char $\ast$}]{buf, }\item[{size\+\_\+t}]{count }\end{DoxyParamCaption})}
+
+
+
+Read bytes from a file descriptor.
+
+
+\begin{DoxyParams}{Parameters}
+{\em fd} & The descriptor to read from. \\
+\hline
+{\em buf} & The buffer to read into. \\
+\hline
+{\em count} & The number of bytes to read. \\
+\hline
+\end{DoxyParams}
+\hypertarget{structcmd_8h_af2a3ea719b83f672637febdd87c36c36}{}\label{structcmd_8h_af2a3ea719b83f672637febdd87c36c36}
+\index{structcmd.\+h@{structcmd.\+h}!write@{write}}
+\index{write@{write}!structcmd.\+h@{structcmd.\+h}}
+\paragraph{\texorpdfstring{write()}{write()}}
+{\footnotesize\ttfamily size\+\_\+t write (\begin{DoxyParamCaption}\item[{int}]{fd, }\item[{const char $\ast$}]{buf, }\item[{size\+\_\+t}]{count }\end{DoxyParamCaption})}
+
+
+
+Writes {\itshape count} bytes from {\itshape buf} to the filedescriptor {\itshape fd}.
+
+
+\begin{DoxyParams}{Parameters}
+{\em fd} & The descriptor to write to. \\
+\hline
+{\em buf} & The data buffer to write. \\
+\hline
+{\em count} & The number of bytes to write. \\
+\hline
+\end{DoxyParams}
+
+
+\subsubsection{Variable Documentation}
+\hypertarget{structcmd_8h_ad65a8842cc674e3ddf69355898c0ecbf}{}\label{structcmd_8h_ad65a8842cc674e3ddf69355898c0ecbf}
+\index{structcmd.\+h@{structcmd.\+h}!errno@{errno}}
+\index{errno@{errno}!structcmd.\+h@{structcmd.\+h}}
+\paragraph{\texorpdfstring{errno}{errno}}
+{\footnotesize\ttfamily int errno}
+
+
+
+Contains the last error code.
+
+\begin{DoxyWarning}{Warning}
+Not thread safe!
+\end{DoxyWarning}