uCosminexus DocumentBroker Version 3 クラスライブラリ C++ リファレンス 基本機能編

[目次][用語][索引][前へ][次へ]

CdbrConfiguratedReferentialContainer::Linkメソッド

機能

Containableオブジェクトとの関連づけ

形式

// オブジェクトを指定して関連づける場合
DmaBoolean CdbrConfiguratedReferentialContainer::Link(
  pDmaString_T      pVersionId,
  CdbrContainable*  pDbrContainable,
  DmaInteger32      lContainmentType
                    = DBR_CONTAINMENT_REFERENTIAL)
 
// 関連づけと同時にリンクのプロパティを設定する場合
DmaBoolean CdbrConfiguratedReferentialContainer::Link(
  pDmaString_T      pVersionId,
  CdbrContainable*  pDbrContainable,
  SDBR_PROPLIST*    pLinkPropList,
  ppDmaString_T     ppLinkId,
  DmaInteger32      lContainmentType
                    = DBR_CONTAINMENT_REFERENTIAL)
 
// プロパティ構造体
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;
};

詳細

CdbrConfiguratedReferentialContainerオブジェクト自身を上位のオブジェクトとして,指定したContainableオブジェクト(CdbrContainableクラスのサブクラスのオブジェクト)を下位のオブジェクトとして関連づけるメソッドです。

また,リンクにプロパティを設定することもできます。リンクのプロパティとは,DMAオブジェクトのDirectContainmentRelationshipオブジェクト,ReferentialContainmentRelationshipオブジェクトおよびVersionTraceableContainmentRelationshipオブジェクトのプロパティです。

引数

pVersionId(入力)

対象となるCdbrConfiguratedReferentialContainerオブジェクトのバージョン識別子を指定します。バージョン識別子はCdbrVersionable::GetVersionListメソッド,CdbrVersionable::GetVersionListAndLockメソッドまたはCdbrVersionable::VersionCheckOutメソッドで取得したものを指定します。チェックアウト中のオブジェクトに対しては仮のバージョン識別子を指定します。

NULLを指定した場合は,カレントバージョンが対象になります。

pDbrContainable (入力)

関連づけるオブジェクトを指定します。CdbrContainableクラスのサブクラスのオブジェクトを指定します。

pLinkPropList(入力)

リンクに設定するプロパティリストを指定します。なお,リンクに設定できるプロパティは,ユーザが定義したプロパティだけです。

プロパティを設定しない場合は,NULLを指定してください。

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

ppLinkId(出力)

リンク識別子へのポインタが設定されます。このリンク識別子は,CdbrConfiguratedReferentialContainer::GetLinkPropertyValuesメソッド,CdbrConfiguratedReferentialContainer::GetLinkPropertyValuesAndLockメソッドおよびCdbrConfiguratedReferentialContainer::PutLinkPropertyValuesメソッドでリンクのプロパティを参照,設定するときに使用します。また,CdbrConfiguratedReferentialContainer::Unlinkメソッドによってリンクの関連づけの解除をする場合にも指定できます。

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

lContainmentType(入力)

関連づけで設定するコンテインメントの種類を指定します。次のどちらかを指定してください。

なお,上位のコンテナを下位以下のコンテナの下位のオブジェクトとして関連づけることはできません。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_code minor_code 説明 対処
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_DMA DMARC_BAD_PARAMETER 不正な引数が入力されました。 正しい引数を指定してください。
ERR_DMA DMARC_LOST_CONNECTION 現在のオブジェクトからデータベースへの論理的な接続が失われました。操作は完了できません。 文書空間に再接続してください。
ERR_DMA DMARC_NO_MEMORY メモリ不足で実行できません。 メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMA DMARC_NO_RESERVATION バージョン識別子が予約されていません。 チェックイン後に割り当てられる正式なバージョン識別子を,入力引数に設定してください。
ERR_DMA DMARC_NOT_FOUND 要求された要素が見つかりません。 正しいオブジェクトを設定してください。
ERR_DMA DMARC_NOT_SUPPORTED このセッションまたはオブジェクトではサポートされていないメソッドです。 この操作は実行できません。
ERR_DMA DMARC_TIMEOUT 制限時間を超過しました。 タイムアウトしました。
ERR_DMA DMARC_UNEXPECTED 予期しないエラーが発生しました。 処理を終了してください。
ERR_DMA EDMRC_NOT_INTRANSACTION トランザクション外でメソッドが呼ばれました。 Beginメソッドの呼び出し後に,この操作を実行してください。