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

プリンシパル ID をセッションの検索条件として指定するクラスです。 [詳細]

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

Public メソッド

 NexSessionSearchCriteriaParticipant ()
 デフォルトコンストラクタ。
 
 NexSessionSearchCriteriaParticipant (const NexSessionSearchCriteriaParticipant &rhs)
 コピーコンストラクタ。
 
virtual ~NexSessionSearchCriteriaParticipant ()
 デストラクタ。
 
void Copy (const NexSessionSearchCriteriaParticipant &rhs)
 設定をコピーします。
 
NexSessionSearchCriteriaParticipantoperator= (const NexSessionSearchCriteriaParticipant &rhs)
 代入演算子です。
 
virtual void Reset ()
 検索条件をリセットします。
 
void SetApplicationDataEnabled (bool isEnabled)
 検索結果にアプリケーション定義データを含めるかどうかをセットします。
 
void SetBlockListOption (bool isMyBlockListUsed, bool isOthersBlockListUsed)
 検索条件として指定するブロックリスト設定をセットします。
 
Result SetParticipantPrincipalId (const PrincipalId *idList, uint32_t idListSize)
 検索条件として指定する相手のプリンシパル ID をセットします。
 

説明

プリンシパル ID をセッションの検索条件として指定するクラスです。

指定したプリンシパル ID のステーションが参加しているセッションを検索します。 検索結果として得られるセッションの最大数は nn::pia::session::Session::CreateInstance 呼び出し時に 指定する nn::pia::session::Session::Setting 構造体の browsedSessionInfoListNum の値になります。

参照
nn::pia::session::SessionSearchCriteria

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

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

コピーコンストラクタ。

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

関数

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

設定をコピーします。

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

代入演算子です。

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

検索結果にアプリケーション定義データを含めるかどうかをセットします。

アプリケーション定義データを必要としない場合は、サーバー負荷軽減のため、含めてはいけません。

引数
[in]isEnabled検索結果にアプリケーション定義データを含めるかどうか。デフォルトは false です。
void nn::pia::inet::NexSessionSearchCriteriaParticipant::SetBlockListOption ( bool  isMyBlockListUsed,
bool  isOthersBlockListUsed 
)

検索条件として指定するブロックリスト設定をセットします。

引数
[in]isMyBlockListUsed自分がブロックリストに登録しているユーザーをチェックするかどうか。デフォルトは true です。
[in]isOthersBlockListUsed自分をブロックリストに登録しているユーザをチェックするかどうか。デフォルトは true です。
Result nn::pia::inet::NexSessionSearchCriteriaParticipant::SetParticipantPrincipalId ( const PrincipalId idList,
uint32_t  idListSize 
)

検索条件として指定する相手のプリンシパル ID をセットします。

引数
[in]idList検索条件として指定する相手のプリンシパル ID のリスト。
[in]idListSize検索条件として指定する相手のプリンシパル ID のリストサイズ。ParticipantArraySizeMax 以下である必要があります。
戻り値
検索条件の指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument リストが NULL、または値の個数が範囲外です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。