trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dia...@apache.org
Subject svn commit: r933779 - /incubator/trafficserver/site/trunk/docs/v2/sdk/URLFunctions.html
Date Tue, 13 Apr 2010 20:58:26 GMT
Author: dianes
Date: Tue Apr 13 20:58:26 2010
New Revision: 933779

URL: http://svn.apache.org/viewvc?rev=933779&view=rev
Log:
text edits + ts-233

Modified:
    incubator/trafficserver/site/trunk/docs/v2/sdk/URLFunctions.html

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/URLFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/URLFunctions.html?rev=933779&r1=933778&r2=933779&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/URLFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/URLFunctions.html Tue Apr 13 20:58:26 2010
@@ -13,7 +13,40 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="URLFunctions"></a>URL Functions</h3></div></div></div>
-<p>The URL functions are listed below.</p>
+
+<ul><b>
+<li><a href="URLFunctions.html#INKUrlClone">INKUrlClone</a></li>
+<li><a href="URLFunctions.html#INKUrlCopy">INKUrlCopy</a></li>
+<li><a href="URLFunctions.html#INKUrlCreate">INKUrlCreate</a></li>
+<li><a href="URLFunctions.html#INKUrlDestroy">INKUrlDestroy</a></li>
+<li><a href="URLFunctions.html#INKUrlPrint">INKUrlPrint</a></li>
+<li><a href="URLFunctions.html#INKUrlFtpTypeGet">INKUrlFtpTypeGet</a></li>
+<li><a href="URLFunctions.html#INKUrlFtpTypeSet">INKUrlFtpTypeSet</a></li>
+<li><a href="URLFunctions.html#INKUrlHostGet">INKUrlHostGet</a></li>
+<li><a href="URLFunctions.html#INKUrlHostSet">INKUrlHostSet</a></li>
+<li><a href="URLFunctions.html#INKUrlHttpFragmentGet">INKUrlHttpFragmentGet</a></li>
+<li><a href="URLFunctions.html#INKUrlHttpFragmentSet">INKUrlHttpFragmentSet</a></li>
+<li><a href="URLFunctions.html#INKUrlHttpParamsGet">INKUrlHttpParamsGet</a></li>
+<li><a href="URLFunctions.html#INKUrlHttpParamsSet">INKUrlHttpParamsSet</a></li>
+<li><a href="URLFunctions.html#INKUrlHttpQueryGet">INKUrlHttpQueryGet</a></li>
+<li><a href="URLFunctions.html#INKUrlHttpQuerySet">INKUrlHttpQuerySet</a></li>
+<li><a href="URLFunctions.html#INKUrlLengthGet">INKUrlLengthGet</a></li>
+<li><a href="URLFunctions.html#INKUrlParse">INKUrlParse</a></li>
+<li><a href="URLFunctions.html#INKUrlPasswordGet">INKUrlPasswordGet</a></li>
+<li><a href="URLFunctions.html#INKUrlPasswordSet">INKUrlPasswordSet</a></li>
+<li><a href="URLFunctions.html#INKUrlPathGet">INKUrlPathGet</a></li>
+<li><a href="URLFunctions.html#INKUrlPathSet">INKUrlPathSet</a></li>
+<li><a href="URLFunctions.html#INKUrlPortGet">INKUrlPortGet</a></li>
+<li><a href="URLFunctions.html#INKUrlPortSet">INKUrlPortSet</a></li>
+<li><a href="URLFunctions.html#INKUrlSchemeGet">INKUrlSchemeGet</a></li>
+<li><a href="URLFunctions.html#INKUrlSchemeSet">INKUrlSchemeSet</a></li>
+<li><a href="URLFunctions.html#INKUrlStringGet">INKUrlStringGet</a></li>
+<li><a href="URLFunctions.html#INKUrlUserGet">INKUrlUserGet</a></li>
+<li><a href="URLFunctions.html#INKUrlUserSet">INKUrlUserSet</a></li>
+
+</b>
+</ul>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKUrlClone"></a>INKUrlClone</h4></div></div></div>
@@ -48,7 +81,7 @@
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>Returns the <code class="function">INKMLoc</code> location of the
+<p>The <code class="function">INKMLoc</code> location of the
                 copied URL.</p>
 <p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
 </dd>
