CdbrContainable::GetContainerListメソッド

機能

コンテナの一覧取得

形式

// コンテナの一覧を取得する場合
DmaBoolean GetContainerList(
 pDmaBoolean         pbContinue,
 DmaInteger32        lContainmentType,
 DmaInteger32        lPropDefListCount,
 SDBR_PROPDEF*       pPropDefList,
 DmaInteger32        lObjListCount,
 SDBR_OBJLIST**      ppObjList )
 
// コンテナの一覧とそのリンク情報を取得する場合
DmaBoolean GetContainerList(
 pDmaBoolean            pbContinue,
 DmaInteger32           lContainmentType,
 DmaInteger32           lPropDefListCount,
 SDBR_PROPDEF*          pPropDefList,
 DmaInteger32           lLinkPropDefListCount,
 SDBR_PROPDEF*          pLinkPropDefList,
 DmaInteger32           lObjListCount,
 SDBR_LINKEDOBJLIST**   ppLinkedObjList )
 
// クラスを指定してコンテナの一覧とそのリンク情報を取得する場合
DmaBoolean GetContainerList(
 pDmaBoolean            pbContinue,
 DmaInteger32           lContainmentType,
 DmaInteger32           lClassType,
 DmaInteger32           lPropDefListCount,
 SDBR_PROPDEF*          pPropDefList,
 DmaInteger32           lLinkPropDefListCount,
 SDBR_PROPDEF*          pLinkPropDefList,
 DmaInteger32           lObjListCount,
 SDBR_LINKEDOBJLIST**   ppLinkedObjList )
 
// プロパティ定義情報構造体
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;
};
 
// リンク付きオブジェクト情報構造体
struct SDBR_LINKEDOBJINFO{
 pDmaString_T   pOIID;        // オブジェクトのOIID
 DmaInteger32   lType;        // オブジェクトの種別
 pDmaString_T   pLinkId;      // リンクの識別子
 SDBR_PROPLIST  PropList;     // オブジェクトのプロパティリスト
 SDBR_PROPLIST  LinkPropList; // リンクのプロパティリスト
};
 
// リンク付きオブジェクトリスト構造体
struct SDBR_LINKEDOBJLIST{
 DmaInteger32        lCount; //リンク付きオブジェクト情報の個数
 SDBR_LINKEDOBJINFO* pItem;  //リンク付きオブジェクト情報
};

詳細

このオブジェクトを包含しているコンテナ(CdbrReferentialContainerオブジェクトおよびCdbrVersionTraceableContainerオブジェクト)の一覧を取得するメソッドです。その際,pPropDefListで指定したプロパティを持つオブジェクトについては,そのプロパティの値も取得します。また,pLinkPropDefListに指定したプロパティを持つリンクについては,そのプロパティの値も取得します。

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

複数回に分けて情報を取得する場合,取得される内容はすべて初回にメソッドをコールした時点での状態を示しています。したがって,1回目のメソッドのコール要素の個数に変更がなく,同じオブジェクトに対するメソッドのコールであっても,取得される情報の順序は常に異なる可能性があります。

次に,CdbrContainableクラスのサブクラスのオブジェクトである,CdbrVersionableDocumentオブジェクトを包含するCdbrReferentialContainerオブジェクトの一覧を10個ずつ取得して,そのOIIDを出力する例を示します。なお,エラー処理は省略しています。

包含要素一覧の取得例

SDBR_OBJLIST* pObjList = NULL;
DmaInteger32  lLoop;
DmaBoolean    bContinue = DMA_UNKNOWN;
//すべての要素を取得します。
while (bContinue != DMA_FALSE) {
   //情報の取得
   pDbrVerDoc->GetContainerList(&bContinue,
   DBR_CONTAINMENT_REFERENTIAL, 0, NULL, 10, &pObjList);
   //取得数だけループして,OIIDを出力します。
   for (lLoop = 0; lLoop < pObjList->lCount; lLoop++) {
       printf("OIID=%s¥n", pObjList->pItem[lLoop].pOIID);
   }
}

引数

pbContinue(入力/出力)

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

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

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

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

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

ほかの引数pbContinueの値
DMA_TRUEDMA_FALSE
lContainmentType×
lPropDefListCount×
pPropDefList×
lObjListCount
ppObjList
(凡例)
○:有効
×:無効

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

ほかの引数pbContinueの値
DMA_TRUEDMA_FALSE
lContainmentType×
lClassType×
lPropDefListCount×
pPropDefList×
lLinkPropDefListCount×
pLinkPropDefList×
lObjListCount
ppLinkedObjList
(凡例)
○:有効
×:無効

lContainmentType(入力)

対象となるコンテインメントの種類を指定します。次のどちらかの値を指定します。

*pbContinueにDMA_TRUEを指定して継続取得する場合,継続取得の開始時に指定された種別が有効になり,この値は無視されます。

lClassType(入力)

指定したクラス識別子の要素だけを取得します。指定できる識別子を次に示します。

表5-5 クラス識別子の一覧

クラス識別子クラスライブラリのクラス
DBR_CLASS_REFERENTIALCONTAINERCdbrReferentialContainerクラス
DBR_CLASS_RFCT_OR_VTCTCdbrVersionTraceableContainerクラスまたはCdbrReferentialContainerクラス
DBR_CLASS_VERSIONTRACEABLECONTAINERCdbrVersionTraceableContainerクラス
DBR_CLASS_ALL上記すべてのクラス

それぞれのクラスの識別子をOR条件を指定した取得もできます。CdbrReferentialContainerクラスとCdbrVersionTraceableContainerクラスの要素を取得したい場合は,DBR_CLASS_RFCT_OR_VTCTを指定してください。

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

lPropDefListCount(入力)

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

pPropDefList(入力)

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

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

情報を取得するオブジェクトがこのプロパティを持つ場合,(*ppObjList)->Item[n].PropListにプロパティ情報が設定されます。

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

lLinkPropDefListCount(入力)

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

pLinkPropDefList(入力)

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

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

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

lObjListCount(入力)

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

ppObjList(出力)

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

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

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

ppLinkedObjList(出力)

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

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

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

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_codeminor_code説明対処
ERR_CORBACORBAの戻り値が設定されます。CORBAでエラーが発生しました。ユーザプログラムでは対処できません。エラー情報として文字列の値を取得して,ユーザプログラムを終了してください。
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_DBRERR_SESSION_NOT_CONNECTセッションが接続されていません。セッションを接続してください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。
ERR_DMADMARC_BAD_PROPIDプロパティの識別子が不正です。正しいプロパティ識別子を指定してください。
ERR_DMADMARC_LOST_CONNECTION現在のオブジェクトからデータベースへの論理的な接続が失われました。操作は完了できません。文書空間に再接続してください。
ERR_DMADMARC_NO_MEMORYメモリ不足で実行できません。メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMADMARC_NOT_FOUND要求された要素が見つかりません。正しいオブジェクトを設定してください。
ERR_DMADMARC_NOT_SUPPORTEDこのセッションまたはオブジェクトではサポートされていないメソッドです。この操作は実行できません。
ERR_DMADMARC_TIMEOUT制限時間を超過しました。タイムアウトしました。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。
ERR_DMAEDMRC_NOT_INTRANSACTIONトランザクション外でメソッドが呼ばれました。Beginメソッドの呼び出し後に,この操作を実行してください。