CdbrConfiguratedReferentialContainer::GetVTContaineeListメソッド

機能

構成管理しているオブジェクトの一覧取得

形式

//要素一覧を取得する場合
DmaBoolean CdbrConfiguratedReferentialContainer:: GetVTContaineeList(
 pDmaBoolean         pbContinue,
 pDmaString_T        pVersionId,
 DmaInteger32        lPropDefListCount,
 SDBR_PROPDEF*       pPropDefList,
 DmaInteger32        lObjListCount,
 SDBR_VTOBJLIST**    ppVTObjList)
 
//種類別の要素一覧とリンク情報を取得する場合
DmaBoolean CdbrConfiguratedReferentialContainer:: GetVTContaineeList(
 pDmaBoolean               pbContinue,
 pDmaString_T              pVersionId,
 DmaInteger32              lClassType,
 DmaInteger32              lPropDefListCount,
 SDBR_PROPDEF*             pPropDefList,
 DmaInteger32              lLinkPropDefListCount,
 SDBR_PROPDEF*             pLinkPropDefList,
 DmaInteger32              lObjListCount,
 SDBR_VTLINKEDOBJLIST**    ppVTLinkedObjList)

// プロパティ定義情報構造体
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_VTOBJINFO{
  pDmaString_T   pOIID;       // オブジェクトのOIID
  pDmaString_T   pVerOIID;    // バージョントレースの対象になる
                              // オブジェクトのOIID
  pDmaString_T   pLinkID;     // オブジェクトのリンク識別子
  DmaInteger32   lTraceMode;  // 構成管理モード
  DmaInteger32   lType;       // オブジェクトの種別
  SDBR_PROPLIST  PropList;    // プロパティ情報のリスト
};
 
// 構成管理オブジェクトリスト構造体
struct SDBR_VTOBJLIST{
  DmaInteger32     lCount;   // 構成管理オブジェクト情報の個数
  SDBR_VTOBJINFO*  pItem;    // 構成管理オブジェクト情報
};

// 構成管理リンク付きオブジェクト情報構造体
struct SDBR_VTLINKEDOBJINFO{
 pDmaString_T   pOIID;        // オブジェクトのOIID
 pDmaString_T   pVerOIID;     // バージョントレースの対象になる
                              // オブジェクトのOIID
 pDmaString_T   pLinkID;      // リンク識別子
 DmaInteger32   lTraceMode;   // 構成管理モード
 DmaInteger32   lType;        // オブジェクトの種別
 SDBR_PROPLIST  PropList;     // プロパティリスト
 SDBR_PROPLIST  LinkPropList; // リンクのプロパティリスト
};
 
// 構成管理リンク付きオブジェクトリスト構造体
struct SDBR_VTLINKEDOBJLIST{
 DmaInteger32          lCount; // リンク付きオブジェクト情報の個数
 SDBR_VTLINKEDOBJINFO* pItem;  // リンク付きオブジェクト情報
};

詳細

CdbrConfiguratedReferentialContainerオブジェクトのpVersionIdで指定したバージョンが構成管理しているオブジェクトの一覧を取得するメソッドです。

pPropDefListでプロパティを指定した場合は,指しているバージョン(構成管理モードがFLOATINGモードの場合は最新のバージョン,FIXモードの場合は固定のバージョン)のプロパティも取得します。また,pLinkPropDefListで指定したユーザ定義プロパティを持つリンクについては,そのプロパティの値も取得します。なお,リンクのプロパティとは,DMAオブジェクトのVersionTraceableContainmentRelationshipオブジェクトのプロパティです。

初回のメソッドのコールですべての要素の取得が完了しなかった場合,*pbContinueにDMA_TRUEが設定されるので,再度メソッドをコールして残りを取得してください。

複数回に分けて情報を取得する場合,取得される内容はすべて初回にコールした時点での状態が反映されます。したがって,1回目のメソッドのコール以降に変更した要素数やプロパティ値は,2回目以降のコールに反映されません。

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

次に,構成管理しているCdbrVersionableDocumentオブジェクトの一覧を10個ずつ取得して,そのOIIDとバージョンが固定されているかどうかを出力する例を示します。なお,エラー処理については省略しています。

構成管理しているCdbrVersionableDocumentオブジェクトの一覧を取得する例

SDBR_VTOBJLIST*  pVTObjList = NULL;
DmaInteger32  lLoop;
DmaBoolean    bContinue = DMA_UNKNOWN;
// すべての要素を取得します。
while (bContinue != DMA_FALSE){
 //情報の取得
 pDbrCfgRfct->GetVTContaineeList(&bContinue,
    NULL, 0, NULL, 10, &pVTObjList);
 //取得数だけループして,
 //OIIDとバージョンが固定されているかどうかを出力します。
 for (lLoop = 0; lLoop < pVTObjList->lCount; lLoop++) {
   printf("OIID=%s¥n", pVTObjList->pItem[lLoop].pOIID);
   if (pVTObjList->pItem[lLoop].lTraceMode == DBR_MODE_FIX)
   {
       printf("Version=Fix¥n");
   }else{
       printf("Version=UnFix¥n");
   }
 }
 dbrDelete (pVTObjList);
}

引数

pbContinue(入力/出力)

リストの取得方法を示す値を格納する領域を指定します。

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

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

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

