CTR Pia  4.11.3
Game Communication Engine
inet_NexSessionSearchCriteriaParticipant.h
1 /*--------------------------------------------------------------------------------*
2  Copyright 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 <pia/inet/inet_Definitions.h>
17 
18 #include <pia/inet/inet_NexSessionTypes.h>
19 #include <pia/session/session_SessionSearchCriteria.h>
20 
21 namespace nn
22 {
23 namespace pia
24 {
25 namespace inet
26 {
27 
28 /*!
29  @brief The search condition class used when searching for a community.
30 
31  @see nn::pia::session::SessionSearchCriteria
32  */
34 {
35 public:
36 /*!
37  @brief The default constructor.
38 */
40 
41 /*!
42  @brief The destructor.
43 */
45 
46 /*!
47  @brief Sets the principal ID of the destination you are specifying as a search condition.
48  @param[in] idList The principal ID list for the destination you are specifying as a search condition.
49  @param[in] idListSize The principal ID list size for the destination you are specifying as a search condition.
50  @return Returns a successful result when search conditions are successfully specified.
51  @retval nn::pia::ResultInvalidArgument Indicates that the list is <tt>NULL</tt>, or the number of values is out of bounds. Programming error. Fix your program so that this error is not returned.
52 */
53  Result SetParticipantPrincipalId(const u32* idList, size_t idListSize);
54 
55 /*!
56  @cond PRIVATE
57 */
58  const u32* GetParticipantPrincipalId() const
59  {
60  return m_ParticipantPrincipalId;
61  }
62  size_t GetParticipantPrincipalIdSize() const
63  {
64  return m_ParticipantPrincipalIdNum;
65  }
66  //! @endcond
67 
68 /*!
69  @brief Assignment operator.
70  @param[in] rhs The object to assign.
71  @return A reference to this object.
72 */
74 
75 /*!
76  @brief Copies all settings.
77  @param[in] rhs The object to copy from.
78 */
80 
81 /*!
82  @brief Copy constructor.
83  @param[in] rhs The object to copy from.
84 */
86 
87 /*!
88  @brief Resets the search conditions.
89 */
90  virtual void Reset();
91 
92 protected:
93  u32 m_ParticipantPrincipalId[PARTICIPANT_ARRAY_MAX_SIZE];
94  size_t m_ParticipantPrincipalIdNum;
95 
96 private:
97  // SetResultRange is private.
98  virtual void SetResultRange(u32 offset, u32 size);
99 };
100 }
101 }
102 } // End of namespace nn::pia::inet.
103 
virtual ~NexSessionSearchCriteriaParticipant()
The destructor.
Definition: assert.h:115
The base class for the search criteria used when searching for sessions.
Definition: session_SessionSearchCriteria.h:34
virtual void Reset()
Resets the search conditions.
void Copy(const NexSessionSearchCriteriaParticipant &rhs)
Copies all settings.
NexSessionSearchCriteriaParticipant()
The default constructor.
The search condition class used when searching for a community.
Definition: inet_NexSessionSearchCriteriaParticipant.h:33
NexSessionSearchCriteriaParticipant & operator=(const NexSessionSearchCriteriaParticipant &rhs)
Assignment operator.
Result SetParticipantPrincipalId(const u32 *idList, size_t idListSize)
Sets the principal ID of the destination you are specifying as a search condition.
const size_t PARTICIPANT_ARRAY_MAX_SIZE
The maximum length of the Principal ID array for users that can be specified in the search conditions...
Definition: inet_NexSessionTypes.h:41