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     size_t * pFieldLengthCourier = NULL
19) const;
20</pre>
21    </div>
22<h2>Arguments</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>in</td>
34<th>pLabel</th>
35<td>Label name.</td>
36        </tr>
37        <tr>
38<td>out</td>
39<th>pFieldBuf</th>
40<td>Buffer that stores the field value.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>bufSize</th>
45<td>Data size of <SPAN class="argument">pFieldBuf</SPAN>.</td>
46        </tr>
47        <tr>
48<td>out</td>
49<th>pFieldLengthCourier</th>
50<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>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">Returns the result of the operation.<br /> </div>
55<h2>Description</h2>
56    <div class="section">
57<p>Gets the field value that matches the specified label. This field value is obtained from the message header of the HTTP response that was received.</p><p>This function will block until the header is completely received. The receive operation completes if the following conditions are met.<br />・ All header data has been received.<br />・ The operation was cancelled.<br />・ A communication error occurred (for example, DNS name resolution failed).<br />If the header was already completely received by another function, this function will return the response immediately.<br /><br /><BR><B>Note:</B> If the <SPAN class="argument">pFieldBuf</SPAN> size is smaller than the field value size, as much data is stored in <SPAN class="argument">pFieldBuf</SPAN> as will fit, and the field value size is stored in <SPAN class="argument">pFieldLengthCourier</SPAN>.<br /><BR><B>Note:</B> If <SPAN class="argument">pFieldBuf</SPAN><CODE>==NULL</CODE> or <SPAN class="argument">bufSize</SPAN><CODE>==0</CODE>, and if <SPAN class="argument">pFieldLengthCourier</SPAN><CODE>!=NULL</CODE>, the field length is stored in <SPAN class="argument">pFieldLengthCourier</SPAN>.<br /><B>Note:</B> Unlike <CODE><a href="../../../nn/http/Connection/GetHeaderField.html">GetHeaderField</a> </CODE>, this function does not have an attached timeout.  In other words, the process will not return from this function until processing has ended.<br />For this reason, in environments where communications are slow you can expect a long time to pass before the process ends and returns from this function.<br /></p><!-- write here --></div>
58<h2>Revision History</h2>
59    <div class="section">
60      <dl class="history">
61        <dt>2010/06/14</dt>
62<dd>Initial version.<br />
63        </dd>
64      </dl>
65    </div>
66  <hr><p>CONFIDENTIAL</p></body>
67</html>