nn::ssl::Connection::GetCipherInfo Member Function

Syntax

nn::Result GetCipherInfo(
     char * pVersionBuf,
     size_t versionBufSize,
     char * pCipherKindStrBuf,
     size_t cipherKindStrBufSize,
     s32 * pAlgBits,
     s32 * pEffectiveBits
);

Arguments

Name Description
out pVersionBuf Buffer storing the version string.
in versionBufSize Size of pVersionBuf.
out pCipherKindStrBuf Buffer storing the string indicating the encryption type.
in cipherKindStrBufSize Size of pCipherKindStrBufSize.
out pAlgBits Buffer storing the number of bits in the encryption algorithm key.
out pEffectiveBits Buffer storing the number of bits of effective security of the cipher.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
ResultSuccess Process was successful.
ResultProtocolFailedErr Indicates that the process failed. (An invalid argument, etc.)
ResultInternalSslIdErr The target SSL connection was invalid. (An internal library error.)
ResultIpcSessionErr Error indicating an uninitialized connection. The function has not done anything as it has been called on a Connection instance for which you have not yet successfully called Initialize.
ResultNotInitializedErr Error indicating that the library is not initialized. None of the functions in this library can be run without first running nn::ssl::Initialize.
A value other than the above. Unexpected error (see ssl_Result.h for error details).

Description

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.

Revision History

2010/06/14
Initial version.

CONFIDENTIAL