@@ -86,13 +119,15 @@
                 <code class="code"><em class="replaceable"><code>src_bufp
</code></em></code> to the
                 location <code class="code"><em class="replaceable"><code>dest_url_loc
</code></em></code>
                 within the marshal buffer
-                <code class="code"><em class="replaceable"><code>dest_bufp</code></em></code>.
-                <code class="function">INKUrlCopy</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. It is important to create the destination
-                URL (its marshal buffer and <code class="function">INKMLoc</code>)
before you copy into it.</p>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+                <code class="code"><em class="replaceable"><code>dest_bufp</code></em></code>.
               </p>
+</dd>
+<dd>
+  <p><code class="function">INKUrlCopy</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. It is important to create the destination
+    URL (its marshal buffer and <code class="function">INKMLoc</code>) before
you copy into it.</p>
+  <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -149,7 +184,7 @@
 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png"
/></td>
 <th align="left">Caution</th>
 </tr>
-<tr><td align="left" valign="top"><p>Do not forget to release the handle

+<tr><td align="left" valign="top"><p>Don't forget to release the handle

                   <code class="code"><em class="replaceable"><code> url_loc
</code></em></code> with a call
                   to <code class="function">INKHandleMLocRelease</code>.</p></td></tr>
 </table></div>
@@ -206,7 +241,7 @@
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>Returns <code>65</code> if the FTP type is ASCII.</p>
-<p>Return <code>73</code> if the FTP type is binary.</p>
+<p>Returns <code>73</code> if the FTP type is binary.</p>
 <p><code class="code">INK_ERROR_PTR</code> if an error occurs.</p>
 </dd>
 </dl></div>
@@ -292,15 +327,21 @@
 <p>Sets the host portion of the URL located at
                 <code class="code"><em class="replaceable"><code>url_loc
</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><em><code>
</code></em> is -1, then <code class="function">INKUrlHostSet</code>
assumes that value 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>.
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">INKUrlHostSet</code>.</p>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+                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><em><code>
</code></em> is  <code>-1</code>, then <code class="function">INKUrlHostSet</code>
assumes that value 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">INKUrlHostSet</code>.</p>
+  <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -364,17 +405,21 @@
 <p>Sets the HTTP fragment portion of the URL located at
                 <code class="code"><em class="replaceable"><code>url_loc
</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 -1, then
-                <code class="function">INKUrlHttpFragmentSet</code> assumes that
value
-                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>.
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">INKUrlHttpFragmentSet</code>.</p>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+                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 <code class="function">INKUrlHttpFragmentSet</code>
assumes that value
+    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">INKUrlHttpFragmentSet</code>.</p>
+  <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -438,18 +483,21 @@
 <p>Sets the HTTP params portion of the URL located at
                 <code class="code"><em class="replaceable"><code>url_loc
</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 -1, then
-                <code class="function">INKUrlHttpParamsSet</code> assumes that
value 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>.
-                <code class="function">INKUrlHttpParamsSet</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>INKUrlHttpParamsSet</code>.</p>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+                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 <code class="function">INKUrlHttpParamsSet</code>
assumes that value 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 class="function">INKUrlHttpParamsSet</code> copies the string
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>INKUrlHttpParamsSet</code>.</p>
+  <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -512,18 +560,21 @@
 <p>Sets the HTTP query portion of the URL located at
                 <code class="code"><em class="replaceable"><code>url_loc
