1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7<title>GetHeaderField</title>
8  </head>
9  <body>
10<h1><CODE>nn::http::Connection::GetHeaderField</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> GetHeaderField(
15     const char * pLabel,
16     char * pFieldBuf,
17     size_t bufSize,
18     const <a href="../../../nn/fnd/TimeSpan/Overview.html">nn::fnd::TimeSpan</a> & timeout,
19     size_t * pFieldLengthCourier = NULL
20) const;
21</pre>
22    </div>
23<h2>Arguments</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29<th>Name</th>
30<td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34<td>in</td>
35<th>pLabel</th>
36<td>Label name.</td>
37        </tr>
38        <tr>
39<td>out</td>
40<th>pFieldBuf</th>
41<td>Buffer that stores the field value.</td>
42        </tr>
43        <tr>
44<td>in</td>
45<th>bufSize</th>
46<td>Data size of <SPAN class="argument">pFieldBuf</SPAN>.</td>
47        </tr>
48        <tr>
49<td>in</td>
50<th>timeout</th>
51<td>Timeout interval.</td>
52        </tr>
53        <tr>
54<td>out</td>
55<th>pFieldLengthCourier</th>
56<td>Buffer that stores the data size of the field value. This argument can be omitted if you don't need the data size of the field value.</td>
57        </tr> </table>
58    </div>
59<h2>Return Values</h2>
60<div class="section">Returns the function's execution result. Returns one of the <a href="../../nn/Result/Overview.html"><CODE>Result</CODE></A></a> values listed below. <br />
61      <table class="arguments">
62        <thead>
63          <tr>
64<th>Value</th>
65<td>Description</td>
66          </tr>
67        </thead>
68        <tr>
69<th><CODE>ResultSuccess</CODE></th>
70<td>Process was successful.</td>
71        </tr>
72        <tr>
73<th>ResultTimeout</th>
74<td>Error indicating a timeout.</td>
75        </tr>
76        <tr>
77<th>A value other than the above.</th>
78<td>Same as for the <a href="../../../nn/http/Connection/GetHeaderField.html"><CODE>GetHeaderField</CODE></a> function version that has no timeout argument.</td>
79        </tr>
80      </table> </div>
81<h2>Description</h2>
82    <div class="section">
83<p>This version of <a href="../../../nn/http/Connection/GetHeaderField.html"><CODE>GetHeaderField</CODE></a> has a timeout.</p><p>Other than allowing the user to specify a timeout, this version functions identically to <a href="../../../nn/http/Connection/GetHeaderField.html"><CODE>GetHeaderField</CODE></a>. For feature details, see the function reference for the version without a timeout. Returns <a href="../../../nn/http/ResultTimeout/Overview.html"><CODE>ResultTimeout</CODE></a> if no HTTP response header has been fully received within the timeout period. If <CODE>ResultTimeout</CODE> is returned, the connection is automatically canceled. (In other words, the function internally implements <a href="../../../nn/http/Connection/Cancel.html"><CODE>Cancel</CODE></a>.)<br /></p><!-- write here --></div>
84<h2>Revision History</h2>
85    <div class="section">
86      <dl class="history">
87        <dt>2010/06/14</dt>
88<dd>Initial version.<br />
89        </dd>
90      </dl>
91    </div>
92  <hr><p>CONFIDENTIAL</p></body>
93</html>