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

コミュニティ設定の更新処理に関する情報を管理するクラスです。 [詳細]

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

Public メソッド

 NexUpdateCommunitySetting ()
 デフォルトコンストラクタ。
 
 NexUpdateCommunitySetting (const NexUpdateCommunitySetting &rhs)
 コピーコンストラクタ。
 
virtual ~NexUpdateCommunitySetting ()
 デストラクタ。
 
void Copy (const NexUpdateCommunitySetting &rhs)
 設定をコピーします。
 
NexUpdateCommunitySettingoperator= (const NexUpdateCommunitySetting &rhs)
 代入演算子です。
 
virtual void Reset ()
 設定をリセットします。
 
Result SetApplicationData (const void *pData, uint32_t size)
 アプリケーション定義のデータを指定します。
 
void SetAttributes (const uint32_t attributes[nn::pia::inet::AttributeSizeMax])
 コミュニティの属性を一括して指定します。
 
void SetCommunityId (uint32_t communityId)
 更新するコミュニティIDを指定します。
 
Result SetCommunityUserPassword (const common::String &userPassword)
 コミュニティのユーザーパスワードを指定します。
 
Result SetDescription (const common::String &description)
 コミュニティの説明文字列を更新します。
 
void SetMaxParticipantNum (uint16_t max)
 コミュニティの最大参加人数を指定します。
 
void SetMinParticipantNum (uint16_t min)
 コミュニティの最小参加人数を指定します。
 
Result SetParticipationEndDate (const common::DateTime &endDate)
 コミュニティの参加終了日時の更新日時を指定します。
 
Result SetParticipationStartDate (const common::DateTime &startDate)
 コミュニティの開始日時の更新日時を指定します。
 

説明

コミュニティ設定の更新処理に関する情報を管理するクラスです。

更新する値を指定した設定のみ更新されます。更新しない設定について、指定は不要です。

参照
session::UpdateCommunitySetting

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

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

コピーコンストラクタ。

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

関数

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

設定をコピーします。

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

代入演算子です。

引数
[in]rhs代入するオブジェクトです。
戻り値
本オブジェクトへの参照。
Result nn::pia::inet::NexUpdateCommunitySetting::SetApplicationData ( const void *  pData,
uint32_t  size 
)

アプリケーション定義のデータを指定します。

inet::ApplicationDataBufferSizeMax を超えないサイズを指定する必要があります。

引数
[in]pDataコミュニティに指定するアプリケーション定義データのバッファ。
[in]sizeコミュニティに指定するアプリケーション定義データのサイズ。ApplicationDataBufferSizeMax 以下である必要があります。
戻り値
アプリケーション定義データの指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument バッファが NULL ポインタ、または指定したデータサイズが大きすぎます。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
void nn::pia::inet::NexUpdateCommunitySetting::SetAttributes ( const uint32_t  attributes[nn::pia::inet::AttributeSizeMax])

コミュニティの属性を一括して指定します。

引数
[in]attributes属性の配列。配列のサイズは AttributeSizeMax である必要があります。
void nn::pia::inet::NexUpdateCommunitySetting::SetCommunityId ( uint32_t  communityId)

更新するコミュニティIDを指定します。

引数
[in]communityId更新するコミュニティID。
Result nn::pia::inet::NexUpdateCommunitySetting::SetCommunityUserPassword ( const common::String userPassword)

コミュニティのユーザーパスワードを指定します。

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

コミュニティの説明文字列を更新します。

引数
[in]description更新後のコミュニティの説明文字列。文字列の長さは DescriptionLengthMax 以下である必要があります。
戻り値
説明文字列のコピーに成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument バッファが NULL ポインタ、または説明文字列の最大長を超えています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
void nn::pia::inet::NexUpdateCommunitySetting::SetMaxParticipantNum ( uint16_t  max)

コミュニティの最大参加人数を指定します。

引数
[in]max作成するコミュニティに指定する最大参加人数。
void nn::pia::inet::NexUpdateCommunitySetting::SetMinParticipantNum ( uint16_t  min)

コミュニティの最小参加人数を指定します。

引数
[in]min作成するコミュニティに指定する最小参加人数。
Result nn::pia::inet::NexUpdateCommunitySetting::SetParticipationEndDate ( const common::DateTime endDate)

コミュニティの参加終了日時の更新日時を指定します。

引数
[in]endDateコミュニティの参加終了日時。
戻り値
コミュニティの参加終了日時の指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 日時が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::inet::NexUpdateCommunitySetting::SetParticipationStartDate ( const common::DateTime startDate)

コミュニティの開始日時の更新日時を指定します。

引数
[in]startDateコミュニティの参加可能開始日時。
戻り値
コミュニティの参加可能開始日時の指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 日時が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。