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>GetCipherInfo</title>
8  </head>
9  <body>
10<h1><CODE>nn::ssl::Connection::GetCipherInfo</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> GetCipherInfo(
15     char * pVersionBuf,
16     size_t versionBufSize,
17     char * pCipherKindStrBuf,
18     size_t cipherKindStrBufSize,
19     s32 * pAlgBits,
20     s32 * pEffectiveBits
21);
22</pre>
23    </div>
24<h2>Arguments</h2>
25    <div class="section">
26      <table class="arguments">
27        <thead>
28          <tr>
29            <td width="15" />
30<th>Name</th>
31<td>Description</td>
32          </tr>
33        </thead>
34        <tr>
35<td>out</td>
36<th>pVersionBuf</th>
37<td>Buffer storing the version string.</td>
38        </tr>
39        <tr>
40<td>in</td>
41<th>versionBufSize</th>
42<td>Size of <SPAN class="argument">pVersionBuf</SPAN>.</td>
43        </tr>
44        <tr>
45<td>out</td>
46<th>pCipherKindStrBuf</th>
47<td>Buffer storing the string indicating the encryption type.</td>
48        </tr>
49        <tr>
50<td>in</td>
51<th>cipherKindStrBufSize</th>
52<td>Size of <SPAN class="argument">pCipherKindStrBufSize</SPAN>.</td>
53        </tr>
54        <tr>
55<td>out</td>
56<th>pAlgBits</th>
57<td>Buffer storing the number of bits in the encryption algorithm key.</td>
58        </tr>
59        <tr>
60<td>out</td>
61<th>pEffectiveBits</th>
62<td>Buffer storing the number of bits of effective security of the cipher.</td>
63        </tr> </table>
64    </div>
65<h2>Return Values</h2>
66<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 />
67      <table class="arguments">
68        <thead>
69          <tr>
70<th>Value</th>
71<td>Description</td>
72          </tr>
73        </thead>
74        <tr>
75<th><CODE>ResultSuccess</CODE></th>
76<td>Process was successful.</td>
77        </tr>
78        <tr>
79<th>ResultProtocolFailedErr</th>
80<td>Indicates that the process failed. (An invalid argument, etc.)</td>
81        </tr>
82        <tr>
83<th>ResultInternalSslIdErr</th>
84<td>The target SSL connection was invalid. (An internal library error.)</td>
85        </tr>
86        <tr>
87<th>ResultIpcSessionErr</th>
88<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>
89        </tr>
90        <tr>
91<th>ResultNotInitializedErr</th>
92<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>
93        </tr>
94        <tr>
95<th>A value other than the above.</th>
96<td>Unexpected error (see <CODE>ssl_Result.h</CODE> for error details).</td>
97        </tr>
98      </table> </div>
99<h2>Description</h2>
100    <div class="section">
101<p>Gets information about the encryption used for the target SSL communication. This function is intended for special use cases; it is not envisioned for use by normal users.</p><!-- write here --></div>
102<h2>Revision History</h2>
103    <div class="section">
104      <dl class="history">
105        <dt>2010/06/14</dt>
106<dd>Initial version.<br />
107        </dd>
108      </dl>
109    </div>
110  <hr><p>CONFIDENTIAL</p></body>
111</html>
112