</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 -1, then
-                <code class="function">INKUrlHttpQuerySet</code> assumes that
value 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>.
-                <code class="function">INKUrlHttpQuerySet</code> copies the string
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">INKUrlHttpQuerySet</code>.</p>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+                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 <code class="function">INKUrlHttpQuerySet</code>
assumes that value 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 class="function">INKUrlHttpQuerySet</code> copies the string
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">INKUrlHttpQuerySet</code>.</p>
+  <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -543,7 +594,7 @@
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
 <p>Calculates the length of URL located at  <code class="code"><em class="replaceable"><code>
url_loc </code></em></code> within the
-                marshal buffer <code class="code"><em class="replaceable"><code>bufp
</code></em></code> if
+                marshal buffer <code class="code"><em class="replaceable"><code>bufp
</code>,</em></code> if
                 it was returned as a string. This length is the same as
                 the length returned by
                 <code class="function">INKUrlStringGet</code>.</p>
@@ -574,23 +625,25 @@
                 an input and an output parameter, and marks the start of the
                 URL to be parsed. After a successful parse, the
                 <code class="code"><em class="replaceable"><code>start
</code></em></code> pointer equals
-                the <code class="code"><em class="replaceable"><code> end
</code></em></code> pointer. The
-                <code class="code"><em class="replaceable"><code>end </code></em></code>
pointer must be
-                one byte after the last character you want to parse.The URL
-                parsing routine assumes that everything between
-                <code class="code"><em class="replaceable"><code>start
</code></em></code> and
-                <code class="code"><em class="replaceable"><code>end </code></em></code>
is part of the
-                URL. It is up to higher-level parsing routines, such as
-                <code class="function">INKHttpHdrParseReq</code>, to determine
the
-                actual end of the URL.</p>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+                the <code class="code"><em class="replaceable"><code> end
</code></em></code> pointer. </p>
+</dd>
+<dd>
+  <p>The <code class="code"><em class="replaceable"><code>end </code></em></code>
pointer must be
+    one byte after the last character you want to parse.The URL
+    parsing routine assumes that everything between
+    <code class="code"><em class="replaceable"><code>start </code></em></code>
and
+    <code class="code"><em class="replaceable"><code>end </code></em></code>
is part of the
+    URL. It is up to higher-level parsing routines, such as
+    <code class="function">INKHttpHdrParseReq</code>, to determine the
+    actual end of the URL.</p>
+  <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-  <p>Returns <code class="code">INK_PARSE_DONE</code> if
+  <p><code class="code">INK_PARSE_DONE</code> if
     successful.</p></dd>
 <dd>
-  <p>Returns <code class="code">INK_PARSE_ERROR</code> if an error occurs.</p>
+  <p><code class="code">INK_PARSE_ERROR</code> if an error occurs.</p>
 </dd>
 </dl>
 </div>
@@ -650,18 +703,21 @@
 <p>Sets the password portion of the URL located at
                 <code class="code"><em class="replaceable"><code>url_loc
</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 -1, then
-                <code class="function">INKUrlPasswordSet</code> assumes that
value 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>.
-                <code class="function">INKUrlPasswordSet</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">INKUrlPasswordSet</code>.</p>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+                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 <code class="function">INKUrlPasswordSet</code>
assumes that value 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 class="function">INKUrlPasswordSet</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">INKUrlPasswordSet</code>.</p>
+  <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -703,7 +759,7 @@
 <th align="left">Note</th>
 </tr>
 <tr><td align="left" valign="top"><p>The returned string is not guaranteed
to be
-                  null-terminated. If the URL contains a query portion, then it is not included
in the response (see <a href="#INKUrlHttpQueryGet">INKUrlHttpQueryGet)</a>.</p></td></tr>
+                  null-terminated. If the URL contains a query portion, then it is not included
in the response (see <a href="#INKUrlHttpQueryGet"><code>INKUrlHttpQueryGet</code>)</a>.</p></td></tr>
 </table></div>
 </dd>
 <dt>&nbsp;</dt>
