CTR NEX API Reference
nn::nex::SessionDescription クラス

セッションに関する情報を含むクラスです。 [詳解]

#include <NetZ/src/Core/DOCore/SessionDescription.h>

+ nn::nex::SessionDescription の継承関係図

公開メンバ関数

const qCharGetApplicationTitle () const
 アプリケーションの名前を取得します。 [詳解]
 
qUnsignedInt32 GetApplicationVersionNumber () const
 アプリケーションのバージョン番号を取得します。 [詳解]
 
void GetApplicationVersionNumbers (qByte *pbyV1, qByte *pbyV2, qByte *pbyV3, qByte *pbyV4) const
 アプリケーションのバージョン番号を取得します。 [詳解]
 
qUnsignedInt32 GetLibraryBuildNumber () const
 このセッションに利用されているライブラリのビルド番号を取得します。 [詳解]
 
qUnsignedInt32 GetLibraryVersionNumber () const
 このセッションに利用されているライブラリのバージョン番号を取得します。 [詳解]
 
qUnsignedInt32 GetSessionID () const
 セッションIDを取得します。 [詳解]
 
const qCharGetSessionName () const
 セッションの名前を取得します。 [詳解]
 
const qCharGetStationURL () const
 セッションのURLオブジェクトを取得します。 [詳解]
 
void SetApplicationVersionNumber (qUnsignedInt32 uiApplicationVersionNumber)
 アプリケーションのバージョン番号を設定します。 [詳解]
 
void SetApplicationVersionNumbers (qByte byV1, qByte byV2, qByte byV3, qByte byV4)
 アプリケーションのバージョン番号を設定します。 [詳解]
 
void SetSessionName (const qChar *szSessionName)
 セッションの名称を設定します。 [詳解]
 

詳解

セッションに関する情報を含むクラスです。

セッション記述子は、セッションを判別するためのさまざまな情報を含みます。 たとえば、アプリケーションのタイトル、セッションの名前、セッションID、 ライブラリのバージョン番号やビルド番号、そしてユーザー定義番号や属性などがあります。 このセッション記述子はSession::JoinSession の引数としても利用することが出来ます。

関数詳解

void nn::nex::SessionDescription::SetSessionName ( const qChar szSessionName)

セッションの名称を設定します。

セッションの名称は、Session::CreateSession を呼び出してセッションを作成するときに設定されます。 GetSessionName を利用することで、設定したセッション名を取得することが出来ます。

引数
[in]szSessionName設定するセッションの名称を指定します。
const qChar* nn::nex::SessionDescription::GetApplicationTitle ( ) const

アプリケーションの名前を取得します。

アプリケーションのタイトルは、DDL(データ定義言語)ファイルによって宣言されます。 セッションマスターのみがこの情報を返すことが出来ます。

戻り値
DDLによって設定されたアプリケーション名が返ります。
const qChar* nn::nex::SessionDescription::GetSessionName ( ) const

セッションの名前を取得します。

SetSessionNameSession::CreateSession 関数を呼び出すことでセッション名がセットされます。 セッションマスターのみがこの情報を返すことが出来ます。

戻り値
セッションの名前が返ります。
const qChar* nn::nex::SessionDescription::GetStationURL ( ) const

セッションのURLオブジェクトを取得します。

戻り値
セッションに参加するための接続先URLオブジェクトが返ります。
qUnsignedInt32 nn::nex::SessionDescription::GetLibraryVersionNumber ( ) const

このセッションに利用されているライブラリのバージョン番号を取得します。

戻り値
このセッションに利用されているライブラリのバージョン番号が返ります。
qUnsignedInt32 nn::nex::SessionDescription::GetLibraryBuildNumber ( ) const

このセッションに利用されているライブラリのビルド番号を取得します。

戻り値
このセッションに利用されているライブラリのビルド番号が返ります。
qUnsignedInt32 nn::nex::SessionDescription::GetApplicationVersionNumber ( ) const

アプリケーションのバージョン番号を取得します。

アプリケーションのバージョン番号はアプリケーションによって与えられます。 この値は、SetApplicationVersionNumber 関数を呼び出すことで設定することが出来ます。

戻り値
アプリケーションのバージョン番号が符号なし値として返ります。
参照
SetApplicationVersionNumber
void nn::nex::SessionDescription::GetApplicationVersionNumbers ( qByte pbyV1,
qByte pbyV2,
qByte pbyV3,
qByte pbyV4 
) const

アプリケーションのバージョン番号を取得します。

アプリケーションのバージョン番号はアプリケーションによって与えられます。 この値は、SetApplicationVersionNumbers 関数を呼び出すことで設定することが出来ます。

引数
[out]pbyV1バージョン番号1をバイト値として取得するためのポインタを指定します。
[out]pbyV2バージョン番号2をバイト値として取得するためのポインタを指定します。
[out]pbyV3バージョン番号3をバイト値として取得するためのポインタを指定します。
[out]pbyV4バージョン番号4をバイト値として取得するためのポインタを指定します。
参照
SetApplicationVersionNumbers
void nn::nex::SessionDescription::SetApplicationVersionNumber ( qUnsignedInt32  uiApplicationVersionNumber)

アプリケーションのバージョン番号を設定します。

アプリケーションのバージョン番号はアプリケーションによって与えられます。 この番号はNet-Zシステムのバージョン番号とはなにも関係がなく、意味は開発者によって決められます。

引数
[in]uiApplicationVersionNumberアプリケーションのバージョン番号を指定します。
参照
GetApplicationVersionNumber
void nn::nex::SessionDescription::SetApplicationVersionNumbers ( qByte  byV1,
qByte  byV2,
qByte  byV3,
qByte  byV4 
)

アプリケーションのバージョン番号を設定します。

アプリケーションのバージョン番号はアプリケーションによって与えられます。 この番号はNet-Zシステムのバージョン番号とはなにも関係がなく、意味は開発者によって決められます。

引数
[in]byV11番目のアプリケーションバージョン番号を指定します。
[in]byV22番目のアプリケーションバージョン番号を指定します。
[in]byV33番目のアプリケーションバージョン番号を指定します。
[in]byV44番目のアプリケーションバージョン番号を指定します。
参照
GetApplicationVersionNumbers
qUnsignedInt32 nn::nex::SessionDescription::GetSessionID ( ) const

セッションIDを取得します。

セッションIDはNet-Zによってランダムに生成される数値で、 セッションを識別することが出来ます。

戻り値
セッションIDが返ります。