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

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

CdbrConfiguratedReferentialContainer::GetLinkPropertyValuesメソッド

機能

リンクのプロパティの取得

形式

DmaBoolean CdbrConfiguratedReferentialContainer::GetLinkPropertyValues(
  pDmaString_T       pLinkId,
  DmaInteger32       lLinkPropDefListCount,
  SDBR_PROPDEF*      pLinkPropDefList,
  SDBR_PROPLIST**    ppLinkPropList)
 
// プロパティ定義情報構造体
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;
};

詳細

リンク識別子を指定して,リンクのプロパティを取得するメソッドです。

引数

pLinkId(入力)

リンク識別子を指定します。

lLinkPropDefListCount(入力)

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

pLinkPropDefList(入力)

取得するプロパティの定義情報である,SDBR_PROPDEF構造体の配列を指定します。指定できるリンクのプロパティ識別子はユーザが定義したプロパティの識別子だけです。なお,lLinkPropDefListCountが正の整数のときにpLinkPropDefListにNULLを指定すると,エラーになります。

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

ppLinkPropList(出力)

取得したプロパティリスト構造体である,SDBR_PROPLIST構造体へのポインタが設定されます。

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

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

なお,プロパティがまったく取得されなかった場合は,NULLが設定されます。

戻り値

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_BAD_PROPID プロパティの識別子が不正です。 正しいプロパティ識別子を指定してください。
ERR_DMA DMARC_BAD_VALUE プロパティやリストの値が,許容範囲外の値であるかまたは最大値を超えました。 値の範囲を見直してください。
ERR_DMA DMARC_LOST_CONNECTION 現在のオブジェクトからデータベースへの論理的な接続が失われました。操作は完了できません。 文書空間に再接続してください。
ERR_DMA DMARC_NO_MEMORY メモリ不足で実行できません。 メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMA DMARC_NOT_FOUND 要求された要素が見つかりません。 正しいオブジェクトを設定してください。
ERR_DMA DMARC_NOT_SUPPORTED このセッションまたはオブジェクトではサポートされていないメソッドです。 この操作は実行できません。
ERR_DMA DMARC_READ_ONLY 読み取り専用のオブジェクトまたはプロパティのため,異常終了しました。 このプロパティの値は更新できません。
ERR_DMA DMARC_TIMEOUT 制限時間を超過しました。 タイムアウトしました。
ERR_DMA DMARC_UNEXPECTED 予期しないエラーが発生しました。 処理を終了してください。
ERR_DMA EDMRC_NOT_INTRANSACTION トランザクション外でメソッドが呼ばれました。 Beginメソッドの呼び出し後に,この操作を実行してください。