CTR-Pia
5.4.3
Game Communication Engine
メインページ
ネームスペース一覧
クラス構成
クラス索引
関連ページ
Result 検索
全て
クラス
ネームスペース
関数
変数
型定義
列挙型
列挙型の値
ページ
inet_NexCommunitySearchCriteriaOfficial.h
1
/*--------------------------------------------------------------------------------*
2
Copyright (C)Nintendo All rights reserved.
3
4
These coded instructions, statements, and computer programs contain proprietary
5
information of Nintendo and/or its licensed developers and are protected by
6
national and international copyright laws. They may not be disclosed to third
7
parties or copied or duplicated in any form, in whole or in part, without the
8
prior written consent of Nintendo.
9
10
The content herein is highly confidential and should be handled accordingly.
11
*--------------------------------------------------------------------------------*/
12
13
14
#pragma once
15
16
#include <nn/pia/inet/inet_Definitions.h>
17
18
#if NN_PIA_ENABLE_NEX
19
20
#include <nn/pia/inet/inet_NexSessionTypes.h>
21
#include <nn/pia/session/session_CommunitySearchCriteria.h>
22
23
namespace
nn
24
{
25
namespace
pia
26
{
27
namespace
inet
28
{
29
30
/*!
31
@brief 公式コミュニティを検索する際に使用する検索条件のクラスです。
32
@details 検索結果として得られるコミュニティの最大数は SetResultRange で指定する値になりますが、
33
nn::pia::session::Session::CreateInstance 呼び出し時に指定する
34
nn::pia::session::Session::Setting 構造体の browsedCommunityInfoListNum 以下の値を
35
指定する必要があります。
36
37
@see nn::pia::session::CommunitySearchCriteria
38
*/
39
class
NexCommunitySearchCriteriaOfficial
:
public
nn::pia::session::CommunitySearchCriteria
40
{
41
public
:
42
/*!
43
@brief デフォルトコンストラクタ。
44
*/
45
NexCommunitySearchCriteriaOfficial
();
46
47
/*!
48
@brief コンストラクタ。
49
@param[in] isAvailableOnly 検索条件として参加可能な公式コミュニティだけを対象とするかどうか。
50
@param[in] resultOffset 検索条件にマッチしたエントリーリストから検索結果として取得するエントリー群の開始位置。
51
@param[in] resultSize 検索条件にマッチしたエントリーリストから検索結果として取得するエントリー数。
52
session::Session::Setting 構造体の browsedCommunityInfoListNum 以下、かつSearchCriteriaResultSizeMax 以下の値である必要があります。
53
*/
54
NexCommunitySearchCriteriaOfficial
(
bool
isAvailableOnly, uint32_t resultOffset, uint32_t resultSize);
55
56
/*!
57
@brief デストラクタ。
58
*/
59
virtual
~NexCommunitySearchCriteriaOfficial
();
60
61
/*!
62
@brief コピーコンストラクタ。
63
@param[in] rhs コピー元のオブジェクトです。
64
*/
65
NexCommunitySearchCriteriaOfficial
(
const
NexCommunitySearchCriteriaOfficial
& rhs);
66
67
/*!
68
@brief コミュニティを検索する際に参加可能な公式コミュニティだけを対象とするか指定します。
69
@param[in] isAvailableOnly 検索条件として参加可能な公式コミュニティだけを対象とするかどうか。
70
*/
71
void
SetAvailableCommunityOnly
(
bool
isAvailableOnly);
72
73
/*!
74
@brief 検索結果の取得範囲を指定します。
75
@details offset に 0xFFFFFFFF を指定すると、検索結果をランダムに並び替えた上で
76
指定されたエントリー数を取得するように振る舞います。
77
@param[in] offset 検索条件にマッチしたエントリーリストから検索結果として取得するエントリー群の開始位置。
78
@param[in] size 検索条件にマッチしたエントリーリストから検索結果として取得するエントリー数。
79
session::Session::Setting 構造体の browsedCommunityInfoListNum 以下、かつSearchCriteriaResultSizeMax 以下の値である必要があります。
80
81
@return 処理に成功すれば、成功の Result が返されます。失敗した場合、以下の Result を返します。
82
@retval nn::pia::ResultInvalidArgument 引数の値が範囲外です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
83
*/
84
virtual
Result
SetResultRange
(uint32_t offset, uint32_t size);
85
86
/*!
87
@cond PRIVATE
88
*/
89
bool
IsAvailableCommunityOnly()
const
;
90
//! @endcond
91
92
/*!
93
@brief 代入演算子です。
94
@param[in] rhs 代入するオブジェクトです。
95
@return 本オブジェクトへの参照。
96
*/
97
NexCommunitySearchCriteriaOfficial
&
operator=
(
const
NexCommunitySearchCriteriaOfficial
& rhs);
98
99
/*!
100
@brief 設定をコピーします。
101
@param[in] rhs コピー元のオブジェクトです。
102
*/
103
void
Copy
(
const
NexCommunitySearchCriteriaOfficial
& rhs);
104
105
/*!
106
@brief 検索条件をリセットします。
107
*/
108
virtual
void
Reset
();
109
110
private
:
111
bool
m_IsAvailableOnly;
112
};
113
}
114
}
115
}
// end of namespace nn::pia::inet
116
117
#endif
Include
nn
pia
inet
inet_NexCommunitySearchCriteriaOfficial.h
© 2016 Nintendo Co., Ltd. All rights reserved. 記載されている会社名、製品名等は、各社の登録商標または商標です。