vnfs/VES5.0/doxygen-1.8.12/html/examples/structcmd/latex/structcmd_8h.tex

   1 \hypertarget{structcmd_8h}{}\subsection{structcmd.\+h File Reference}
   2 \label{structcmd_8h}\index{structcmd.\+h@{structcmd.\+h}}
   3
   4
   5 A Documented file.
   6
   7
   8 \subsubsection*{Macros}
   9 \begin{DoxyCompactItemize}
  10 \item
  11 \#define \hyperlink{structcmd_8h_afa99ec4acc4ecb2dc3c2d05da15d0e3f}{M\+AX}(a,  b)~(((a)$>$(b))?(a)\+:(b))
  12 \begin{DoxyCompactList}\small\item\em A macro that returns the maximum of {\itshape a} and {\itshape b}. \end{DoxyCompactList}\end{DoxyCompactItemize}
  13 \subsubsection*{Typedefs}
  14 \begin{DoxyCompactItemize}
  15 \item
  16 typedef unsigned int \hyperlink{structcmd_8h_ae1e6edbbc26d6fbc71a90190d0266018}{U\+I\+N\+T32}
  17 \begin{DoxyCompactList}\small\item\em A type definition for a . \end{DoxyCompactList}\end{DoxyCompactItemize}
  18 \subsubsection*{Functions}
  19 \begin{DoxyCompactItemize}
  20 \item
  21 int \hyperlink{structcmd_8h_a2c4414339f388561554c2deab11a1a07}{open} (const char $\ast$, int)
  22 \begin{DoxyCompactList}\small\item\em Opens a file descriptor. \end{DoxyCompactList}\item
  23 int \hyperlink{structcmd_8h_ae152484c890a24e4d9b4980e7b965be0}{close} (int)
  24 \begin{DoxyCompactList}\small\item\em Closes the file descriptor {\itshape fd}. \end{DoxyCompactList}\item
  25 size\+\_\+t \hyperlink{structcmd_8h_af2a3ea719b83f672637febdd87c36c36}{write} (int, const char $\ast$, size\+\_\+t)
  26 \begin{DoxyCompactList}\small\item\em Writes {\itshape count} bytes from {\itshape buf} to the filedescriptor {\itshape fd}. \end{DoxyCompactList}\item
  27 int \hyperlink{structcmd_8h_a9c7b76d5266903891c803132d51ccb90}{read} (int, char $\ast$, size\+\_\+t)
  28 \begin{DoxyCompactList}\small\item\em Read bytes from a file descriptor. \end{DoxyCompactList}\end{DoxyCompactItemize}
  29 \subsubsection*{Variables}
  30 \begin{DoxyCompactItemize}
  31 \item
  32 int \hyperlink{structcmd_8h_ad65a8842cc674e3ddf69355898c0ecbf}{errno}
  33 \begin{DoxyCompactList}\small\item\em Contains the last error code. \end{DoxyCompactList}\end{DoxyCompactItemize}
  34
  35
  36 \subsubsection{Detailed Description}
  37 A Documented file.
  38
  39 Details.
  40
  41 \subsubsection{Macro Definition Documentation}
  42 \hypertarget{structcmd_8h_afa99ec4acc4ecb2dc3c2d05da15d0e3f}{}\label{structcmd_8h_afa99ec4acc4ecb2dc3c2d05da15d0e3f}
  43 \index{structcmd.\+h@{structcmd.\+h}!M\+AX@{M\+AX}}
  44 \index{M\+AX@{M\+AX}!structcmd.\+h@{structcmd.\+h}}
  45 \paragraph{\texorpdfstring{M\+AX}{MAX}}
  46 {\footnotesize\ttfamily \#define M\+AX(\begin{DoxyParamCaption}\item[{}]{a,  }\item[{}]{b }\end{DoxyParamCaption})~(((a)$>$(b))?(a)\+:(b))}
  47
  48
  49
  50 A macro that returns the maximum of {\itshape a} and {\itshape b}.
  51
  52 Details.
  53
  54 \subsubsection{Typedef Documentation}
  55 \hypertarget{structcmd_8h_ae1e6edbbc26d6fbc71a90190d0266018}{}\label{structcmd_8h_ae1e6edbbc26d6fbc71a90190d0266018}
  56 \index{structcmd.\+h@{structcmd.\+h}!U\+I\+N\+T32@{U\+I\+N\+T32}}
  57 \index{U\+I\+N\+T32@{U\+I\+N\+T32}!structcmd.\+h@{structcmd.\+h}}
  58 \paragraph{\texorpdfstring{U\+I\+N\+T32}{UINT32}}
  59 {\footnotesize\ttfamily typedef unsigned int \hyperlink{structcmd_8h_ae1e6edbbc26d6fbc71a90190d0266018}{U\+I\+N\+T32}}
  60
  61
  62
  63 A type definition for a .
  64
  65 Details.
  66
  67 \subsubsection{Function Documentation}
  68 \hypertarget{structcmd_8h_ae152484c890a24e4d9b4980e7b965be0}{}\label{structcmd_8h_ae152484c890a24e4d9b4980e7b965be0}
  69 \index{structcmd.\+h@{structcmd.\+h}!close@{close}}
  70 \index{close@{close}!structcmd.\+h@{structcmd.\+h}}
  71 \paragraph{\texorpdfstring{close()}{close()}}
  72 {\footnotesize\ttfamily int close (\begin{DoxyParamCaption}\item[{int}]{fd }\end{DoxyParamCaption})}
  73
  74
  75
  76 Closes the file descriptor {\itshape fd}.
  77
  78
  79 \begin{DoxyParams}{Parameters}
  80 {\em fd} & The descriptor to close. \\
  81 \hline
  82 \end{DoxyParams}
  83 \hypertarget{structcmd_8h_a2c4414339f388561554c2deab11a1a07}{}\label{structcmd_8h_a2c4414339f388561554c2deab11a1a07}
  84 \index{structcmd.\+h@{structcmd.\+h}!open@{open}}
  85 \index{open@{open}!structcmd.\+h@{structcmd.\+h}}
  86 \paragraph{\texorpdfstring{open()}{open()}}
  87 {\footnotesize\ttfamily int open (\begin{DoxyParamCaption}\item[{const char $\ast$}]{pathname,  }\item[{int}]{flags }\end{DoxyParamCaption})}
  88
  89
  90
  91 Opens a file descriptor.
  92
  93
  94 \begin{DoxyParams}{Parameters}
  95 {\em pathname} & The name of the descriptor. \\
  96 \hline
  97 {\em flags} & Opening flags. \\
  98 \hline
  99 \end{DoxyParams}
 100 \hypertarget{structcmd_8h_a9c7b76d5266903891c803132d51ccb90}{}\label{structcmd_8h_a9c7b76d5266903891c803132d51ccb90}
 101 \index{structcmd.\+h@{structcmd.\+h}!read@{read}}
 102 \index{read@{read}!structcmd.\+h@{structcmd.\+h}}
 103 \paragraph{\texorpdfstring{read()}{read()}}
 104 {\footnotesize\ttfamily int read (\begin{DoxyParamCaption}\item[{int}]{fd,  }\item[{char $\ast$}]{buf,  }\item[{size\+\_\+t}]{count }\end{DoxyParamCaption})}
 105
 106
 107
 108 Read bytes from a file descriptor.
 109
 110
 111 \begin{DoxyParams}{Parameters}
 112 {\em fd} & The descriptor to read from. \\
 113 \hline
 114 {\em buf} & The buffer to read into. \\
 115 \hline
 116 {\em count} & The number of bytes to read. \\
 117 \hline
 118 \end{DoxyParams}
 119 \hypertarget{structcmd_8h_af2a3ea719b83f672637febdd87c36c36}{}\label{structcmd_8h_af2a3ea719b83f672637febdd87c36c36}
 120 \index{structcmd.\+h@{structcmd.\+h}!write@{write}}
 121 \index{write@{write}!structcmd.\+h@{structcmd.\+h}}
 122 \paragraph{\texorpdfstring{write()}{write()}}
 123 {\footnotesize\ttfamily size\+\_\+t write (\begin{DoxyParamCaption}\item[{int}]{fd,  }\item[{const char $\ast$}]{buf,  }\item[{size\+\_\+t}]{count }\end{DoxyParamCaption})}
 124
 125
 126
 127 Writes {\itshape count} bytes from {\itshape buf} to the filedescriptor {\itshape fd}.
 128
 129
 130 \begin{DoxyParams}{Parameters}
 131 {\em fd} & The descriptor to write to. \\
 132 \hline
 133 {\em buf} & The data buffer to write. \\
 134 \hline
 135 {\em count} & The number of bytes to write. \\
 136 \hline
 137 \end{DoxyParams}
 138
 139
 140 \subsubsection{Variable Documentation}
 141 \hypertarget{structcmd_8h_ad65a8842cc674e3ddf69355898c0ecbf}{}\label{structcmd_8h_ad65a8842cc674e3ddf69355898c0ecbf}
 142 \index{structcmd.\+h@{structcmd.\+h}!errno@{errno}}
 143 \index{errno@{errno}!structcmd.\+h@{structcmd.\+h}}
 144 \paragraph{\texorpdfstring{errno}{errno}}
 145 {\footnotesize\ttfamily int errno}
 146
 147
 148
 149 Contains the last error code.
 150
 151 \begin{DoxyWarning}{Warning}
 152 Not thread safe!
 153 \end{DoxyWarning}