CdbrVersionable::GetVersionListメソッド

機能

バージョン情報一覧の取得

形式

DmaBoolean GetVersionList(
 pDmaBoolean              pbContinue,
 DmaInteger32             lPropDefListCount,
 SDBR_PROPDEF*            pPropDefList,
 DmaInteger32             lObjListCount,
 SDBR_OBJLIST**           ppObjList,
 DmaInteger32             lOrdered = DBR_ORDER_NONE)
 
// プロパティ定義情報構造体
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;
};
 
// オブジェクト情報構造体
struct SDBR_OBJINFO {
   pDmaString_T       pOIID;         // オブジェクトのOIID
   DmaInteger32       lType;         // オブジェクトの種別
   SDBR_PROPLIST      PropList;      // プロパティリスト構造体
};
 
// オブジェクトリスト構造体
struct SDBR_OBJLIST {
   DmaInteger32      lCount;
   SDBR_OBJINFO*     pItem;
};

詳細

このオブジェクトが包含している,すでに確定したバージョン情報の一覧を取得するメソッドです。取得するバージョン情報を,バージョンが作成された順序によってソートして取得できます。また,pPropDefListで指定したプロパティを持つオブジェクトについては,そのプロパティ値も取得します。

初回のメソッドのコールですべての要素の取得が完了しなかった場合,*pbContinueにDMA_TRUEが設定されるので,再度メソッドをコールして残りを取得してください。ただし,再度取得する前に文書の削除処理をした場合,残りが正しく取得されないことがあります。

要素の個数に変更がなく,同じオブジェクトに対してこのメソッドをコールした場合も,取得される情報の順序は常に異なる可能性があります。

使用方法については,「5. CdbrContainableクラス(包含要素を扱うクラス)」のCdbrContainable::GetContainerListメソッドを参照してください。

引数

pbContinue(入力/出力)

リストの取得方法を指定します。

DMA_TRUEを指定すると,オブジェクトに対する前回のメソッドのコールで取得したものの次の要素から取得します。DMA_FALSEまたはDMA_UNKNOWNを 指定すると,前回取得したものの残りを破棄して,新たに先頭から取得します。なお,オブジェクトの作成後初めてこのメソッドをコールする場合,または前回のコールですべて取得した場合は,すべてDMA_FALSEが指定されたものとして処理されます。

正常終了すると,メソッドを継続してコールする必要があるかどうかを示す値が設定されます。リストの呼び出しがすべて完了した場合はDMA_FALSEが設定されます。まだ取得されていない要素がある場合はDMA_TRUEが設定されます。

2回目以降に取得する場合に,DMA_TRUEを指定した場合とDMA_FALSEを指定した場合の,ほかの引数に指定した値の扱われ方について,次に示します。

表15-3 ほかの引数の扱われ方(SDBR_OBJLIST構造体を取得する場合)

ほかの引数pbContinueの値
DMA_TRUEDMA_FALSE
lPropDefListCount×
pPropDefList×
lObjListCount
ppObjList
lOrdered×

(凡例)

○:有効

×:無効


lPropDefListCount(入力)

pPropDefListの要素数を指定します。0を指定した場合は,プロパティを取得しません。負の数を指定した場合は,エラーになります。

pPropDefList(入力)

同時に取得するプロパティの定義情報である,SDBR_PROPDEF構造体の配列を指定します。

プロパティを取得しない場合はNULLを指定します。なお,lPropDefListCountが正の整数のときにpPropDefListにNULLを指定した場合も,プロパティを取得しません。

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

lObjListCount(入力)

取得する情報の個数を指定します。0以下の数を指定するとエラーになります。

ppObjList(出力)

取得した情報が設定されます。バージョン情報の一覧は,オブジェクト情報リスト構造体である,SDBR_OBJINFO構造体の配列として格納されます。*ppObjListがポイントするメモリは,ライブラリが新たに確保したものです。このメモリは,ユーザプログラムでdbrDelete関数を使用して解放してください。なお,*ppObjListを指定したメモリ解放によって,構造体のメンバ(*ppObjList)->pItemおよびその先に確保されているメモリはすべて解放されます。したがって,メソッドをコールした側がこれらのメンバのメモリを個別に解放する必要はありません。

SDBR_OBJLIST構造体およびSDBR_OBJINFO構造体に設定される内容については,「付録C.1(9) SDBR_OBJLIST構造体(オブジェクトリスト構造体)」および「付録C.1(8) SDBR_OBJINFO構造体(オブジェクト情報構造体)」を参照してください。ただし,SDBR_OBJINFO構造体メンバのpOIIDには,該当するオブジェクトのバージョン識別子が設定されます。また,lTypeに相当する情報が設定されても,その内容は保証できません。

なお,バージョン管理されるオブジェクト(dmaClass_Versionableクラスのサブクラスのオブジェクト)が引数pPropDefListで指定したプロパティを持つ場合に,プロパティ情報が設定されるSDBR_PROPLIST構造体およびSDBR_PROP構造体については,「付録C.1(14) SDBR_PROPLIST構造体(プロパティリスト構造体)」および「付録C.1(12) SDBR_PROP構造体(プロパティ構造体)」を参照してください。

lOrdered(入力)

バージョン情報を取得する順序を指定します。順序は,バージョンの順序値に依存します。次のどれかを指定してください。なお,省略した場合は,取得するバージョンに順序性はありません。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_codeminor_code説明対処
ERR_DBERR_DB_DEADLOCK_OCCURREDデータベースでデッドロックが発生しました。時間を置いて,再度実行してください。
ERR_DBERR_DB_FAILEDデータベースで障害が発生しました。syslogを参照して,障害の原因を取り除いてください。
ERR_DBERR_DB_LOCKEDオブジェクトがロックされています。時間を置いて,再度実行してください。
ERR_DBRERR_ACCESS_NOT_PERMITTEDアクセス権がありません。この操作は実行できません。
ERR_DBRERR_ACLIB_OBJECT_INVALIDクラスライブラリのオブジェクトは無効です。有効なクラスライブラリのオブジェクトを指定してください。
ERR_DBRERR_INVALID_STATUSセッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。
ERR_DBRERR_OBJECT_REMOVEDオブジェクトはすでに削除されています。正しいオブジェクトを指定してください。
ERR_DBRERR_OIID_NOT_SETOIIDが設定されていません。SetOIIDメソッドをコールしてから,このメソッドをコールしてください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。
ERR_DMADMARC_BAD_PROPIDプロパティの識別子が不正です。正しいプロパティ識別子を指定してください。
ERR_DMADMARC_BAD_VALUEプロパティやリストの値が,許容範囲外の値であるかまたは最大値を超えました。値の範囲を見直してください。
ERR_DMADMARC_LOST_CONNECTION現在のオブジェクトからデータベースへの論理的な接続が失われました。操作は完了できません。文書空間に再接続してください。
ERR_DMADMARC_NO_MEMORYメモリ不足で実行できません。メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMADMARC_NOT_FOUND要求された要素が見つかりません。正しいオブジェクトを設定してください。
ERR_DMADMARC_NOT_SUPPORTEDこのセッションまたはオブジェクトではサポートされていないメソッドです。この操作は実行できません。
ERR_DMADMARC_TIMEOUT制限時間を超過しました。タイムアウトしました。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。
ERR_DMAEDMRC_NOT_INTRANSACTIONトランザクション外でメソッドが呼ばれました。Beginメソッドの呼び出し後に,この操作を実行してください。