@@ -725,17 +781,20 @@
 <p>Sets the path portion of the URL located at
                 <code class="code"><em class="replaceable"><code>url_loc
</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 -1, then
-                <code class="function">INKUrlPathSet</code> assumes that value
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>.
-                <code class="function">INKUrlPathSet</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">INKUrlPathSet</code>.</p>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+                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 <code class="function">INKUrlPathSet</code>
assumes that value 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 class="function">INKUrlPathSet</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">INKUrlPathSet</code>.</p>
+  <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -849,18 +908,19 @@
 <p>Sets the scheme portion of the URL located at
                 <code class="code"><em class="replaceable"><code>url_loc
</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 -1, then
-                <code class="function">INKUrlSchemeSet</code> assumes that value
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>.
-                <code class="function">INKUrlSchemeSet</code> copies the string
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">INKUrlSchemeSet</code>.</p>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+                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 <code class="function">INKUrlSchemeSet</code>
assumes that value 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>.
+    <code class="function">INKUrlSchemeSet</code> copies the string 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">INKUrlSchemeSet</code>.</p>
+  <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -885,18 +945,21 @@
 <dd>
 <p>Constructs a string representation of the URL located at
                 <code class="code"><em class="replaceable"><code>url_loc
</code></em></code> within the
-                marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
-                <code class="function">INKUrlStringGet</code> stores the length
of the
-                allocated string in the parameter
-                <code class="code"><em class="replaceable"><code>length
</code></em></code> (this is the
-                same <code>length</code> that <code class="function">INKUrlLengthGet</code>
returns).
-                The returned string is allocated by a call to
-                <code class="function">INKmalloc</code>; it should be freed by
a call
-                to <code class="function">INKfree</code>. 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>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+                marshal buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
               </p>
+</dd>
+<dd>
+  <p><code class="function">INKUrlStringGet</code> stores the length of
the
+    allocated string in the parameter
+    <code class="code"><em class="replaceable"><code>length </code></em></code>
(this is the
+    same <code class="code"><em class="replaceable"><code>length</code></em>
</code>that <code class="function">INKUrlLengthGet</code> returns).    </p>
+</dd>
+<dd>
+  <p>The returned string is allocated by a call to <code class="function">INKmalloc</code>;
it should be freed by a call
+    to <code class="function">INKfree</code>. 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>
+  <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -957,27 +1020,34 @@
                 <em class="replaceable"><code>length</code></em>)
</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Sets the user portion of the URL located at
-                <code class="code"><em class="replaceable"><code>url_loc
</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 -1, then
-                <code class="function">INKUrlUserSet</code> assumes that value
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>.
<code class="function">INKUrlUserSet</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">INKUrlUserSet</code>.</p>
-<p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
-</dd>
-<dt><span class="term"><b>Returns</b></span></dt>
-<dd>
-<p><code class="code">INK_SUCCESS</code> if successful.</p>
-<p><code class="code">INK_ERROR</code> if an error occurs.</p>
+  <p>Sets the user portion of the URL located at
+    <code class="code"><em class="replaceable"><code>url_loc </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>
-</dl></div>
+</dl>
+  <dl>
+    <dd>
+    <p>If <code class="code"><em class="replaceable"><code>length
</code></em></code> is <code>-1</code>, then <code class="function">INKUrlUserSet</code>
assumes that value 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 class="function">INKUrlUserSet</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">INKUrlUserSet</code>.</p>
+      <p>If it is in a transaction header, then call after <code class="code">READ_REQUEST_HDR_HOOK</code>.</p>
+    </dd>
+  <dt><span class="term"><b>Returns</b></span></dt>
+  <dd>
+    <p><code class="code">INK_SUCCESS</code> if successful.</p>
+    <p><code class="code">INK_ERROR</code> if an error occurs.</p>
+  </dd>
+  </dl>
+</div>
 </div>
 </div>
 </body>



Mime
View raw message