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>DoHandshake</title>
8  </head>
9  <body>
10<h1><CODE>nn::ssl::Connection::DoHandshake</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> DoHandshake(
15     size_t * pServerCertSize,
16     u32 * pServerCertNum = NULL
17);
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>out</td>
32<th>pServerCertSize</th>
33<td>Buffer storing the size of the saved server certificate data.</td>
34        </tr>
35        <tr>
36<td>out</td>
37<th>pServerCertNum</th>
38<td>Buffer storing the number of saved server certificates. (This is used to get the number of certificates in the certificate chain if the <CODE>GET_ALL_SERVER_CERT_CHAIN</CODE> option is enabled and all certificate data in the server certificate chain has been saved. It can be omitted if the number of certificates is not required. This could be the case, for example, if you are only getting the server certificate.)</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns the function's execution result. Returns one of the <a href="../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below. <br />
43      <table class="arguments">
44        <thead>
45          <tr>
46<th>Value</th>
47<td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51<th><CODE>ResultSuccess</CODE></th>
52<td>Process was successful.</td>
53        </tr>
54        <tr>
55<th>ResultFailToGetServerCert</th>
56<td>Because the certificate data's size was bigger than the buffer configured by the <CODE>SetServerCertBuffer</CODE> function, not all data was saved. (The connection with the server completed normally, so communication can continue after this.)</td>
57        </tr>
58        <tr>
59<th>ResultIpcSessionErr</th>
60<td>Error indicating an uninitialized connection. The function has not done anything as it has been called on a <CODE>Connection</CODE> instance for which you have not yet successfully called <a href="../../../nn/ssl/Connection/Initialize.html"><CODE>Initialize</CODE></a>.</td>
61        </tr>
62        <tr>
63<th>ResultNotInitializedErr</th>
64<td>Error indicating that the library is not initialized. None of the functions in this library can be run without first running <a href="../../../nn/ssl/Initialize.html"><CODE>nn::ssl::Initialize</CODE></a>.</td>
65        </tr>
66        <tr>
67<th>A value other than the above.</th>
68<td>Failed for a reason other than those listed above. (The content of the error is the same as the <CODE><a href="../../../nn/ssl/Connection/DoHandshake.html">nn::ssl::Connection::DoHandshake</a></CODE> function.)</td>
69        </tr>
70      </table> </div>
71<h2>Description</h2>
72    <div class="section">
73<p>This syntax allows you to receive information about the certificate data that is saved in the save buffer for server certificates that were set using the <CODE>SetServerCertBuffer</CODE> function while carrying out SSL handshaking. If the <a href="../../../nn/ssl/Connection/SetServerCertBuffer.html"><CODE>SetServerCertBuffer</CODE></a> function has not been called (in other words, if the save buffer for server certificates has not been set), this will behave just like the <a href="../../../nn/ssl/Connection/DoHandshake.html"><CODE>DoHandshake</CODE></a> function.</p>
74    </div>
75  <hr><p>CONFIDENTIAL</p></body>
76</html>
77