CdbrReferentialContainer::GetContainableListメソッド
機能
包含要素の一覧取得
形式
//包含要素の一覧を取得する場合
DmaBoolean GetContainableList(
pDmaBoolean pbContinue,
DmaInteger32 lContainmentType,
DmaInteger32 lPropDefListCount,
SDBR_PROPDEF* pPropDefList,
DmaInteger32 lObjListCount,
SDBR_OBJLIST** ppObjList )
//種類別の包含要素の一覧とリンク情報を取得する場合
DmaBoolean GetContainableList(
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; // リンク付きオブジェクト情報
};
詳細
このオブジェクトが包含している,CdbrContainableクラスのサブクラスのオブジェクトの一覧を取得するメソッドです。その際,pPropDefListで指定したプロパティを持つオブジェクトについては,そのプロパティの値も取得します。また,pLinkPropDefListで指定したプロパティを持つリンクについては,そのプロパティの値も取得します。
初回のメソッドのコールですべての要素の取得が完了しなかった場合,*pbContinueにDMA_TRUEが設定されるので,再度メソッドをコールして残りを取得してください。
複数回に分けて情報を取得する場合,取得される内容はすべて初回にコールした時点での状態が反映されます。したがって,1回目のメソッドのコール以降に変更した要素数やプロパティ値は,2回目以降のコールに反映されません。
要素の個数に変更がなく,同じオブジェクトに対してこのメソッドをコールしても,取得される情報の順序は常に異なる可能性があります。
このメソッドの使用方法については,「5. CdbrContainableクラス(包含要素を扱うクラス)」のCdbrContainable::GetContainerListメソッドを参照してください。
引数
pbContinue(入力/出力)
リストの取得方法を示す値を格納する領域を指定します。
DMA_TRUEを指定すると,オブジェクトに対する前回のメソッドのコールで取得したものの次の要素から取得します。DMA_FALSEまたはDMA_UNKNOWNを指定すると,前回取得した値の残りを破棄して,新たに先頭から取得します。なお,オブジェクトの作成後初めてメソッドをコールする場合,または前回の読み出しですべて取得した場合は,すべてDMA_FALSEが指定されたものとして処理されます。
また,前回と異なる引数を指定してメソッドをコールした場合は,前回取得した値の残りを破棄して,新たに先頭から取得します。
正常終了すると,メソッドを継続してコールする必要があるかどうかを示す値が設定されます。リストの呼び出しがすべて完了した場合はDMA_FALSEが設定されます。まだ取得されていない要素がある場合はDMA_TRUEが設定されます。
2回目以降に取得する場合に,DMA_TRUEを指定した場合とDMA_FALSEを指定した場合の,ほかの引数に指定した値の扱われ方について,次に示します。
表12-3 ほかの引数の扱われ方(SDBR_OBJLIST構造体を取得する場合)
ほかの引数 | pbContinueの値 | |
---|---|---|
DMA_TRUE | DMA_FALSE | |
lContainmentType | × | ○ |
lPropDefListCount | × | ○ |
pPropDefList | × | ○ |
lObjListCount | ○ | ○ |
ppVTObjList | ○ | ○ |
(凡例)
○:有効
×:無効
注※ 前回と異なる値を指定した場合は,DMA_TRUEの指定が無効になり,DMA_FALSEを指定したものとして処理されます。
表12-4 ほかの引数の扱われ方(SDBR_LINKEDOBJLIST構造体を取得する場合)
ほかの引数 | pbContinueの値 | |
---|---|---|
DMA_TRUE | DMA_FALSE | |
lContainmentType | × | ○ |
lClassType | × | ○ |
lPropDefListCount | × | ○ |
pPropDefList | × | ○ |
lLinkPropDefListCount | × | ○ |
pLinkPropDefList | × | ○ |
lObjListCount | ○ | ○ |
ppLinkedObjList | ○ | ○ |
(凡例)
○:有効
×:無効
注※ 前回と異なる値を指定した場合は,DMA_TRUEの指定が無効になり,DMA_FALSEを指定したものとして処理されます。
lContainmentType(入力)
対象となるコンテインメントの種類を指定します。次のどちらかの値を指定します。
*pbContinueにDMA_TRUEを指定して継続して取得する場合は,1回目の取得の開始時に指定された種類のコンテインメントが対象となり,この値は無視されます。
lPropDefListCount(入力)
pPropDefListの要素数を指定します。0を指定した場合は,プロパティを取得しません。負の数を指定した場合は,エラーになります。
pPropDefList(入力)
同時に取得するプロパティの定義情報である,SDBR_PROPDEF構造体の配列を指定します。
プロパティを取得しない場合はNULLを指定します。なお,lPropDefListCountが正の整数のときにpPropDefListにNULLを指定した場合は,エラーになります。
SDBR_PROPDEF構造体に指定する内容については,「付録C.1(13) SDBR_PROPDEF構造体(プロパティ定義情報構造体)」を参照してください。
lObjListCount(入力)
取得する情報の個数を指定します。0以下の数を指定するとエラーになります。
ppObjList(出力)
取得した情報を格納するオブジェクト情報リスト構造体である,SDBR_OBJLIST構造体へのポインタが設定されます。*ppObjListがポイントするメモリは,クラスライブラリが新たに確保したものです。このメモリは,ユーザプログラムでdbrDelete関数を使用して解放してください。なお,*ppObjListを指定したメモリの解放によって,構造体のメンバ(*ppObjList)->pItemおよびその先に確保されているメモリはすべて解放されます。したがって,メソッドをコールした側がこれらのメンバのメモリを個別に解放する必要はありません。
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構造体(プロパティ構造体)」を参照してください。
lClassType(入力)
指定されたクラス識別子の要素だけを取得します。指定できる識別子を次に示します。
表12-5 クラス識別子の一覧
クラス識別子 | クラスの種別 |
---|---|
DBR_CLASS_CONFIGURATEDREFERENTIALCONTAINER | CdbrConfiguratedReferentialContainerクラス |
DBR_CLASS_DOCUMENT | CdbrDocumentクラス |
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を指定してください。
lLinkPropDefListCount(入力)
pLinkPropDefListの要素数を指定します。0を指定した場合は,プロパティを取得しません。負の数を指定した場合は,エラーになります。
pLinkPropDefList(入力)
同時に取得するリンクのプロパティの定義情報である,SDBR_PROPDEF構造体の配列を指定します。リンクのプロパティとして指定できる識別子は,ユーザが定義したプロパティの識別子だけです。
プロパティを取得しない場合はNULLを指定します。なお,lLinkPropDefListCountが正の整数のときにpLinkPropDefListにNULLを指定した場合は,エラーになります。
SDBR_PROPDEF構造体に指定する内容については,「付録C.1(13) SDBR_PROPDEF構造体(プロパティ定義情報構造体)」を参照してください。
ppLinkedObjList(出力)
取得した情報を格納するリンク付きオブジェクトリスト構造体である,SDBR_LINKEDOBJLIST構造体へのポインタが設定されます。**ppLinkedObjListがポイントするメモリは,ライブラリが新たに確保したものです。このメモリは,ユーザプログラムで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_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_ACLIB_OBJECT_INVALID | クラスライブラリのオブジェクトは無効です。 | 有効なクラスライブラリのオブジェクトを指定してください。 |
ERR_DBR | ERR_INVALID_STATUS | セッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。 | 一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。 |
ERR_DBR | ERR_OBJECT_REMOVED | オブジェクトはすでに削除されています。 | 正しいオブジェクトを指定してください。 |
ERR_DBR | ERR_OIID_NOT_SET | OIIDが設定されていません。 | SetOIIDメソッドをコールしてから,このメソッドをコールしてください。 |
ERR_DBR | ERR_SESSION_NOT_CONNECT | セッションが接続されていません。 | セッションを接続してください。 |
ERR_DMA | DMARC_BAD_PARAMETER | 不正な引数が入力されました。 | 正しい引数を指定してください。 |
ERR_DMA | DMARC_BAD_PROPID | プロパティの識別子が不正です。 | 正しいプロパティ識別子を指定してください。 |
ERR_DMA | DMARC_LOST_CONNECTION | 現在のオブジェクトからデータベースへの論理的な接続が失われました。操作は完了できません。 | 文書空間に再接続してください。 |
ERR_DMA | DMARC_NO_MEMORY | メモリ不足で実行できません。 | メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。 |
ERR_DMA | DMARC_NOT_FOUND | 要求された要素が見つかりません。 | 正しいオブジェクトを設定してください。 |
ERR_DMA | DMARC_NOT_SUPPORTED | このセッションまたはオブジェクトではサポートされていないメソッドです。 | この操作は実行できません。 |
ERR_DMA | DMARC_TIMEOUT | 制限時間を超過しました。 | タイムアウトしました。 |
ERR_DMA | DMARC_UNEXPECTED | 予期しないエラーが発生しました。 | 処理を終了してください。 |
ERR_DMA | EDMRC_NOT_INTRANSACTION | トランザクション外でメソッドが呼ばれました。 | Beginメソッドの呼び出し後に,この操作を実行してください。 |