LAN マッチメイクのセッションを検索する際に使用する検索条件のクラスです。
[詳細]
LAN マッチメイクのセッションを検索する際に使用する検索条件のクラスです。
検索結果として得られるセッションの最大数は nn::pia::session::Session::CreateInstance 呼び出し時に 指定する nn::pia::session::Session::Setting 構造体の browsedSessionInfoListNum の値になります。
- 参照
- nn::pia::session::SessionSearchCriteria
代入演算子です。
- 引数
-
- 戻り値
- 本オブジェクトへの参照。
Result nn::pia::lan::LanSessionSearchCriteria::SetAttribute |
( |
uint32_t |
index, |
|
|
uint32_t |
value |
|
) |
| |
1つの属性に対して検索時に使用する値を指定します。
- 引数
-
[in] | index | 指定する属性のインデックス。LanAttributeSizeMax 以下である必要があります。 |
[in] | value | 指定する属性の値。 |
- 戻り値
- セッションの属性の指定に成功すれば、成功の Result が返されます。
- 返るエラーの一覧:
- nn::pia::ResultInvalidArgument 属性のインデックスが範囲外です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::lan::LanSessionSearchCriteria::SetAttribute |
( |
uint32_t |
index, |
|
|
const uint32_t * |
value, |
|
|
uint32_t |
attributeNum |
|
) |
| |
1つの属性に対して検索時に使用する値を複数指定します。
- 引数
-
[in] | index | 指定する属性のインデックス。LanAttributeSizeMax 以下である必要があります。 |
[in] | value | 指定する属性の値のリスト。 |
[in] | attributeNum | 指定する属性の値の個数。LanAttributeArraySizeMax 以下である必要があります。 |
- 戻り値
- セッションの属性の指定に成功すれば、成功の Result が返されます。
- 返るエラーの一覧:
- nn::pia::ResultInvalidArgument 属性のインデックスが範囲外、値のリストが NULL、または値の個数が多すぎます。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::lan::LanSessionSearchCriteria::SetAttributeRange |
( |
uint32_t |
index, |
|
|
uint32_t |
min, |
|
|
uint32_t |
max |
|
) |
| |
1つの属性に対して検索時に使用する値を範囲指定します。
- 引数
-
[in] | index | 指定する属性のインデックス。LanAttributeSizeMax 以下である必要があります。 |
[in] | min | 指定する属性の値の下限。 |
[in] | max | 指定する属性の値の上限。 |
- 戻り値
- セッションの属性の指定に成功すれば、成功の Result が返されます。
- 返るエラーの一覧:
- nn::pia::ResultInvalidArgument 属性のインデックスが範囲外、または下限値が上限値よりも大きい値になっています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
void nn::pia::lan::LanSessionSearchCriteria::SetGameMode |
( |
uint32_t |
gameMode | ) |
|
検索条件にゲームモードを指定します。
- 引数
-
[in] | gameMode | 検索条件に指定するゲームモード。 |
void nn::pia::lan::LanSessionSearchCriteria::SetMaxParticipantNum |
( |
uint16_t |
max | ) |
|
void nn::pia::lan::LanSessionSearchCriteria::SetMaxParticipantNumRange |
( |
uint16_t |
min, |
|
|
uint16_t |
max |
|
) |
| |
検索条件に最大参加人数を範囲指定します。
- 引数
-
[in] | min | 検索条件に指定する最大参加人数の範囲の下限。 |
[in] | max | 検索条件に指定する最大参加人数の範囲の上限。 |
void nn::pia::lan::LanSessionSearchCriteria::SetMinParticipantNum |
( |
uint16_t |
min | ) |
|
void nn::pia::lan::LanSessionSearchCriteria::SetMinParticipantNumRange |
( |
uint16_t |
min, |
|
|
uint16_t |
max |
|
) |
| |
検索条件に最小参加人数を範囲指定します。
- 引数
-
[in] | min | 検索条件に指定する最小参加人数の範囲の下限。 |
[in] | max | 検索条件に指定する最小参加人数の範囲の上限。 |
void nn::pia::lan::LanSessionSearchCriteria::SetOpenedOnly |
( |
bool |
bOpenedOnly | ) |
|
検索条件に参加受付状態のセッションのみを検索するか指定します。
- 引数
-
[in] | bOpenedOnly | 参加受付状態のセッションのみを検索する場合は true を指定します。 |
virtual Result nn::pia::session::SessionSearchCriteria::SetResultRange |
( |
uint32_t |
offset, |
|
|
uint32_t |
size |
|
) |
| |
|
virtualinherited |
void nn::pia::lan::LanSessionSearchCriteria::SetSessionType |
( |
LanSessionType |
sessionType | ) |
|
検索条件にセッションタイプを指定します。
- 引数
-
[in] | sessionType | 検索条件に指定するセッションタイプ。 |
void nn::pia::lan::LanSessionSearchCriteria::SetVacantOnly |
( |
bool |
bVacantOnly | ) |
|
検索条件に空きがあるセッションのみを検索するか指定します。
- 引数
-
[in] | bVacantOnly | 空きがあるセッションのみを検索する場合は true を指定します。 |