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

コミュニティの情報へのインターフェースです。 [詳細]

+ nn::pia::session::ICommunityInfoに対する継承グラフ

Public メソッド

virtual Result GetApplicationData (void *pBuffer, uint32_t size)=0
 コミュニティのアプリケーション定義データを取得します。
 
virtual Result GetApplicationDataSize (uint32_t *pSize)=0
 コミュニティのアプリケーション定義データの長さを取得します。
 
virtual Result GetAttribute (uint8_t idx, uint32_t *pAttribute) const =0
 コミュニティの属性を取得します。
 
virtual uint32_t GetCommunityId () const =0
 コミュニティの ID を取得します。
 
virtual uint16_t GetCurrentParticipantNum () const =0
 コミュニティに参加している人数を取得します。
 
virtual const common::StringGetDescription () const =0
 コミュニティの説明文字列を取得します。
 
virtual uint16_t GetMaxParticipantNum () const =0
 コミュニティに参加できる最大人数を取得します。
 
virtual uint16_t GetMinParticipantNum () const =0
 コミュニティに参加できる最少人数を取得します。
 
virtual PrincipalId GetOwnerPrincipalId () const =0
 コミュニティーのオーナーのプリンシパル ID を取得します。
 
virtual const common::DateTimeGetParticipationEndDate ()=0
 参加終了日時を取得します。
 
virtual const common::DateTimeGetParticipationStartDate ()=0
 参加開始日時を取得します。
 
virtual uint32_t GetRelatedSessionCount () const =0
 コミュニティに関連づけられたセッションの数を取得します。
 
virtual bool IsOfficialCommunity () const =0
 公式コミュニティであるかどうかを取得します。
 
virtual bool IsRestrictedByPassword () const =0
 パスワードで参加制限されているかどうかを確認します。
 

説明

コミュニティの情報へのインターフェースです。

関数

virtual Result nn::pia::session::ICommunityInfo::GetApplicationData ( void *  pBuffer,
uint32_t  size 
)
pure virtual

コミュニティのアプリケーション定義データを取得します。

引数
[out]pBufferコミュニティのアプリケーション定義データのコピー用バッファのポインタ。
[in]sizeコミュニティのアプリケーション定義データのコピー用バッファのサイズ。
戻り値
正常に情報を取得できた場合、成功の Result が返ります。
返るエラーの一覧:

ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState データを取得できる状態ではありません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultNoData 取得できるデータがありませんでした。ローカル通信時のみ返ります。アプリケーションで適切にハンドリングしてください。

virtual Result nn::pia::session::ICommunityInfo::GetApplicationDataSize ( uint32_t *  pSize)
pure virtual

コミュニティのアプリケーション定義データの長さを取得します。

引数
[out]pSizeコミュニティのアプリケーション定義データの長さ格納先のポインタ。
戻り値
正常に情報を取得できた場合、成功の Result が返ります。
返るエラーの一覧:

ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState データを取得できる状態ではありません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

virtual Result nn::pia::session::ICommunityInfo::GetAttribute ( uint8_t  idx,
uint32_t *  pAttribute 
) const
pure virtual

コミュニティの属性を取得します。

引数
[in]idx取得する属性のインデックス。
[out]pAttribute指定されたインデックスのコミュニティの属性格納先のポインタ。
戻り値
正常に情報を取得できた場合、成功の Result が返ります。
返るエラーの一覧:

ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState データを取得できる状態ではありません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

virtual uint32_t nn::pia::session::ICommunityInfo::GetCommunityId ( ) const
pure virtual

コミュニティの ID を取得します。

戻り値
コミュニティの ID を返します。
virtual uint16_t nn::pia::session::ICommunityInfo::GetCurrentParticipantNum ( ) const
pure virtual

コミュニティに参加している人数を取得します。

戻り値
コミュニティに参加している人数を返します。
virtual const common::String& nn::pia::session::ICommunityInfo::GetDescription ( ) const
pure virtual

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

戻り値
コミュニティの説明文字列が返ります。
virtual uint16_t nn::pia::session::ICommunityInfo::GetMaxParticipantNum ( ) const
pure virtual

コミュニティに参加できる最大人数を取得します。

戻り値
コミュニティに参加できる最大人数を返します。
virtual uint16_t nn::pia::session::ICommunityInfo::GetMinParticipantNum ( ) const
pure virtual

コミュニティに参加できる最少人数を取得します。

戻り値
コミュニティに参加できる最少人数を返します。
virtual const common::DateTime& nn::pia::session::ICommunityInfo::GetParticipationEndDate ( )
pure virtual

参加終了日時を取得します。

戻り値
参加終了日時を返します。
virtual const common::DateTime& nn::pia::session::ICommunityInfo::GetParticipationStartDate ( )
pure virtual

参加開始日時を取得します。

戻り値
参加開始日時を返します。
virtual uint32_t nn::pia::session::ICommunityInfo::GetRelatedSessionCount ( ) const
pure virtual

コミュニティに関連づけられたセッションの数を取得します。

戻り値
コミュニティに関連づけられたセッションの数を返します。
virtual bool nn::pia::session::ICommunityInfo::IsOfficialCommunity ( ) const
pure virtual

公式コミュニティであるかどうかを取得します。

戻り値
virtual bool nn::pia::session::ICommunityInfo::IsRestrictedByPassword ( ) const
pure virtual

パスワードで参加制限されているかどうかを確認します。

戻り値
パスワードで参加制限されている場合は true を返します。