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>CalculateSha256</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/crypto/Overview.html">crypto</a>::CalculateSha256</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14void CalculateSha256(
15     void * pOut,
16     const void * pData,
17     size_t size
18);
19</pre>
20    </div>
21<h2>Parameters</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>pOut</th>
34<td>Pointer to the location in which to store the SHA-256 value (4-byte alignment)</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>pData</th>
39<td>Pointer to the input data.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>size</th>
44<td>Length of the input data.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48    <div class="section">
49None.
50               </div>
51<h2>Description</h2>
52    <div class="section">
53<p>Utility function that encompasses a sequence of operations used for SHA-256 calculation.</p><p><span class="argument">pOut</span> is a 4-byte aligned pointer. It requires <CODE>Sha256Context::HASH_SIZE (=32)</CODE> bytes of space as the destination for storing the indicated hash.
54            </p><p>
55This function can only calculate the hash for a single clump of data. It thus cannot be used to calculate hashes for data that is read by means of multiple updates, such as streaming data.
56            </p></div>
57<h2>Revision History</h2>
58    <div class="section">
59      <dl class="history">
60        <dt>2011/03/04</dt>
61<dd>Added note about 4-byte alignment restriction.<br />
62        </dd>
63        <dt>2010/01/07</dt>
64<dd>Initial version.<br />
65        </dd>
66      </dl>
67    </div>
68  <hr><p>CONFIDENTIAL</p></body>
69</html>
70