CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
クラス nn::pia::inet::NexJoinSessionSetting

セッション参加処理に関する設定を管理するクラスです。 [詳細]

+ nn::pia::inet::NexJoinSessionSettingに対する継承グラフ

Public メソッド

 NexJoinSessionSetting ()
 デフォルトコンストラクタ。
 
 NexJoinSessionSetting (const NexJoinSessionSetting &rhs)
 コピーコンストラクタ。
 
virtual ~NexJoinSessionSetting ()
 デストラクタ。
 
void Copy (const NexJoinSessionSetting &rhs)
 設定をコピーします。
 
NexJoinSessionSettingoperator= (const NexJoinSessionSetting &rhs)
 代入演算子です。
 
virtual void Reset ()
 設定をリセットします。
 
void SetBlockListOption (bool isMyBlockListUsed, bool isOthersBlockListUsed)
 ブロックリストを設定します。
 
virtual void SetSessionId (uint32_t id)
 参加先のセッションの ID を設定します。
 
virtual void SetSessionInfoPtr (const ISessionInfo *pSessionInfo)
 参加先のセッションの情報を指定します。
 
Result SetSessionSystemPassword (const common::String &systemPassword)
 セッションのシステムパスワードを設定します。
 
Result SetSessionUserPassword (const common::String &userPassword)
 セッションのユーザーパスワードを設定します。
 

説明

セッション参加処理に関する設定を管理するクラスです。

参照
nn::pia::session::JoinSessionSetting

コンストラクタとデストラクタ

nn::pia::inet::NexJoinSessionSetting::NexJoinSessionSetting ( const NexJoinSessionSetting rhs)

コピーコンストラクタ。

引数
[in]rhsコピー元のオブジェクトです。

関数

void nn::pia::inet::NexJoinSessionSetting::Copy ( const NexJoinSessionSetting rhs)

設定をコピーします。

引数
[in]rhsコピー元のオブジェクトです。
NexJoinSessionSetting& nn::pia::inet::NexJoinSessionSetting::operator= ( const NexJoinSessionSetting rhs)

代入演算子です。

引数
[in]rhs代入するオブジェクトです。
戻り値
本オブジェクトへの参照。
void nn::pia::inet::NexJoinSessionSetting::SetBlockListOption ( bool  isMyBlockListUsed,
bool  isOthersBlockListUsed 
)

ブロックリストを設定します。

引数
[in]isMyBlockListUsed自分がブロックリストに登録しているユーザーをチェックするかどうか。デフォルトは true です。
[in]isOthersBlockListUsed自分をブロックリストに登録しているユーザをチェックするかどうか。デフォルトは true です。
virtual void nn::pia::session::JoinSessionSetting::SetSessionInfoPtr ( const ISessionInfo pSessionInfo)
virtualinherited

参加先のセッションの情報を指定します。

Session::BrowseSessionAsync で検索したセッションの情報を指定します。

引数
[in]pSessionInfo参加先のセッションの情報。
参照
Session::JoinSessionAsync, Session::BrowseSessionAsync
Result nn::pia::inet::NexJoinSessionSetting::SetSessionSystemPassword ( const common::String systemPassword)

セッションのシステムパスワードを設定します。

セッションにシステムパスワードが設定されている場合に一致が確認されます。 初期状態は空文字列です。

引数
[in]systemPasswordシステムパスワード。パスワードの文字列は SessionSystemPasswordLengthMax 以下である必要があります。
戻り値
システムパスワードの指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 文字列が NULL、文字コードが不正、またはシステムパスワードの最大長を超えています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::inet::NexJoinSessionSetting::SetSessionUserPassword ( const common::String userPassword)

セッションのユーザーパスワードを設定します。

セッションにユーザーパスワードが設定されている場合に一致が確認されます。 初期状態は空文字列です。

引数
[in]userPasswordユーザーパスワード。パスワードの文字列は SessionUserPasswordLengthMax 以下である必要があります。
戻り値
ユーザーパスワードの指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 文字列が NULL、文字コードが不正、またはユーザーパスワードの最大長を超えています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。