docs/reference/html/gmime-GMimeParam.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GMimeParam</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
   8 <link rel="up" href="Headers.html" title="Message and MIME Headers">
   9 <link rel="prev" href="GMimeContentDisposition.html" title="GMimeContentDisposition">
  10 <link rel="next" href="InternetAddresses.html" title="Internet Addresses">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GMimeContentDisposition.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="Headers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GMime 2.6 Reference Manual</th>
  21 <td><a accesskey="n" href="InternetAddresses.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gmime-GMimeParam.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gmime-GMimeParam.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gmime-GMimeParam"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gmime-GMimeParam.top_of_page"></a>GMimeParam</span></h2>
  34 <p>GMimeParam — Content-Type and Content-Disposition parameters</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gmime-GMimeParam.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">struct              <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam">GMimeParam</a>;
  41 <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *        <a class="link" href="gmime-GMimeParam.html#g-mime-param-new" title="g_mime_param_new ()">g_mime_param_new</a>                    (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
  42                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
  43 <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *        <a class="link" href="gmime-GMimeParam.html#g-mime-param-new-from-string" title="g_mime_param_new_from_string ()">g_mime_param_new_from_string</a>        (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
  44 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeParam.html#g-mime-param-destroy" title="g_mime_param_destroy ()">g_mime_param_destroy</a>                (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);
  45 const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *  <a class="link" href="gmime-GMimeParam.html#g-mime-param-next" title="g_mime_param_next ()">g_mime_param_next</a>                   (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);
  46 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-GMimeParam.html#g-mime-param-get-name" title="g_mime_param_get_name ()">g_mime_param_get_name</a>               (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);
  47 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-GMimeParam.html#g-mime-param-get-value" title="g_mime_param_get_value ()">g_mime_param_get_value</a>              (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);
  48 <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *        <a class="link" href="gmime-GMimeParam.html#g-mime-param-append" title="g_mime_param_append ()">g_mime_param_append</a>                 (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>,
  49                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
  50                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
  51 <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *        <a class="link" href="gmime-GMimeParam.html#g-mime-param-append-param" title="g_mime_param_append_param ()">g_mime_param_append_param</a>           (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>,
  52                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);
  53 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeParam.html#g-mime-param-write-to-string" title="g_mime_param_write_to_string ()">g_mime_param_write_to_string</a>        (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>,
  54                                                          <em class="parameter"><code><span class="type">gboolean</span> fold</code></em>,
  55                                                          <em class="parameter"><code><span class="type">GString</span> *str</code></em>);
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gmime-GMimeParam.description"></a><h2>Description</h2>
  60 <p>
  61 A <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> is a parameter name/value pair as found on MIME
  62 header fields such as Content-Type and Content-Disposition.
  63 </p>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gmime-GMimeParam.details"></a><h2>Details</h2>
  67 <div class="refsect2">
  68 <a name="GMimeParam"></a><h3>struct GMimeParam</h3>
  69 <pre class="programlisting">struct GMimeParam {
  70         GMimeParam *next;
  71         char *name;
  72         char *value;
  73 };
  74 </pre>
  75 <p>
  76 A parameter name/value pair as used for some Content header fields.
  77 </p>
  78 <div class="variablelist"><table border="0">
  79 <col align="left" valign="top">
  80 <tbody>
  81 <tr>
  82 <td><p><span class="term"><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *<em class="structfield"><code><a name="GMimeParam.next"></a>next</code></em>;</span></p></td>
  83 <td>Pointer to the next param.</td>
  84 </tr>
  85 <tr>
  86 <td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="GMimeParam.name"></a>name</code></em>;</span></p></td>
  87 <td>Parameter name.</td>
  88 </tr>
  89 <tr>
  90 <td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="GMimeParam.value"></a>value</code></em>;</span></p></td>
  91 <td>Parameter value.</td>
  92 </tr>
  93 </tbody>
  94 </table></div>
  95 </div>
  96 <hr>
  97 <div class="refsect2">
  98 <a name="g-mime-param-new"></a><h3>g_mime_param_new ()</h3>
  99 <pre class="programlisting"><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *        g_mime_param_new                    (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 100                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
 101 <p>
 102 Creates a new <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> node with name <em class="parameter"><code>name</code></em> and value <em class="parameter"><code>value</code></em>.
 103 </p>
 104 <div class="variablelist"><table border="0">
 105 <col align="left" valign="top">
 106 <tbody>
 107 <tr>
 108 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 109 <td>parameter name</td>
 110 </tr>
 111 <tr>
 112 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 113 <td>parameter value</td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 117 <td>a new paramter structure.</td>
 118 </tr>
 119 </tbody>
 120 </table></div>
 121 </div>
 122 <hr>
 123 <div class="refsect2">
 124 <a name="g-mime-param-new-from-string"></a><h3>g_mime_param_new_from_string ()</h3>
 125 <pre class="programlisting"><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *        g_mime_param_new_from_string        (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
 126 <p>
 127 Creates a parameter list based on the input string.
 128 </p>
 129 <div class="variablelist"><table border="0">
 130 <col align="left" valign="top">
 131 <tbody>
 132 <tr>
 133 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 134 <td>input string</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 138 <td>a <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> structure based on <em class="parameter"><code>string</code></em>.</td>
 139 </tr>
 140 </tbody>
 141 </table></div>
 142 </div>
 143 <hr>
 144 <div class="refsect2">
 145 <a name="g-mime-param-destroy"></a><h3>g_mime_param_destroy ()</h3>
 146 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_param_destroy                (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);</pre>
 147 <p>
 148 Releases all memory used by this mime param back to the Operating
 149 System.
 150 </p>
 151 <div class="variablelist"><table border="0">
 152 <col align="left" valign="top">
 153 <tbody><tr>
 154 <td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
 155 <td>Mime param list to destroy</td>
 156 </tr></tbody>
 157 </table></div>
 158 </div>
 159 <hr>
 160 <div class="refsect2">
 161 <a name="g-mime-param-next"></a><h3>g_mime_param_next ()</h3>
 162 <pre class="programlisting">const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *  g_mime_param_next                   (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);</pre>
 163 <p>
 164 Gets the next <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> node in the list.
 165 </p>
 166 <div class="variablelist"><table border="0">
 167 <col align="left" valign="top">
 168 <tbody>
 169 <tr>
 170 <td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
 171 <td>a <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> node</td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 175 <td>the next <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> node in the list.</td>
 176 </tr>
 177 </tbody>
 178 </table></div>
 179 </div>
 180 <hr>
 181 <div class="refsect2">
 182 <a name="g-mime-param-get-name"></a><h3>g_mime_param_get_name ()</h3>
 183 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_param_get_name               (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);</pre>
 184 <p>
 185 Gets the name of the parameter.
 186 </p>
 187 <div class="variablelist"><table border="0">
 188 <col align="left" valign="top">
 189 <tbody>
 190 <tr>
 191 <td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
 192 <td>a <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a>
 193 </td>
 194 </tr>
 195 <tr>
 196 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 197 <td>the name of the parameter.</td>
 198 </tr>
 199 </tbody>
 200 </table></div>
 201 </div>
 202 <hr>
 203 <div class="refsect2">
 204 <a name="g-mime-param-get-value"></a><h3>g_mime_param_get_value ()</h3>
 205 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_param_get_value              (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);</pre>
 206 <p>
 207 Gets the value of the parameter.
 208 </p>
 209 <div class="variablelist"><table border="0">
 210 <col align="left" valign="top">
 211 <tbody>
 212 <tr>
 213 <td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
 214 <td>a <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a>
 215 </td>
 216 </tr>
 217 <tr>
 218 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 219 <td>the value of the parameter.</td>
 220 </tr>
 221 </tbody>
 222 </table></div>
 223 </div>
 224 <hr>
 225 <div class="refsect2">
 226 <a name="g-mime-param-append"></a><h3>g_mime_param_append ()</h3>
 227 <pre class="programlisting"><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *        g_mime_param_append                 (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>,
 228                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 229                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
 230 <p>
 231 Appends a new parameter with name <em class="parameter"><code>name</code></em> and value <em class="parameter"><code>value</code></em> to the
 232 parameter list <em class="parameter"><code>params</code></em>.
 233 </p>
 234 <div class="variablelist"><table border="0">
 235 <col align="left" valign="top">
 236 <tbody>
 237 <tr>
 238 <td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
 239 <td>param list</td>
 240 </tr>
 241 <tr>
 242 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 243 <td>new param name</td>
 244 </tr>
 245 <tr>
 246 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 247 <td>new param value</td>
 248 </tr>
 249 <tr>
 250 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 251 <td>a param list with the new param of name <em class="parameter"><code>name</code></em> and value
 252 <em class="parameter"><code>value</code></em> appended to the list of params <em class="parameter"><code>params</code></em>.</td>
 253 </tr>
 254 </tbody>
 255 </table></div>
 256 </div>
 257 <hr>
 258 <div class="refsect2">
 259 <a name="g-mime-param-append-param"></a><h3>g_mime_param_append_param ()</h3>
 260 <pre class="programlisting"><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *        g_mime_param_append_param           (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>,
 261                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);</pre>
 262 <p>
 263 Appends <em class="parameter"><code>param</code></em> to the param list <em class="parameter"><code>params</code></em>.
 264 </p>
 265 <div class="variablelist"><table border="0">
 266 <col align="left" valign="top">
 267 <tbody>
 268 <tr>
 269 <td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
 270 <td>param list</td>
 271 </tr>
 272 <tr>
 273 <td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
 274 <td>param to append</td>
 275 </tr>
 276 <tr>
 277 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 278 <td>a param list with the new param <em class="parameter"><code>param</code></em> appended to the list
 279 of params <em class="parameter"><code>params</code></em>.</td>
 280 </tr>
 281 </tbody>
 282 </table></div>
 283 </div>
 284 <hr>
 285 <div class="refsect2">
 286 <a name="g-mime-param-write-to-string"></a><h3>g_mime_param_write_to_string ()</h3>
 287 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_param_write_to_string        (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>,
 288                                                          <em class="parameter"><code><span class="type">gboolean</span> fold</code></em>,
 289                                                          <em class="parameter"><code><span class="type">GString</span> *str</code></em>);</pre>
 290 <p>
 291 Assumes the output string contains only the Content-* header and
 292 it's immediate value.
 293 </p>
 294 <p>
 295 Writes the params out to the string <em class="parameter"><code>string</code></em>.
 296 </p>
 297 <div class="variablelist"><table border="0">
 298 <col align="left" valign="top">
 299 <tbody>
 300 <tr>
 301 <td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
 302 <td>MIME Param list</td>
 303 </tr>
 304 <tr>
 305 <td><p><span class="term"><em class="parameter"><code>fold</code></em> :</span></p></td>
 306 <td>specifies whether or not to fold headers</td>
 307 </tr>
 308 <tr>
 309 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 310 <td>output string</td>
 311 </tr>
 312 </tbody>
 313 </table></div>
 314 </div>
 315 </div>
 316 <div class="refsect1">
 317 <a name="gmime-GMimeParam.see-also"></a><h2>See Also</h2>
 318 <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a>
 319 </div>
 320 </div>
 321 <div class="footer">
 322 <hr>
 323           Generated by GTK-Doc V1.18</div>
 324 </body>
 325 </html>