uCosminexus DocumentBroker Version 3 クラスライブラリ C++ リファレンス 基本機能編

[目次][用語][索引][前へ][次へ]

CdbrVersionable::GetPropertyValuesAndLockメソッド

機能

プロパティの取得と同時に指定したロックの設定(バージョン指定あり)

形式

// 全バージョン共有のプロパティを対象にする場合
DmaBoolean GetPropertyValuesAndLock(
DmaInteger32           lPropDefListCount,
SDBR_PROPDEF*          pPropDefList,
SDBR_PROPLIST**        ppPropList,
DmaInteger32           lLockType = DMA_LOCK_WRITE)
 
// バージョンをバージョン識別子で指定する場合
DmaBoolean GetPropertyValuesAndLock(
pDmaString_T           pVersionId,
DmaInteger32           lPropDefListCount,
SDBR_PROPDEF*          pPropDefList,
SDBR_PROPLIST**        ppPropList,
DmaInteger32           lLockType = DMA_LOCK_WRITE)
 
// プロパティ定義情報構造体
struct SDBR_PROPDEF {
    DmaId            PropId;              // プロパティ識別子
};
 
// プロパティ構造体
struct SDBR_PROP {
  DmaId              PropId;              // プロパティ識別子
  DmaInteger32       lType;               // データ型
  DmaInteger32       lCardinality;        // 基本単位
  DmaInteger32       lCount;              // 要素数
  union {                                 // プロパティの値
    pDmaBoolean      pbBoolean;           // Boolean型
    pDmaInteger32    plInteger32;         // Integer32型
    pDmaId           pId;                 // ID型
    pDmapv           ppObject;            // Object型
    ppDmaString_T    ppString;            // String型
  } uniValue;
};
 
// プロパティリスト構造体
struct SDBR_PROPLIST {
    DmaInteger32      lCount;
    SDBR_PROP*        pItem;
};

詳細

ロックタイプを明示的に指定して,オブジェクトのプロパティの値を取得するメソッドです。

バージョン識別子を指定しない場合,DMAオブジェクトのConfigurationHistoryオブジェクトに設定された,オブジェクト全体に対するプロパティが対象になります。

バージョン識別子を指定した場合は,バージョンごとの個別のプロパティが対象になります。バージョン識別子としてNULLを指定した場合は,カレントバージョンが対象になります。

引数

lPropDefListCount(入力)

pPropDefListに指定した配列の要素数を指定します。負の数を指定した場合は,エラーになります。

pPropDefList(入力)

取得するプロパティの定義情報である,SDBR_PROPDEF構造体の配列を指定します。なお,lPropDefListCountが正の整数のときにpPropDefListにNULLを指定すると,エラーになります。

SDBR_PROPDEF構造体に指定する内容については,「付録C.1(13) SDBR_PROPDEF構造体(プロパティ定義情報構造体)」を参照してください。

ppPropList(出力)

取得したプロパティリスト構造体である,SDBR_PROPLIST構造体へのポインタが設定されます。ポインタを格納する領域を指定してください。*ppPropListがポイントする領域は,ライブラリが新たに確保したものです。この領域はメソッドをコールした側がdbrDelete関数を使用して解放してください。なお,プロパティがまったく取得されなかった場合は,NULLが設定されます。

SDBR_PROPLIST構造体およびSDBR_PROP構造体に設定される内容については,「付録C.1(14) SDBR_PROPLIST構造体(プロパティリスト構造体)」および「付録C.1(12) SDBR_PROP構造体(プロパティ構造体)」を参照してください。

pVersionId(入力)

対象となるバージョンのバージョン識別子を指定します。バージョン識別子はCdbrVersionable::GetVersionListメソッド,CdbrVersionable::GetVersionListAndLockメソッドまたはCdbrVersionable::VersionCheckOutメソッドで取得します。NULLを指定した場合は,カレントバージョンのプロパティを取得します。

lLockType(入力)

ロックの種別を指定します。次のどちらかの値を設定します。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_code minor_code 説明 対処
ERR_DB ERR_DB_DEADLOCK_OCCURRED データベースでデッドロックが発生しました。 時間を置いて,再度実行してください。
ERR_DB ERR_DB_FAILED データベースで障害が発生しました。 syslogを参照して,障害の原因を取り除いてください。
ERR_DB ERR_DB_LOCKED オブジェクトがロックされています。 時間を置いて,再度実行してください。
ERR_DBR ERR_ACCESS_NOT_PERMITTED アクセス権がありません。 この操作は実行できません。
ERR_DBR ERR_INVALID_STATUS セッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。 一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。
ERR_DBR ERR_OBJECT_ALREADY_CONNECTED オブジェクトはすでに接続されています。 この操作は実行できません。
ERR_DBR ERR_OBJECT_REMOVED オブジェクトはすでに削除されています。 正しいオブジェクトを指定してください。
ERR_DBR ERR_OIID_NOT_SET OIIDが設定されていません。 SetOIIDメソッドをコールしてから,このメソッドをコールしてください。
ERR_DBR ERR_SESSION_NOT_CONNECT セッションが接続されていません。 セッションを接続してください。
ERR_DMA DMARC_BAD_CLASSID 指定された識別子は,利用できるオブジェクトのクラスではありません。 正しいクラス識別子を指定してください。
ERR_DMA DMARC_BAD_LOCK_TYPE 不正な種類のロックが指定されています。 正しいロックタイプを指定してください。
ERR_DMA DMARC_BAD_OIID SetOIIDメソッドで設定されたOIIDが不正です。 正しいOIIDを指定してください。
ERR_DMA DMARC_BAD_PARAMETER 不正な引数が入力されました。 正しい引数を指定してください。
ERR_DMA DMARC_BAD_PROPID プロパティの識別子が不正です。 正しいプロパティ識別子を指定してください。
ERR_DMA DMARC_BAD_VALUE プロパティやリストの値が,許容範囲外の値であるかまたは最大値を超えました。 値の範囲を見直してください。
ERR_DMA DMARC_NO_MEMORY メモリ不足で実行できません。 メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMA DMARC_NO_RESERVATION バージョン識別子が予約されていません。 チェックイン後に割り当てられる正式なバージョン識別子を,入力引数に設定してください。
ERR_DMA DMARC_NOT_FOUND 要求された要素が見つかりません。 正しいオブジェクトを設定してください。
ERR_DMA DMARC_NOT_SUPPORTED このセッションまたはオブジェクトではサポートされていないメソッドです。 この操作は実行できません。
ERR_DMA DMARC_READ_ONLY 読み取り専用のオブジェクトまたはプロパティのため,異常終了しました。 このプロパティの値は更新できません。
ERR_DMA DMARC_UNEXPECTED 予期しないエラーが発生しました。 処理を終了してください。
ERR_DMA DMARC_VALUE_NOT_SET 要求されたプロパティは値を保持していません。 この操作は実行できません。