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>GetHeaderAll</title>
8  </head>
9  <body>
10<h1><CODE>nn::http::Connection::GetHeaderAll</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> GetHeaderAll(
15     char * pHeaderBuf,
16     size_t bufSize,
17     size_t * pLengthCourier = NULL
18) const;
19</pre>
20    </div>
21<h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27<th>Name</th>
28<td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32<td>out</td>
33<th>pHeaderBuf</th>
34<td>Buffer that stores the message header.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>bufSize</th>
39<td>Data size of <SPAN class="argument">pHeaderBuf</SPAN>.</td>
40        </tr>
41        <tr>
42<td>out</td>
43<th>pLengthCourier</th>
44<td>Buffer that stores the size of the message header. This argument can be omitted if the size of the message header is not required.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the function's execution result. The <a href="../../../nn/Result/Overview.html"><CODE>Result</CODE></a> value is the same as for the <a href="../../../nn/http/Connection/GetHeaderField.html"><CODE>GetHeaderField</CODE></a> function version that has no timeout argument. </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Gets the message header for the HTTP response that was received.</p><p>This function blocks until the header is completely received. See the description of <a href="../../../nn/http/Connection/GetHeaderField.html"><CODE>GetHeaderField</CODE></a> for more details about this specification.<br /><BR><B>Note:</B> If the <SPAN class="argument">pHeaderBuf</SPAN> size is smaller than the header size, as much data is stored in <SPAN class="argument">pHeaderBuf</SPAN> as will fit, and the header size is stored in <SPAN class="argument">pLengthCourier</SPAN>.<br /><BR><B>Note:</B> If <SPAN class="argument">pHeaderBuf</SPAN><CODE>==NULL</CODE> or <SPAN class="argument">bufSize</SPAN><CODE>==0</CODE>, and if <SPAN class="argument">pLengthCourier</SPAN><CODE>!=NULL</CODE>, the field length is stored in <SPAN class="argument">pLengthCourier</SPAN>. <BR><BR><B>Note:</B> Unlike the version of <CODE><a href="../../../nn/http/Connection/GetHeaderAll.html">GetHeaderAll</a></CODE> that includes a timeout, this function does not time out. In other words, control will not return from this function until processing has ended. In environments where communications are slow you can expect a long time to pass before processing ends and control returns from this function.<br /></p><!-- write here --></div>
52<h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2010/06/14</dt>
56<dd>Initial version.<br />
57        </dd>
58      </dl>
59    </div>
60  <hr><p>CONFIDENTIAL</p></body>
61</html>