CTR Pia  4.11.3
Game Communication Engine
nn::pia::inet::NexJoinSessionSetting Class Reference

Class that manages settings specific to NEX session participation. More...

+ Inheritance diagram for nn::pia::inet::NexJoinSessionSetting:

Public Member Functions

 NexJoinSessionSetting ()
 The default constructor.
 
virtual ~NexJoinSessionSetting ()
 The destructor.
 
virtual void SetSessionId (u32 id)
 Configures a target session ID. More...
 
virtual void SetSessionInfoPtr (ISessionInfo *pSessionInfo)
 Sets target session information. More...
 
void SetSessionSystemPassword (const wchar_t *pSystemPassword, size_t passwordLength)
 Sets the session's system password. More...
 
void SetSessionUserPassword (const wchar_t *pUserPassword, size_t passwordLength)
 Sets the session's user password. More...
 

Detailed Description

Class that manages settings specific to NEX session participation.


Revision History:

2014-05-16 Added the SetSessionUserPassword() and SetSessionSystemPassword() functions.

2014-04-30 Added the SetSessionId() and GetSessionId() functions.

2014-02-03 Initial version.

See also
nn::pia::session::JoinSessionSetting

Member Function Documentation

virtual void nn::pia::inet::NexJoinSessionSetting::SetSessionId ( u32  id)
virtual

Configures a target session ID.

Parameters
[in]idThe target session ID.
virtual void nn::pia::session::JoinSessionSetting::SetSessionInfoPtr ( ISessionInfo pSessionInfo)
virtualinherited

Sets target session information.

Sets target session information. Set the session information that was found using Session::BrowseSessionAsync.

Parameters
[in]pSessionInfoThe target session's information.
See also
Session::JoinSessionAsync, Session::BrowseSessionAsync
void nn::pia::inet::NexJoinSessionSetting::SetSessionSystemPassword ( const wchar_t *  pSystemPassword,
size_t  passwordLength 
)

Sets the session's system password.

If a system password is already set for the session, this function confirms that they match. The default is an empty character string.

Parameters
[in]pSystemPasswordThe system password.
[in]passwordLengthThe system password's string length.
void nn::pia::inet::NexJoinSessionSetting::SetSessionUserPassword ( const wchar_t *  pUserPassword,
size_t  passwordLength 
)

Sets the session's user password.

If a user password is already set for the session, this function confirms that they match. The default is an empty character string.

Parameters
[in]pUserPasswordThe user password.
[in]passwordLengthThe user password's string length.