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

データのダウンロードに関するパラメータを表すクラスです。 [詳解]

#include <RendezVous/Services/Jugem/DataStore/src/Common/DataStorePrepareGetParam.h>

DDLCLASSDataStorePrepareGetParamを継承しています。

公開メンバ関数

 DataStorePrepareGetParam ()
 コンストラクタです。
 
virtual ~DataStorePrepareGetParam ()
 デストラクタです。
 
qUnsignedInt64 GetAccessPassword () const
 参照パスワードを取得します。 [詳解]
 
qUnsignedInt64 GetDataId () const
 データIDを取得します。 [詳解]
 
const DataStorePersistenceTargetGetPersistenceTarget () const
 永続化対象取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
void SetAccessPassword (qUnsignedInt64 accessPassword_)
 参照パスワードを設定します。 [詳解]
 
void SetDataId (qUnsignedInt64 dataId_)
 データIDをセットします。 [詳解]
 
void SetPersistenceTarget (const DataStorePersistenceTarget &persistenceTarget_)
 取得するデータを永続化対象(プリンシパルIDと永続化スロットID)で指定します。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 DataStorePrepareGetParamオブジェクトの内容をトレースします。 [詳解]
 

詳解

データのダウンロードに関するパラメータを表すクラスです。

データIDもしくは永続化対象のいずれかを指定してダウンロードする対象を指定します。

このクラスは、 DataStoreGetParam クラスと同一です。

関数詳解

void nn::nex::DataStorePrepareGetParam::SetDataId ( qUnsignedInt64  dataId_)

データIDをセットします。

取得するデータのデータIDを指定します。 本パラメータを設定する場合は DataStorePrepareGetParam::SetPersistenceTarget() で永続化対象(プリンシパルIDと永続化スロットID)を設定しないでください。

引数
[in]dataId_取得するデータのデータID。
qUnsignedInt64 nn::nex::DataStorePrepareGetParam::GetDataId ( ) const

データIDを取得します。

戻り値
データID。
void nn::nex::DataStorePrepareGetParam::SetPersistenceTarget ( const DataStorePersistenceTarget persistenceTarget_)

取得するデータを永続化対象(プリンシパルIDと永続化スロットID)で指定します。

取得するデータをプリンシパルIDと永続化スロットIDで指定します。 本パラメータを設定する場合は DataStorePrepareGetParam::SetDataId() でデータIDを設定しないでください。

引数
[in]persistenceTarget_取得するデータの永続化対象。
const DataStorePersistenceTarget& nn::nex::DataStorePrepareGetParam::GetPersistenceTarget ( ) const

永続化対象取得します。

戻り値
永続化対象。
void nn::nex::DataStorePrepareGetParam::SetAccessPassword ( qUnsignedInt64  accessPassword_)

参照パスワードを設定します。

参照権限を持たないデータを参照する場合に参照パスワードを指定します。 データのオーナーから受け取った参照パスワードを指定してください。 参照権限を持っている場合は参照パスワードは無視され、常に参照可能です。 DataStoreConstants::INVALID_PASSWORD を指定した場合は参照パスワードでの認証を行いません。 本関数で指定しない場合は DataStoreConstants::INVALID_PASSWORD が使用されます。

引数
[in]accessPassword_参照パスワード
qUnsignedInt64 nn::nex::DataStorePrepareGetParam::GetAccessPassword ( ) const

参照パスワードを取得します。

戻り値
参照パスワード。
void nn::nex::DataStorePrepareGetParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

DataStorePrepareGetParamオブジェクトの内容をトレースします。

引数
[in]uiTraceFlagsTraceLog::SetFlag()の引数と同様です。