バインドしているオブジェクトの一覧情報の取得

DmaBoolean GetBindObjectList(
    pDmaBoolean        pbContinue,
    DmaInteger32       lClassType,
    DmaInteger32       lPropDefListCount,
    SDBR_PROPDEF*      pPropDefList,
    DmaInteger32       lObjListCount,
    SDBR_OBJLIST**     ppObjList )
　
// プロパティ定義情報構造体
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;
};

パブリックACLオブジェクトをバインドしているオブジェクトに関する一覧情報を取得するメソッドです。また，pPropDefListで指定したプロパティを持つオブジェクトについては，そのプロパティ値も取得します。

１回のメソッドのコールで一覧の取得が完了しなかった場合，引数pbContinueにDMA_TRUEが設定されるので，引数pbContinueがDMA_FALSEになるまで繰り返しメソッドをコールして残りを取得してください。

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

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

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

pbContinue（入力／出力）

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

DMA_TRUEを指定すると，オブジェクトに対する前回のメソッドのコールで取得した要素の次の要素から取得します。DMA_FALSEまたはDMA_UNKNOWNを指定すると，前回取得の残りを破棄し，新たに先頭から取得します。

なお，オブジェクトの作成後初めてメソッドをコールした場合，または前回の読み出しですべて取得した場合は，DMA_FALSEが指定されたものとして動作します。

前回メソッドをコールした時と引数が異なるメソッドをコールした場合は，pbContinueの値は無視され，前回取得の残りを破棄して新たに先頭から取得します。

正常終了すると，メソッドを継続してコールする必要があるかどうかを示す次の値が設定されます。

• DMA_TRUE
  継続可能（まだ取得していない残りの要素があります）。
  
• DMA_FALSE
  継続不可（すべての要素を取得しました）。
  

lClassType（入力）

対象となるオブジェクトのクラス種別を，クラス識別子によって指定します。これによって，指定されたクラス識別子の要素だけが取得できます。

クラス識別子の一覧を次に示します。

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

クラス識別子	クラスの種別
DBR_CLASS_CONFIGURATEDREFERENTIALCONTAINER	CdbrConfiguratedReferentialContainerクラス
DBR_CLASS_DOCUMENT	CdbrDocumentクラス
DBR_CLASS_INDEPENDENTPERSISTENCE	CdbrIndependentPersistenceクラス
DBR_CLASS_REFERENTIALCONTAINER	CdbrReferentialContainerクラス
DBR_CLASS_RFCT_OR_VTCT	CdbrReferentialContainerクラスとCdbrVersionTraceableContainerクラスのOR条件
DBR_CLASS_VERSIONABLEDOCUMENT	CdbrVersionableDocumentクラス
DBR_CLASS_VERSIONTRACEABLECONTAINER	CdbrVersionTraceableContainerクラス
DBR_CLASS_ALL	すべてのクラス

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

DBR_CLASS_REFERENTIALCONTAINER | DBR_CLASS_DOCUMENT

ただし，CdbrReferentialContainerクラスとCdbrVersionTraceableContainerクラスの要素を取得したい場合は，DBR_CLASS_RFCT_OR_VTCTを指定してください。DBR_CLASS_RFCT_OR_VTCTとほかのクラスのクラス識別子をORで指定することもできます。

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

なお，特定のクラス種別を指定すると，内部で該当するオブジェクトの選別が実行されるため処理が遅くなります。このため，クラス種別はできるだけDBR_CLASS_ALLを指定するようにしてください。例えば，パブリックACLをバインドしているのがCdbrReferentialContainerオブジェクトだけだとわかっている場合，クラス種別としてDBR_CLASS_REFERENTIALCONTAINERを指定するのではなく，DBR_CLASS_ALLを指定してください。

lPropDefListCount（入力）

同時に取得するプロパティの個数（引数pPropDefListに指定する配列の要素数）を0以上の値で指定します。0を指定した場合，プロパティは取得されません。負の値を指定した場合はエラーになります。

pPropDefList（入力）

同時に取得するプロパティの定義情報である，SDBR_PROPDEF構造体の配列を指定します。lPropDefCountが0の場合，この引数は無視されます。

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構造体（プロパティ構造体）」を参照してください。

DMA_TRUE　 正常終了

DMA_FALSE　異常終了

major_code	minor_code	説明	対処
ERR_CORBA	CORBAの戻り値が設定されます。	CORBAでエラーが発生しました。	ユーザプログラムでは対処できません。エラー情報として文字列の値を取得して，ユーザプログラムを終了してください。
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_ACCESSCONTROL_NOT_SUPPORTED	アクセス制御機能が未サポートです。	この操作は実行できません。
ERR_DBR	ERR_ACLIB_OBJECT_INVALID	クラスライブラリのオブジェクトは無効です。	有効なクラスライブラリのオブジェクトを指定してください。
ERR_DBR	ERR_INVALID_STATUS	セッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。	一つのセッションに対しては，一度に一つの処理要求しか出さないように見直してください。
ERR_DBR	ERR_OBJECT_REMOVED	オブジェクトはすでに削除されています。	正しいオブジェクトを指定してください。
ERR_DBR	ERR_OIID_NOT_SET	OIIDが設定されていません。	SetOIIDメソッドでOIIDを設定するか，ConnectObjectメソッドでオブジェクトを接続してください。
ERR_DBR	ERR_SESSION_NOT_CONNECT	セッションが接続されていません。	セッションを接続してください。
ERR_DMA	DMARC_BAD_OIID	SetOIIDメソッドで設定されたOIIDが不正です。	正しいOIIDを指定してください。
ERR_DMA	DMARC_BAD_PARAMETER	不正な引数が入力されました。	正しい引数を指定してください。
ERR_DMA	DMARC_LOST_CONNECTION	現在のオブジェクトからデータベースへの論理的な接続が失われました。操作は完了できません。	文書空間に再接続してください。
ERR_DMA	DMARC_NO_MEMORY	メモリ不足で実行できません。	メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて，処理を再実行してください。
ERR_DMA	DMARC_NOT_FOUND	要求された要素が見つかりません。	正しいオブジェクトを設定してください。
ERR_DMA	DMARC_TIMEOUT	制限時間を超過しました。	タイムアウトしました。
ERR_DMA	DMARC_UNEXPECTED	予期しないエラーが発生しました。	処理を終了してください。
ERR_DMA	DMARC_UNEXPECTED	予期しないエラーが発生しました。	処理を終了してください。
ERR_DMA	EDMRC_NOT_INTRANSACTION	トランザクション外でメソッドが呼ばれました。	Beginメソッドの呼び出し後に，この操作を実行してください。