You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by bu...@apache.org on 2011/12/19 23:58:08 UTC
svn commit: r800542 [8/23] - in
/websites/staging/trafficserver/trunk/content/docs/v2: ./ admin/
admin/images/ sdk/ sdk/css/ sdk/images/ sdk/images/docbook/ sdk/js/
Added: websites/staging/trafficserver/trunk/content/docs/v2/sdk/App_DeprecatedFunctions.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/v2/sdk/App_DeprecatedFunctions.html (added)
+++ websites/staging/trafficserver/trunk/content/docs/v2/sdk/App_DeprecatedFunctions.html Mon Dec 19 22:58:01 2011
@@ -0,0 +1,1405 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>Appendix B. Deprecated Functions</title>
+<!--#include file="top.html" -->
+<div class="navheader">
+<div class="navprev">
+<a accesskey="p" href="App_SampleSourceCode.html">Prev</a> - Appendix A. Sample Source Code</div>
+<div class="navnext">Other Deprecated Functions: Statistics Fxns - <a accesskey="n" href="OtherDeprecatedFunctions.html">Next</a>
+</div>
+</div>
+<div id="toc"></div>
+<div class="appendix" lang="en">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="App_DeprecatedFunctions"></a>Appendix B. Deprecated Functions</h2></div></div></div>
+<p>This appendix lists the functions that are deprecated in current and all subsequent versions of Traffic Server.</p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="DepMimeHdrFunctions"></a>Deprecated MIME Header Functions</h2></div></div></div>
+
+
+<ul><b>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldCopy">INKMimeFieldCopy</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldCopyValues">INKMimeFieldCopyValues</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldCreate">INKMimeFieldCreate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldDestroy">INKMimeFieldDestroy</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldLengthGet">INKMimeFieldLengthGet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldNameGet">INKMimeFieldNameGet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldNameSet">INKMimeFieldNameSet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldNext">INKMimeFieldNext</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueAppend">INKMimeFieldValueAppend</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueDelete">INKMimeFieldValueDelete</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueGet">INKMimeFieldValueGet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueGetDate">INKMimeFieldValueGetDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueGetInt">INKMimeFieldValueGetInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueGetUint">INKMimeFieldValueGetUint</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueInsertDate">INKMimeFieldValueInsertDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueInsertInt">INKMimeFieldValueInsertInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueInsertUint">INKMimeFieldValueInsertUint</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValuesClear">INKMimeFieldValuesClear</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValuesCount">INKMimeFieldValuesCount</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueSet">INKMimeFieldValueSet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueSetDate">INKMimeFieldValueSetDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueSetInt">INKMimeFieldValueSetInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeFieldValueSetUint">INKMimeFieldValueSetUint</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueGet">INKMimeHdrFieldValueGet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueGetDate">INKMimeHdrFieldValueGetDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueGetInt">INKMimeHdrFieldValueGetInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueGetUint">INKMimeHdrFieldValueGetUint</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueInsert">INKMimeHdrFieldValueInsert</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueInsertDate">INKMimeHdrFieldValueInsertDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueInsertInt">INKMimeHdrFieldValueInsertInt</a></li>
+
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueInsertUint">INKMimeHdrFieldValueInsertUint</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueSet">INKMimeHdrFieldValueSet</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueSetDate">INKMimeHdrFieldValueSetDate</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueSetInt">INKMimeHdrFieldValueSetInt</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldValueSetUint">INKMimeHdrFieldValueSetUint</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldDelete">INKMimeHdrFieldDelete</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldInsert">INKMimeHdrFieldInsert</a></li>
+<li><a href="App_DeprecatedFunctions.html#INKMimeHdrFieldRetrieve">INKMimeHdrFieldRetrieve</a></li>
+
+
+
+</b>
+</ul>
+
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldCopy"></a>INKMimeFieldCopy</h3></div></div></div>
+<p>Copies a MIME field from one location to another.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd>
+ <p><code class="code">void INKMimeFieldCopy (INKMBuffer
+ <em class="replaceable"><code>dest_bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>dest_offset</code></em>, INKMBuffer
+ <em class="replaceable"><code>src_bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>src_offset</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Copies the contents of the MIME field located at
+ <code class="code"><em class="replaceable"><code>src_offset </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>src_bufp </code></em></code>
+ to the MIME field located at
+ <code class="code"><em class="replaceable"><code>dest_offset </code></em></code> within the
+ marshal buffer
+ <code class="code"><em class="replaceable"><code>dest_bufp</code></em></code>.
+ <code class="function">INKMimeFieldCopy</code> works correctly even if
+ <code class="code"><em class="replaceable"><code>src_bufp </code></em></code> and
+ <code class="code"><em class="replaceable"><code>dest_bufp </code></em></code> point to
+ different marshal buffers.</p>
+<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top"><p>You must first create the destination MIME field before
+ you copy into it.</p></td></tr>
+</table></div>
+</dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldCopyValues"></a>INKMimeFieldCopyValues</h3></div></div></div>
+<p>Copies MIME field values from one location to another.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd>
+ <p><code class="code">void INKMimeFieldCopyValues (INKMBuffer
+ <em class="replaceable"><code>dest_bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>dest_offset</code></em>, INKMBuffer
+ <em class="replaceable"><code>src_bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>src_offset</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Copies the values contained within the MIME field located
+ at <code class="code"><em class="replaceable"><code>src_offset </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>src_bufp </code></em></code>
+ to the MIME field located at
+ <code class="code"><em class="replaceable"><code>dest_offset </code></em></code> within the
+ marshal buffer
+ <code class="code"><em class="replaceable"><code>dest_bufp</code></em></code>. </p></dd>
+<dd>
+ <p><code class="function">INKMimeFieldCopyValues </code> works correctly even
+ if <code class="code"><em class="replaceable"><code>src_bufp </code></em></code> and
+ <code class="code"><em class="replaceable"><code>dest_bufp </code></em></code> point to
+ different marshal buffers.
+ <code class="function">INKMIMEFieldCopyValues</code> does not copy the
+ field's name.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldCreate"></a>INKMimeFieldCreate</h3></div></div></div>
+<p>Creates a new MIME field within a specified marshal
+ buffer.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMLoc INKMimeFieldCreate (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Creates a new MIME field with the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>. Returns the offset
+ location of the new MIME field.</p>
+<p>Release the created <code class="function">INKMLoc</code> with a
+ call to <code class="function">INKHandleMLocRelease</code>.</p>
+</dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldDestroy"></a>INKMimeFieldDestroy</h3></div></div></div>
+<p>Deletes a specified MIME field from a marshal buffer.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeFieldDestroy (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Destroys the MIME field located at
+ <code class="code"><em class="replaceable"><code>offset </code></em></code> within the
+ marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>.</p>
+<p>Release the handle with a call to
+ <code class="function">INKHandleMLocRelease</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldLengthGet"></a>INKMimeFieldLengthGet</h3></div></div></div>
+<p>Calculates the length of a string representation of a specified
+ MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">int INKMimeFieldLengthGet (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Calculates the length of the MIME field located at
+ <code class="code"><em class="replaceable"><code>offset </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> if
+ it was returned as a string. This is the length of the MIME
+ field in its unparsed form.</p></dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldNameGet"></a>INKMimeFieldNameGet</h3></div></div></div>
+<p>Gets the name and length of a specified MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">const char* INKMimeFieldNameGet (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>, int
+ *<em class="replaceable"><code>length</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Returns the name of the field located at
+ <code class="code"><em class="replaceable"><code>offset </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p><code class="function">INKMimeFieldNameGet</code> places the length of
+ the returned string in the
+ <code class="code"><em class="replaceable"><code>length </code></em></code> argument. If
+ <code class="code"><em class="replaceable"><code>length </code></em></code> is
+ <code class="code">NULL</code>, then no attempt is made to dereference
+ it.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldNameSet"></a>INKMimeFieldNameSet</h3></div></div></div>
+<p>Sets a specified MIME field's name.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeFieldNameSet (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>, const char
+ *<em class="replaceable"><code>name</code></em>, int
+ <em class="replaceable"><code>length</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Sets the name of the field located at
+ <code class="code"><em class="replaceable"><code>offset </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
+ the string <code class="code"><em class="replaceable"><code> name</code></em></code>. </p></dd>
+<dd>
+ <p>If <code class="code"><em class="replaceable"><code>length </code></em></code> is -1, then
+ <code class="function">INKMimeFieldNameSet</code> assumes that name is
+ null-terminated. Otherwise, the length of the string name is
+ taken to be <code class="code"><em class="replaceable"><code>length</code></em></code>. </p>
+</dd>
+<dd>
+ <p><code class="function">INKMimeFieldNameSet</code> copies the string to
+ within <code class="code"><em class="replaceable"><code>bufp</code></em></code>, so it is
+ okay to modify or delete
+ <code class="code"><em class="replaceable"><code>name </code></em></code> after calling
+ <code class="function">INKMimeFieldNameSet</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldNext"></a>INKMimeFieldNext</h3></div></div></div>
+<p>Returns the next MIME field after a specified MIME field in a
+ MIME header.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMLoc INKMimeFieldNext (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc offset) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Conceptually, there are a list of MIME fields in a MIME
+ header (see <a href="HTTPHeaders.html#AboutHTTPHeaders" title="About HTTP Headers">About HTTP Headers</a>).
+ <code class="function">INKMimeFieldNext</code> returns the location of
+ the next field in the list after the field located at
+ <code class="code"><em class="replaceable"><code> offset </code></em></code> within the
+ marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>.</p>
+<p>Release the returned <code class="function">INKMLoc</code> with a
+ call to <code class="function">INKHandleMLocRelease</code>.</p>
+</dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueAppend"></a>INKMimeFieldValueAppend</h3></div></div></div>
+<p>Appends a string to a specified value in a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMLoc INKMimeFieldNext (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Conceptually, there are a list of MIME fields in a MIME
+ header (see <a href="HTTPHeaders.html#AboutHTTPHeaders" title="About HTTP Headers">About HTTP Headers</a>).
+ <code class="function">INKMimeFieldNext</code> returns the location of
+ the next field in the list after the field located at
+ <code class="code"><em class="replaceable"><code>offset </code></em></code> within the
+ marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>.</p>
+<p>Release the returned <code class="function">INKMLoc</code> with a
+ call to <code class="function">INKHandleMLocRelease</code>.</p>
+</dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueDelete"></a>INKMimeFieldValueDelete</h3></div></div></div>
+<p>Deletes a specified value from a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeFieldValueDelete (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>, int
+ <em class="replaceable"><code>idx</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Removes and deletes a value from the MIME field located at
+ <code class="code"><em class="replaceable"><code>offset </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p></dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ which value should be deleted. If
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between <code>0</code> and <code class="function">INKMimeFieldValuesCount</code> <code>(</code><em class="replaceable"><code>bufp,
+ offset</code></em><code>) - 1</code>, then no operation is
+ performed.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueGet"></a>INKMimeFieldValueGet</h3></div></div></div>
+<p>Gets a specified field value from a MIME header.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">const char* INKMimeFieldValueGet (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>offset</code></em>, int
+ <em class="replaceable"><code>idx</code></em>, int
+ *<em class="replaceable"><code>length</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Retrieves a string value from within the MIME field
+ located at <code class="code"><em class="replaceable"><code>offset </code></em></code> within
+ the marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter
+ specifies which field to retrieve. The fields are numbered from
+ <code>0</code> to <code class="function">INKMimeFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, offset</code></em></code><code>) - 1</code>. If <code class="code"><em class="replaceable"><code>idx </code></em></code> does not lie within
+ that range, then <code class="code">NULL </code> is returned. </p>
+</dd>
+<dd>
+ <p>The length
+ of the returned string is placed in the <code class="code"><em class="replaceable"><code>length </code></em></code> argument. If
+ <code class="code"><em class="replaceable"><code>length </code></em></code> is
+ <code class="code">NULL, </code> then no attempt is made to dereference
+ it.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueGetDate"></a>INKMimeFieldValueGetDate</h3></div></div></div>
+<p>Gets date value from a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">time_t INKMimeFieldValueGetDate (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>offset</code></em>, int
+ <em class="replaceable"><code>idx</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Retrieves a date value from within the MIME field located
+ at <code class="code"><em class="replaceable"><code> offset </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p></dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ which field to retrieve. The fields are numbered from <code>0</code> to <code class="function">INKMimeFieldValuesCount</code>
+ (<code class="code"><em class="replaceable"><code>bufp, offset</code></em></code>) - 1. If
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> does not lie within
+ that range, then <code class="function">INKMimeFieldValueGetDate</code>
+ returns <code>(</code><code class="code">time_t</code><code>) 0</code>. </p>
+</dd>
+<dd>
+ <p>All values are stored as
+ strings within the MIME field. <code class="function">INKMimeFieldValueGetDate</code> parses the string
+ value to return an integer date representation.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueGetInt"></a>INKMimeFieldValueGetInt</h3></div></div></div>
+<p>Gets an integer field value in a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">int INKMimeFieldValueGetInt (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>offset</code></em>, int
+ <em class="replaceable"><code>idx</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Retrieves an integer value from within the MIME field
+ located at <code class="code"><em class="replaceable"><code>offset </code></em></code> within
+ the marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p></dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter
+ specifies which value within the field to retrieve. The fields
+ are numbered from <code>0</code> to <code class="function">INKMimeFieldValuesCount</code><code>
+ (</code><code class="code"><em class="replaceable"><code>bufp, offset</code></em></code><code>) - 1</code>. If <code class="code"><em class="replaceable"><code>idx </code></em></code> does not lie within
+ that range, then <code class="function">INKMimeFieldValueGetInt</code> returns
+ <code>(</code><code class="code">int</code><code>) 0</code>. </p>
+</dd>
+<dd>
+ <p>All values are stored as strings within
+ the MIME field. <code class="function">INKMimeFieldValueGetInt</code>
+ parses the string value to return an integer.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueGetUint"></a>INKMimeFieldValueGetUint</h3></div></div></div>
+<p>Gets unsigned integer field value in a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">unsigned int INKMimeFieldValueGetUint (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>offset</code></em>, int
+ <em class="replaceable"><code>idx</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Retrieves an unsigned integer value from within the MIME
+ field located at <code class="code"><em class="replaceable"><code>offset </code></em></code>
+ within the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p></dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ which field to retrieve. The fields are numbered from <code>0</code> to <code class="function">INKMimeFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, offset</code></em></code><code>) - 1</code>. If <code class="code"><em class="replaceable"><code>idx </code></em></code> does not lie within
+ that range, then <code class="function">INKMimeFieldValueGetUnit</code>
+ returns <code>(</code><code class="code">unsigned int</code><code>) 0</code>. </p>
+</dd>
+<dd>
+ <p>All values are stored as
+ strings within the MIME field. <code class="function">INKMimeFieldValueGetUint</code> parses the string
+ value to return an unsigned integer.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueInsertDate"></a>INKMimeFieldValueInsertDate</h3></div></div></div>
+<p>Inserts a date value into a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMLoc INKMimeFieldValueInsertDate (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>, time_t
+ <em class="replaceable"><code>value</code></em>, int
+ <em class="replaceable"><code>idx</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Inserts the date
+ <code class="code"><em class="replaceable"><code>value </code></em></code> into the MIME
+ field located at <code class="code"><em class="replaceable"><code>offset </code></em></code>
+ within the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ where the inserted <code class="code"><em class="replaceable"><code>value</code></em></code>
+ should be put with respect to the other values already in the
+ MIME field. If <code class="code"><em class="replaceable"><code>idx </code></em></code> is <code>0</code>,
+ then the <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ prepended to the list of values in the field. Increasing values
+ of <code class="code"><em class="replaceable"><code>idx </code></em></code> place the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> further down the
+ list of values. If <code class="code"><em class="replaceable"><code>idx </code></em></code>
+ is <code>-1</code>, then the <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ appended to the list of values. Normal usage is to specify <code>-1</code> for <code class="code"><em class="replaceable"><code>idx </code></em></code> so that the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is appended to the
+ list of values. </p>
+</dd>
+<dd>
+ <p>All values are stored as strings within the MIME
+ field. <code class="function">INKMimeFieldValueInsertDate</code> simply
+ formats the date into a string and then calls
+ <code class="function">INKMimeFieldValueInsert</code>.</p>
+ <p>Release the returned <code class="function">INKMLoc</code> with a
+ call to <code class="function">INKHandleMLocRelease</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueInsertInt"></a>INKMimeFieldValueInsertInt</h3></div></div></div>
+<p>Inserts an integer value into a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMLoc INKMimeFieldValueInsertInt (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>, int
+ <em class="replaceable"><code>value</code></em>, int
+ <em class="replaceable"><code>idx</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Inserts the integer
+ <code class="code"><em class="replaceable"><code>value </code></em></code> into the MIME
+ field located at <code class="code"><em class="replaceable"><code>offset </code></em></code>
+ within the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ where the inserted <code class="code"><em class="replaceable"><code>value </code></em></code>
+ should be put with respect to the other values already in the
+ MIME field. If <code class="code"><em class="replaceable"><code>idx </code></em></code> is <code>0</code>,
+ then the <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ prepended to the list of values in the field. Increasing values
+ of <code class="code"><em class="replaceable"><code>idx </code></em></code> places the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> further down the
+ list of values. If <code class="code"><em class="replaceable"><code>idx </code></em></code>
+ is <code>-1</code>, then the <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ appended to the list of values. Normal usage is to specify <code>-1</code> for <code class="code"><em class="replaceable"><code>idx </code></em></code> so that the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is appended to the
+ list of values. </p>
+</dd>
+<dd>
+ <p>All values are stored as strings within the MIME
+ field. <code class="function">INKMimeFieldValueInsertInt</code> simply
+ formats the integer into a string and then calls
+ <code class="function">INKMimeFieldValueInsert</code>.</p>
+ <p>Release the returned <code class="function">INKMLoc</code> with a
+ call to <code class="function">INKHandleMLocRelease</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueInsertUint"></a>INKMimeFieldValueInsertUint</h3></div></div></div>
+<p>Inserts an unsigned integer value into a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMLoc INKMimeFieldValueInsertUint (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>, unsigned int
+ <em class="replaceable"><code>value</code></em>, int
+ <em class="replaceable"><code>idx</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Inserts the unsigned integer
+ <code class="code"><em class="replaceable"><code>value </code></em></code> into the MIME
+ field located at <code class="code"><em class="replaceable"><code>offset </code></em></code>
+ within the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ where the inserted <code class="code"><em class="replaceable"><code>value </code></em></code>
+ should be placed with respect to the other values already in the
+ MIME field. If <code class="code"><em class="replaceable"><code>idx </code></em></code> is <code>0</code>,
+ then the <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ prepended to the list of values in the field. Increasing values
+ of <code class="code"><em class="replaceable"><code>idx </code></em></code> place the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> further down the
+ list of values. If <code class="code"><em class="replaceable"><code>idx </code></em></code>
+ is <code>-1</code>, then the <code class="code"><em class="replaceable"><code>value </code></em></code> is appended to the list of values. Normal usage is to
+ specify <code>-1</code> for <code class="code"><em class="replaceable"><code>idx </code></em></code> so
+ that the <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ appended to the list of values. </p>
+</dd>
+<dd>
+ <p>All values are stored as strings
+ within the MIME field. <code class="function">INKMimeFieldValueInsertUint</code> simply formats
+ the unsigned integer into a string and then calls
+ <code class="function">INKMimeFieldValueInsert</code>.</p>
+ <p>Release the returned <code class="function">INKMLoc</code> with a
+ call to <code class="function">INKHandleMLocRelease</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValuesClear"></a>INKMimeFieldValuesClear</h3></div></div></div>
+<p>Clears all values in a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeFieldValuesClear (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>offset</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Removes and destroys all of the values within the MIME
+ field located at <code class="code"><em class="replaceable"><code>offset </code></em></code>
+ within the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>.</p></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValuesCount"></a>INKMimeFieldValuesCount</h3></div></div></div>
+<p>Counts the values in a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">int INKMimeFieldValuesCount (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>offset</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Returns a count of the number of values in the MIME field
+ located at <code class="code"><em class="replaceable"><code> offset </code></em></code> within
+ the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>.</p></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueSet"></a>INKMimeFieldValueSet</h3></div></div></div>
+<p>Sets a value in a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeFieldValueSet (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>offset</code></em>, int
+ <em class="replaceable"><code>idx</code></em>, const char
+ *<em class="replaceable"><code>value</code></em>, int
+ <em class="replaceable"><code>length</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Sets a value in the MIME field located at
+ <code class="code"><em class="replaceable"><code>offset </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
+ the string <code class="code"><em class="replaceable"><code>value</code></em></code>. If
+ <code class="code"><em class="replaceable"><code>length </code></em></code> is <code>-1</code>, then it is
+ assumed that <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ null-terminated. Otherwise, the length of the string
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is taken to be
+ <code class="code"><em class="replaceable"><code>length</code></em></code>. </p></dd>
+<dd>
+ <p>The string is
+ copied to within <code class="code"><em class="replaceable"><code>bufp</code></em></code>,
+ so it's okay to modify or delete
+ <code class="code"><em class="replaceable"><code>value </code></em></code> after calling
+ <code class="function">INKMimeFieldValueSet</code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ which value in the field to change. If
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between <code>0</code> and <code class="function">INKMimeFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, offset</code></em></code><code>) - 1</code>, then
+ no operation is performed.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueSetDate"></a>INKMimeFieldValueSetDate</h3></div></div></div>
+<p>Sets a date value in a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeFieldValueSetDate (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>, int
+ <em class="replaceable"><code>idx</code></em>, time_t
+ <em class="replaceable"><code>value</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Sets a value in the MIME field located at
+ <code class="code"><em class="replaceable"><code> offset </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code> to
+ the data <code class="code">value</code>. </p></dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code> idx </code></em></code> parameter specifies
+ which value in the field to change. If
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between <code>0</code> and <code class="function">INKMimeFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, offset</code></em></code><code>) - 1</code>, then
+ no operation is performed. </p>
+</dd>
+<dd>
+ <p>All values are stored as strings
+ within the MIME field. <code class="function">INKMimeFieldValueSetDate</code> simply formats the
+ date into a string and then calls
+ <code class="function">INKMimeFieldValueSet</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueSetInt"></a>INKMimeFieldValueSetInt</h3></div></div></div>
+<p>Sets an integer value in a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeFieldValueSetInt (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>, int
+ <em class="replaceable"><code>idx</code></em>, int
+ <em class="replaceable"><code>value</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Sets a value in the MIME field located at
+ <code class="code"><em class="replaceable"><code>offset </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
+ the integer <code class="code"><em class="replaceable"><code>value</code></em></code>. </p></dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ which value in the field to change. If
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between <code>0</code> and <code class="function">INKMimeFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, offset</code></em></code><code>) - 1</code>, then
+ no operation is performed. </p>
+</dd>
+<dd>
+ <p>All values are stored as strings
+ within the MIME field. <code class="function">INKMimeFieldValueSetInt</code> simply formats the
+ integer into a string and then calls
+ <code class="function">INKMimeFieldValueSet</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeFieldValueSetUint"></a>INKMimeFieldValueSetUint</h3></div></div></div>
+<p>Sets an unsigned integer value in a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeFieldValueSetUint (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>,INKMLoc
+ <em class="replaceable"><code>offset</code></em>, int
+ <em class="replaceable"><code>idx</code></em>, unsigned int
+ <em class="replaceable"><code>value</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Sets a value in the MIME field located at
+ <code class="code"><em class="replaceable"><code>offset </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to
+ the unsigned integer
+ <code class="code"><em class="replaceable"><code>value</code></em></code>. </p></dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ which value in the field to change. If
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between <code>0</code> and <code class="function">INKMimeFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, offset</code></em></code><code>) - 1</code>, then
+ no operation is performed. </p>
+</dd>
+<dd>
+ <p>All values are stored as strings
+ within the MIME field. <code class="function">INKMimeFieldValueSetUint</code> simply formats the
+ unsigned integer into a string and then calls
+ <code class="function">INKMimeFieldValueSet</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueGet"></a>INKMimeHdrFieldValueGet</h3></div></div></div>
+<p>Gets a specified field value from a MIME header.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been replaced by <code class="function">INKMimeHdrFieldValueStringGet</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">const char* INKMimeHdrFieldValueGet (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr_loc</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, int
+ <em class="replaceable"><code>idx</code></em>, int
+ *<em class="replaceable"><code>value_len_ptr</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Retrieves a string value from within the MIME field
+ located at <code class="code"><em class="replaceable"><code>field </code></em></code> within
+ the marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter
+ specifies which field to retrieve. The fields are numbered from
+ <code>0</code> to <code class="function">INKMimeHdrFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code><code>) - 1</code>.
+ If <code class="code"><em class="replaceable"><code>idx </code></em></code> does not lie
+ within that range then <code class="code">NULL</code> will be returned. </p>
+</dd>
+<dd>
+ <p>The
+ length of the returned string is placed in the <code class="code"><em class="replaceable"><code>value_len_ptr </code></em></code> argument.
+ If <code class="code"><em class="replaceable"><code>value_len_ptr </code></em></code> is
+ <code class="code">NULL</code>, then no attempt is made to dereference
+ it.</p>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd><p>A pointer to the specified field value in the MIME header.
+</p></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueGetDate"></a>INKMimeHdrFieldValueGetDate</h3></div></div></div>
+<p>Gets date value from a MIME field.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been replaced by <code class="function">INKMimeHdrFieldValueDateGet</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">time_t INKMimeHdrFieldValueGetDate (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, int
+ <em class="replaceable"><code>idx</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Retrieves a date value from within the MIME field located
+ at <code class="code"><em class="replaceable"><code>field </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ which field to retrieve. The fields are numbered from <code>0</code> to <code class="function">INKMimeHdrFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code><code>) -1</code>.
+ If <code class="code"><em class="replaceable"><code>idx </code></em></code> does not lie
+ within that range,
+ then <code class="function">INKMimeHdrFieldValueGetDate</code> returns
+ <code>(</code><code class="code">time_t</code><code>) 0</code>. </p>
+</dd>
+<dd>
+ <p>All values are stored as strings within
+ the MIME field. <code class="function">INKMimeHdrFieldValueGetDate</code>
+ parses the string value to return an integer date
+ representation.</p>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd><p>The date value from the specified MIME header.</p></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueGetInt"></a>INKMimeHdrFieldValueGetInt</h3></div></div></div>
+<p>Gets an integer field value in a MIME field.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been replaced by <code class="function">INKMimeHdrFieldValueIntGet</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">int INKMimeHdrFieldValueGetInt (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, int
+ <em class="replaceable"><code>idx</code></em>, int
+ *<em class="replaceable"><code>value_len-ptr</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Retrieves an integer value from within the MIME field
+ located at <code class="code"><em class="replaceable"><code>field </code></em></code> within
+ the marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter
+ specifies which value within the field to retrieve. The fields
+ are numbered from <code>0</code> to <code class="function">INKMimeHdrFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code><code>) - 1</code>.
+ If <code class="code"><em class="replaceable"><code>idx </code></em></code> does not lie
+ within that range,
+ then <code class="function">INKMimeHdrFieldValueGetInt</code> returns
+ <code>(</code><code class="code">int</code><code>) 0</code>. </p>
+</dd>
+<dd>
+ <p>All values are stored as strings within
+ the MIME field. <code class="function">INKMimeHdrFieldValueGetInt</code>
+ parses the string value to return an integer.</p>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd>
+ <p>The integer value from the specified MIME field.</p></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueGetUint"></a>INKMimeHdrFieldValueGetUint</h3></div></div></div>
+<p>Gets unsigned integer field value in a MIME field.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been replaced by <code class="function">INKMimeHdrFieldValueUintGet</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">unsigned int INKMimeHdrFieldValueGetUint (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, int
+ <em class="replaceable"><code>idx</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Retrieves an unsigned integer value from within the MIME
+ field located at <code class="code"><em class="replaceable"><code>field </code></em></code>
+ within the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>. The
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ which field to retrieve. The fields are numbered from <code>0</code> to <code class="function">INKMimeHdrFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code><code>) - 1</code>.
+ If <code class="code"><em class="replaceable"><code>idx </code></em></code> does not lie
+ within that range,
+ then <code class="function">INKMimeHdrFieldValueGetUnit</code> returns
+ <code>(</code><code class="code">unsigned int</code><code>) 0</code>. All values are stored as strings
+ within the MIME field. <code class="function">INKMimeHdrFieldValueGetUint</code> parses the
+ string value to return an unsigned integer.</p>
+<p>It is not possible to determine if
+ <code class="function">INKMimeHdrFieldValueGetUint</code> is returning an
+ <code>unsigned int</code> value in error. If you need to check for errors in
+ MIME header field values, then you can fetch the header as a string
+ and examine it. </p>
+</dd>
+<dt><span class="term"><b>Returns</b></span></dt>
+<dd><p>The unsigned integer value from the specified MIME
+ field.</p></dd>
+<dt><span class="term"><b>Example</b></span></dt>
+<dd>
+ Below is some sample code that fetches MIME headers from marshal buffers into strings using <code>INKMimeHdrFieldValueGet</code> instead. The context of this example is that the plugin is processing an HTTP transaction and has access to a transaction.
+<pre class="programlisting">static void
+handle_string (INKHttpTxn txnp, INKCont contp) {
+ INKMBuffer bufp;
+ INKMLoc hdr_loc;
+ INKMLoc field;
+ int len;
+ char* output_string;
+ const char* value;
+/* Fetch the transaction's client request header into a marshal buffer. */
+ if (!INKHttpTxnClientReqGet (txnp, &bufp, &hdr_loc)) {
+ INKError ("couldn't retrieve client request header\n");
+ goto done;
+ }
+ field=INKMimeHdrFieldRetrieve(bufp, hdr_loc,
+ INK_MIME_FIELD_CONTENT_LENGTH);
+
+ if (!field) {
+ INKError ("Content-Length field not found.\n");
+ INKHandleMLocRelease (bufp, INK_NULL_MLOC, hdr_loc);
+ goto done;
+ }
+ /* Obtain the value of the content length (normally an
+ *unsigned int) as a string. */
+ value=INKMimeHdrFieldValueGet (bufp, hdr_loc, field, 0, &len);
+
+ if ((!value) || (len<=0))}
+ INKHandleMLocRelease (bufp, hdr_loc, field);
+ INKHandleMLocRelease (bufp, INK_NULL_MLOC, hdr_loc);
+ goto done;
+ }
+ /* Allocate the string with an extra byte for the string terminator. */
+ output_string = (char*) INKmalloc(len + 1);
+
+ /* Copy the value. */
+ strncpy (output_string, value, len);
+
+ /* Terminate the string */
+ output_string[len] = '\0';
+/* Now that you have the MIME fields as a string, you can do
+ whatever you want with it. For example: you can print it
+ or make sure it's an unsigned integer (by using the
+ atol C function or by scanning each ASCII character). */
+ INKDebug("my-plugin", "%s", output_string);
+</pre></dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueInsert"></a>INKMimeHdrFieldValueInsert</h3></div></div></div>
+<p>Inserts a value into a specified location within a MIME
+ field.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been replaced by <code class="function">INKMimeHdrFieldValueStringInsert</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMLoc INKMimeHdrFieldValueInsert (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, const char
+ *<em class="replaceable"><code>value</code></em>, int
+ <em class="replaceable"><code>length</code></em>, int
+ <em class="replaceable"><code>idx</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Inserts the string
+ <code class="code"><em class="replaceable"><code>value </code></em></code> into the MIME
+ field located at <code class="code"><em class="replaceable"><code>field </code></em></code>
+ within the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>If <code class="code"><em class="replaceable"><code>length </code></em></code> is <code>-1</code>, then <code class="function">INKMimeHdrFieldValueInsert</code> assumes that
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ null-terminated. Otherwise, the length of the string
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is taken to be
+ <code class="code"><em class="replaceable"><code> length</code></em></code>. </p>
+</dd>
+<dd>
+ <p><code>INKMimeHdrFieldValueInsert</code> copies the string to within <code class="code"><em class="replaceable"><code>bufp</code></em></code>, so it is okay to
+ modify or delete <code class="code"><em class="replaceable"><code>value </code></em></code>
+ after calling <code class="function">INKMimeHdrFieldValueSet</code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ where the inserted <code class="code"><em class="replaceable"><code>value </code></em></code>
+ should be put with respect to the other values already in the
+ MIME field. If <code class="code"><em class="replaceable"><code>idx </code></em></code> is <code>0</code>,
+ then <code class="function">INKMimeHdrFieldValueInsert</code> prepends
+ the <code class="code"><em class="replaceable"><code>value </code></em></code> to the list of
+ values in the field. Increasing values of
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> place the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> further down the
+ list of values. If <code class="code"><em class="replaceable"><code>idx </code></em></code>
+ is <code>-1</code>, then <code class="function">INKMimeHdrFieldValueInsert</code> appends
+ the <code class="code"><em class="replaceable"><code>value </code></em></code> to the list of
+ values. Normal usage is to specify <code>-1 </code>for <code class="code"><em class="replaceable"><code>idx </code></em></code> so that the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is appended to the
+ list of values.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueInsertDate"></a>INKMimeHdrFieldValueInsertDate</h3></div></div></div>
+<p>Inserts a date value into a MIME field.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been replaced by <code class="function">INKMimeHdrFieldValueDateInsert</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMLoc INKMimeHdrFieldValueInsertDate (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, time_t
+ <em class="replaceable"><code>value</code></em>, int
+ <em class="replaceable"><code>idx</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Inserts the data
+ <code class="code"><em class="replaceable"><code>value </code></em></code> into the MIME
+ field located at <code class="code"><em class="replaceable"><code>field </code></em></code>
+ within the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ where the inserted <code class="code"><em class="replaceable"><code>value </code></em></code>
+ should be put with respect to the other values already in the
+ MIME field. If <code class="code"><em class="replaceable"><code>idx </code></em></code> is <code>0</code>,
+ then the <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ prepended to the list of values in the field. Increasing values
+ of <code class="code"><em class="replaceable"><code>idx </code></em></code> places the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> further down the
+ list of values. If <code class="code"><em class="replaceable"><code>idx </code></em></code>
+ is <code>-1</code>, then the <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ appended to the list of values. Normal usage is to specify <code>-1</code> for <code class="code"><em class="replaceable"><code>idx </code></em></code> so that the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is appended to the
+ list of values. </p>
+</dd>
+<dd>
+ <p>All values are stored as strings within the MIME
+ field. <code class="function">INKMimeHdrFieldValueInsertDate</code>
+ simply formats the date into a string and then calls
+ <code class="function">INKMimeHdrFieldValueInsert</code>.</p>
+ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
+ <tr>
+ <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png" /></td>
+ <th align="left">Note</th>
+ </tr>
+ <tr><td align="left" valign="top"><p>Do not use the return value
+ (<code class="function">INKMLoc</code>) of this function. Future
+ versions will be changed to <code>void</code>.</p></td></tr>
+ </table></div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueInsertInt"></a>INKMimeHdrFieldValueInsertInt</h3></div></div></div>
+<p>Inserts an integer value into a MIME field.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been succeeded by <code class="function">INKMimeHdrFieldValueIntInsert</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMLoc INKMimeHdrFieldValueInsertInt (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, int
+ <em class="replaceable"><code>value</code></em>, int
+ <em class="replaceable"><code>idx</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Inserts the integer
+ <code class="code"><em class="replaceable"><code>value </code></em></code> into the MIME
+ field located at <code class="code"><em class="replaceable"><code>field </code></em></code>
+ within the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ where the inserted <code class="code"><em class="replaceable"><code>value </code></em></code>
+ should be put with respect to the other values already in the
+ MIME field. If <code class="code"><em class="replaceable"><code>idx </code></em></code> is <code>0</code>,
+ then the <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ prepended to the list of values in the field. Increasing values
+ of <code class="code"><em class="replaceable"><code>idx </code></em></code> places the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> further down the
+ list of values. If <code class="code"><em class="replaceable"><code>idx </code></em></code>
+ is <code>-1</code>, then the <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ appended to the list of values. Normal usage is to specify <code>-1</code> for <code class="code"><em class="replaceable"><code>idx </code></em></code> so that the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is appended to the
+ list of values. </p>
+</dd>
+<dd>
+ <p>All values are stored as strings within the MIME
+ field. <code class="function">INKMimeHdrFieldValueInsertInt</code> simply
+ formats the integer into a string and then calls
+ <code class="function">INKMimeHdrFieldValueInsert</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueInsertUint"></a>INKMimeHdrFieldValueInsertUint</h3></div></div></div>
+<p>Inserts an unsigned integer value into a MIME field.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been succeeded by <code class="function">INKMimeHdrFieldValueUintInsert</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMLoc INKMimeHdrFieldValueInsertUint (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, unsigned int
+ <em class="replaceable"><code>value</code></em>, int
+ <em class="replaceable"><code>idx</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Inserts the unsigned integer
+ <code class="code"><em class="replaceable"><code>value </code></em></code> into the MIME
+ field located at <code class="code"><em class="replaceable"><code>field </code></em></code>
+ within the marshal buffer
+ <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ where the inserted <code class="code"><em class="replaceable"><code>value </code></em></code>
+ should be put with respect to the other values already in the
+ MIME field. If <code class="code"><em class="replaceable"><code>idx </code></em></code> is <code>0</code>, then the <code class="code"><em class="replaceable"><code>value </code></em></code>is
+ prepended to the list of values in the field. Increasing values
+ of <code class="code"><em class="replaceable"><code>idx </code></em></code> place the
+ <code class="code"><em class="replaceable"><code>value </code></em></code> further down the
+ list of values. If <code class="code"><em class="replaceable"><code>idx </code></em></code>
+ is <code>-1</code>, then the <code class="code"><em class="replaceable"><code>value </code></em></code> is appended to the list of values. Normal usage is to
+ specify <code>-1</code> for <code class="code"><em class="replaceable"><code>idx </code></em></code> so
+ that the <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ appended to the list of values.</p>
+</dd>
+<dd>
+ <p> All values are stored as strings
+ within the MIME field. <code class="function">INKMimeHdrFieldValueInsertUint</code> simply
+ formats the unsigned integer into a string and then calls
+ <code class="function">INKMimeHdrFieldValueInsert</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueSet"></a>INKMimeHdrFieldValueSet</h3></div></div></div>
+<p>Sets a value in a MIME field.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been succeeded by <code class="function">INKMimeHdrFieldValueStringSet</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeHdrFieldValueSet (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, int
+ <em class="replaceable"><code>idx</code></em>, const char
+ *<em class="replaceable"><code>value</code></em>, int
+ <em class="replaceable"><code>length</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Sets a value in the MIME field located at
+ <code class="code"><em class="replaceable"><code>field </code></em></code> within the marshal
+ buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to the
+ string <code class="code"><em class="replaceable"><code>value</code></em></code>. </p>
+</dd>
+<dd>
+ <p>If <code class="code"><em class="replaceable"><code>length </code></em></code> is <code>-1</code>, then it is
+ assumed that <code class="code"><em class="replaceable"><code>value </code></em></code> is
+ null-terminated. Otherwise, the length of the string
+ <code class="code"><em class="replaceable"><code>value </code></em></code> is taken to be
+ <code class="code"><em class="replaceable"><code>length</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The string is
+ copied to within <code class="code"><em class="replaceable"><code>bufp</code></em></code>,
+ so it is okay to modify or delete
+ <code class="code"><em class="replaceable"><code>value </code></em></code> after calling
+ <code class="function">INKMimeHdrFieldValueSet</code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ which value in the field to change. If
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between <code>0</code> and <code class="function">INKMimeHdrFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code><code>) - 1</code>,
+ then no operation is performed.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueSetDate"></a>INKMimeHdrFieldValueSetDate</h3></div></div></div>
+<p>Sets the date value in a MIME field.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeHdrFieldValueSetDate (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, int
+ <em class="replaceable"><code>idx</code></em>, time_t
+ <em class="replaceable"><code>value</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+ <p>Sets a value in the MIME field located at
+ <code class="code"><em class="replaceable"><code>field </code></em></code> within the marshal
+ buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to the date
+ <code class="code"><em class="replaceable"><code>value</code></em></code>. </p></dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ which value in the field to change. If the
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between <code>0</code> and <code class="function">INKMimeHdrFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code><code>) -1</code>,
+ then no operation is performed. </p>
+</dd>
+<dd>
+ <p>All values are stored as
+ strings within the MIME field. <code class="function">INKMimeHdrFieldValueSetDate</code> simply formats
+ the date into a string and then calls
+ <code class="function">INKMimeHdrFieldValueSet</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueSetInt"></a>INKMimeHdrFieldValueSetInt</h3></div></div></div>
+<p>Sets an integer value within a MIME field.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been succeeded by <code class="function">INKMimeHdrFieldValueIntSet</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeHdrFieldValueSetInt (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, int
+ <em class="replaceable"><code>idx</code></em>, int
+ <em class="replaceable"><code>value</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Sets a value in the MIME field located at
+ <code class="code"><em class="replaceable"><code>field </code></em></code> within the marshal
+ buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to the
+ integer <code class="code"><em class="replaceable"><code>value</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter specifies
+ which value in the field to change. If
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between<code> 0</code> and <code class="function">INKMimeHdrFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code><code>) - 1</code>,
+ then no operation is performed. </p>
+</dd>
+<dd>
+ <p>All values are stored as
+ strings within the MIME field. <code class="function">INKMimeHdrFieldValueSetInt</code> simply formats
+ the integer into a string and then calls
+ <code class="function">INKMimeHdrFieldValueSet</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldValueSetUint"></a>INKMimeHdrFieldValueSetUint</h3></div></div></div>
+<p>Sets a value in a MIME field to a specified unsigned
+ integer.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been replaced by <code class="function">INKMimeHdrFieldValueUintSet</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeHdrFieldValueSetUint (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, int
+ <em class="replaceable"><code>idx</code></em>, unsigned int
+ <em class="replaceable"><code>value</code></em>) </code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Sets a value in the MIME field located at
+ <code class="code"><em class="replaceable"><code>field </code></em></code> within the marshal
+ buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> to the
+ unsigned integer <code class="code"><em class="replaceable"><code>value</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>idx </code></em></code> parameter
+ specifies which value in the field to change. If
+ <code class="code"><em class="replaceable"><code>idx </code></em></code> is not between <code>0</code> and <code class="function">INKMimeHdrFieldValuesCount</code>
+ <code>(</code><code class="code"><em class="replaceable"><code>bufp, hdr, field</code></em></code><code>) - 1</code>,
+ then no operation is performed. </p>
+</dd>
+<dd>
+ <p>All values are stored as
+ strings within the MIME field. <code class="function">INKMimeHdrFieldValueSetUint</code> simply formats
+ the unsigned integer into a string and then calls
+ <code class="function">INKMimeHdrFieldValueSet</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldDelete"></a>INKMimeHdrFieldDelete</h3></div></div></div>
+<p>Destroys a MIME header field.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been replaced by <code class="function">INKMimeHdrFieldDestroy</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeHdrFieldDelete (INKMBuffer
+
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr_loc</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Deletes the MIME field located at
+ <code class="code"><em class="replaceable"><code>field </code></em></code> within the MIME
+ header located at
+ <code class="code"><em class="replaceable"><code>hdr_loc </code></em></code> in the marshal
+ buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.</p>
+<p>Make sure you release the <code class="function">INKMLoc</code>
+ handle field with a call to
+ <code class="function">INKHandleMLocRelease</code>.</p>
+</dd>
+</dl></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldInsert"></a>INKMimeHdrFieldInsert</h3></div></div></div>
+<p>Appends a field in a MIME header. </p>
+<p><b>Note: </b>This API is <u>deprecated</u> and has been replaced by <code class="function">INKMimeHdrFieldAppend</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">void INKMimeHdrFieldInsert (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr_loc</code></em>, INKMLoc
+ <em class="replaceable"><code>field</code></em>, int
+ <em class="replaceable"><code>idx</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Appends the MIME field located at
+ <code class="code"><em class="replaceable"><code>field </code></em></code> within the marshal
+ buffer <code class="code"><em class="replaceable"><code>bufp </code></em></code> into the
+ MIME header located at
+ <code class="code"><em class="replaceable"><code>hdr_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><i>idx </i></code> parameter specifies where the inserted field
+ should be put with respect to the other fields already in the
+ MIME header.</p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="INKMimeHdrFieldRetrieve"></a>INKMimeHdrFieldRetrieve</h3></div></div></div>
+<p>Retrieves a MIME header field.</p>
+<p><b>Note:</b> This API is <u>deprecated</u> and has been replaced by <code class="function">INKMimeHdrFieldFind</code>.</p>
+<div class="variablelist"><dl>
+<dt><span class="term"><b>Prototype</b></span></dt>
+<dd><p><code class="code">INKMLoc INKMimeHdrFieldRetrieve (INKMBuffer
+ <em class="replaceable"><code>bufp</code></em>, INKMLoc
+ <em class="replaceable"><code>hdr_loc</code></em>, const char*
+ *<em class="replaceable"><code>retrieved_str</code></em>)</code></p></dd>
+<dt><span class="term"><b>Description</b></span></dt>
+<dd>
+<p>Retrieves a MIME field from within the MIME header located
+ at <code class="code"><em class="replaceable"><code>hdr_loc </code></em></code> within the
+ marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>. </p>
+</dd>
+<dd>
+ <p>The <code class="code"><em class="replaceable"><code>retrieved_str </code></em></code> parameter
+ specifies which field to retrieve. For each MIME field in the
+ MIME header, a pointer comparison is done between the field name
+ and <code class="code"><em class="replaceable"><code>retrieved_str</code></em></code>. This
+ is a much quicker retrieval function than
+ <code class="function">INKMimeHdrFieldFind</code>, since it obviates the
+ need for a string comparision. However,
+ <code class="code"><em class="replaceable"><code> retrieved_str </code></em></code> must be
+ one of the predefined field names listed above (of the form
+ <code class="code">INK_MIME_FIELD_XXX</code>) in order for the call to succeed. If the
+ requested field cannot be found, then <code>0</code> is returned.</p>
+ <p>Release with a call to
+ <code class="function">INKHandleMLocRelease</code>.</p>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+</div>
+</body>
+</html>
Propchange: websites/staging/trafficserver/trunk/content/docs/v2/sdk/App_DeprecatedFunctions.html
------------------------------------------------------------------------------
svn:executable = *