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

コミュニティ作成処理に関する設定を管理するクラスです。 [詳細]

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

Public メソッド

 NexCreateCommunitySetting ()
 デフォルトコンストラクタ。
 
 NexCreateCommunitySetting (const NexCreateCommunitySetting &rhs)
 コピーコンストラクタ。
 
virtual ~NexCreateCommunitySetting ()
 デストラクタ。
 
void Copy (const NexCreateCommunitySetting &rhs)
 設定をコピーします。
 
NexCreateCommunitySettingoperator= (const NexCreateCommunitySetting &rhs)
 代入演算子です。
 
virtual void Reset ()
 設定をリセットします。
 
Result SetApplicationData (const void *pData, uint32_t size)
 アプリケーション定義のデータを指定します。
 
Result SetAttribute (uint32_t index, uint32_t value)
 構築するコミュニティに属性を指定します。
 
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::CreateCommunitySetting

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

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

コピーコンストラクタ。

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

関数

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

設定をコピーします。

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

代入演算子です。

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

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

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

構築するコミュニティに属性を指定します。

引数
[in]index構築するコミュニティに指定する属性のインデックス。AttributeSizeMax 以下である必要があります。
[in]value構築するコミュニティに指定する属性の値。
戻り値
セッションの属性の指定に成功すれば、成功の Result が返されます。
返るエラーの一覧:
nn::pia::ResultInvalidArgument 属性のインデックスが範囲外です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
Result nn::pia::inet::NexCreateCommunitySetting::SetCommunityUserPassword ( const common::String userPassword)

作成したコミュニティにユーザーパスワードを設定します。

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

構築するコミュニティに説明文字列を指定します。

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

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

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

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

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

構築するコミュニティの参加可能終了日時を指定します。

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

構築するコミュニティの参加可能開始日時を指定します。

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