表4-9 ほかの引数の扱われ方(SDBR_VTOBJLIST構造体を取得する場合)

ほかの引数pbContinueの値
DMA_TRUEDMA_FALSE
pVersionId
lPropDefListCount×
pPropDefList×
lObjListCount
ppVTObjList
(凡例)
○:有効
×:無効
注※
前回と異なる値を指定した場合は,DMA_TRUEの指定が無効になり,DMA_FALSEを指定したものとして処理されます。

表4-10 ほかの引数の扱われ方(SDBR_VTLINKEDOBJLIST構造体を取得する場合)

ほかの引数pbContinueの値
DMA_TRUEDMA_FALSE
pVersionId
lClassType×
lPropDefListCount×
pPropDefList×
lLinkPropDefListCount×
pLinkPropDefList×
lObjListCount
ppLinkedObjList
(凡例)
○:有効
×:無効
注※
前回と異なる値を指定した場合は,DMA_TRUEの指定が無効になり,DMA_FALSEを指定したものとして処理されます。

pVersionId(入力)

対象となるCdbrConfiguratedReferentialContainerオブジェクトのバージョン識別子を指定します。バージョン識別子は,CdbrVersionable::GetVersionListメソッドまたはCdbrVersionable::VersionCheckOutメソッドによって取得したものを指定します。チェックアウト中のオブジェクトに対しては,仮のバージョン識別子を指定してください。NULLを指定した場合は,カレントバージョンが対象になります。

lPropDefListCount(入力)

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

pPropDefList(入力)

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

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

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

lObjListCount(入力)

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

ppVTObjList(出力)

構成管理オブジェクトリスト構造体である,SDBR_VTOBJLIST構造体へのポインタが設定されます。構成管理オブジェクトリスト構造体へのポインタを格納する領域を指定してください。

**ppVTObjListがポイントするメモリは,ライブラリが新たに確保したものです。このメモリは,ユーザプログラムでdbrDelete関数を使用して解放してください。

SDBR_VTOBJLIST構造体およびSDBR_VTOBJINFO構造体に設定される内容については,「付録C.1(26) SDBR_VTOBJLIST構造体(構成管理オブジェクトリスト構造体)」および「付録C.1(25) SDBR_VTOBJINFO構造体(構成管理オブジェクト情報構造体)」を参照してください。

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

lClassType(入力)

取得する要素のクラス識別子を指定します。これによって,指定されたクラス識別子の要素だけが取得できます。ここでは,指しているバージョンのオブジェクトに該当するクラス識別子を指定する必要があります。クラス識別子の一覧を次に示します。

表4-11 クラス識別子の一覧

クラス識別子クラスの種別
DBR_CLASS_VERSIONTRACEABLECONTAINERCdbrVersionTraceableContainerクラス
DBR_CLASS_DOCUMENTCdbrDocumentクラス
DBR_CLASS_ALLすべてのクラス

それぞれのクラスの識別子をOR条件を指定した取得もできます。例えば,CdbrDocumentクラスの要素とCdbrVersionTraceableContainerクラスの要素を取得したい場合は,次のように指定します。

DBR_CLASS_DOCUMENT | DBR_CLASS_VERSIONTRACEABLECONTAINER

すべてのクラスの要素を取得する場合は,DBR_CLASS_ALLを指定してください。

lLinkPropDefListCount(入力)

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

pLinkPropDefList(入力)

同時に取得するリンクのプロパティの定義情報である,SDBR_PROPDEF構造体の配列を指定します。指定できるリンクのプロパティ識別子は,ユーザが定義したプロパティの識別子だけです。

プロパティを取得しない場合はNULLを指定します。なお,lLinkPropDefListCountが正の整数のときにpLinkPropDefListにNULLを指定した場合は,エラーになります。

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

ppVTLinkedObjList(出力)

取得した情報を格納する構成管理リンク付きオブジェクトリスト構造体である,SDBR_VTLINKEDOBJLIST構造体へのポインタが設定されます。**ppVTLinkedObjListがポイントするメモリは,ライブラリが新たに確保したものです。このメモリは,ユーザプログラムでdbrDelete関数を使用して解放してください。

SDBR_VTLINKEDOBJLIST構造体およびSDBR_VTLINKEDOBJINFO構造体に設定される内容については,「付録C.1(24) SDBR_VTLINKEDOBJLIST構造体(構成管理リンク付きオブジェクトリスト構造体)」および「付録C.1(23) SDBR_VTLINKEDOBJINFO構造体(構成管理リンク付きオブジェクト情報構造体)」を参照してください。

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

戻り値

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_NO_RESERVATIONバージョン識別子が予約されていません。チェックイン後に割り当てられる正式なバージョン識別子を,入力引数に設定してください。
ERR_DMADMARC_NOT_FOUND要求された要素が見つかりません。正しいオブジェクトを設定してください。
ERR_DMADMARC_NOT_SUPPORTEDこのセッションまたはオブジェクトではサポートされていないメソッドです。この操作は実行できません。
ERR_DMADMARC_TIMEOUT制限時間を超過しました。タイムアウトしました。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。
ERR_DMAEDMRC_NOT_INTRANSACTIONトランザクション外でメソッドが呼ばれました。Beginメソッドの呼び出し後に,この操作を実行してください。