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

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

CdbrVersionable::PutPropertyValuesメソッド

機能

プロパティの設定(バージョン指定あり)

形式

// 全バージョン共有のプロパティを対象にする場合
DmaBoolean PutPropertyValues(
SDBR_PROPLIST*        pPropList )
 
// バージョンをバージョン識別子で指定する場合
DmaBoolean PutPropertyValues(
pDmaString_T          pVersionId,
SDBR_PROPLIST*        pPropList )
 
// プロパティ構造体
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;
};

詳細

プロパティに値を設定するメソッドです。

バージョン識別子を指定しない場合,DMAオブジェクトのConfigurationHistoryオブジェクトに設定された,オブジェクト全体に対するプロパティが対象になります。

CdbrVersionable::VersionCheckOutメソッドで取得した仮のバージョン識別子を指定した場合は,チェックアウトしたバージョンのdmaClass_Versionableクラスのサブクラスのオブジェクトのプロパティが対象になります。

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

引数

pPropList(入力)

設定するプロパティを格納したプロパティリスト構造体である,SDBR_PROPLIST構造体を指定します。SDBR_PROPLIST構造体およびSDBR_PROP構造体に指定する内容については,「付録C.1(14) SDBR_PROPLIST構造体(プロパティリスト構造体)」および「付録C.1(12) SDBR_PROP構造体(プロパティ構造体)」を参照してください。

同じプロパティ識別子を指定したプロパティ構造体を複数指定した場合は,エラーになります。

また,VariableArray型プロパティを設定するとき,次の場合はエラーになります。このとき,major_codeとしてERR_DMA,minor_codeとしてDMARC_BAD_VALUEが返却されます。

それぞれのデータ型に対応する値の範囲については,マニュアル「DocumentBroker Version 3 システム導入・運用ガイド」を参照してください。

pVersionId(入力)

対象となるバージョンのバージョン識別子を指定します。

バージョン識別子はCdbrVersionable::VersionCheckOutメソッドで取得した仮のバージョン識別子も指定できます。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_BAD_PERMISSION 不正なパーミッションが指定されました。 正しいパーミッションを指定してください。
ERR_DBR ERR_BAD_SUBJECT_TYPE 不正なサブジェクト種別が指定されました。 正しいサブジェクト種別を指定してください。
ERR_DBR ERR_INVALID_ACE 不正なアクセス制御エレメント(ACE)が指定されました。 ACEとして正しいCdbrCompoundオブジェクトを指定してください。
ERR_DBR ERR_INVALID_ACE_COUNT 設定するアクセス制御エレメント(ACE)の個数が制限値を超えています。 ACEは64個以内で指定してください。
ERR_DBR ERR_INVALID_PUBLICACL_COUNT バインドするパブリックACLの個数が制限値を超えています。 パブリックACLは10個以内で指定してください。
ERR_DBR ERR_INVALID_STATUS セッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。 一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。
ERR_DBR ERR_INVALID_SUBJECT_LENGTH サブジェクトの長さが不正です。 次に示す範囲内でサブジェクトを指定してください。
  • サブジェクトの種別がユーザ識別子の場合,1文字以上,ユーザ識別子の最大長以下の文字列を指定してください。
    ユーザ識別子の最大長は,通常254文字ですが,DocumentBrokerの環境設定時に512文字まで拡張できます。
  • サブジェクトの種別がグループ識別子の場合,1文字以上,グループ識別子の最大長以下の文字列を指定してください。
    グループ識別子の最大長は,通常254文字ですが,DocumentBrokerの環境設定時に512文字まで拡張できます。
  • サブジェクトの種別がシステムサブジェクトの場合,1文字以上,254文字以下の文字列を指定してください。
ユーザ識別子とグループ識別子の最大長を拡張する方法の詳細は,マニュアル「DocumentBroker Version 3 システム導入・運用ガイド」を参照してください。
ERR_DBR ERR_NONEXISTS_PUBLICACL 指定されたパブリックACLは存在しません。 存在しないパブリックACLを指定しないで処理を再実行してください。
ERR_DBR ERR_OBJECT_ALREADY_CONNECTED オブジェクトはすでに接続されています。 この操作は実行できません。
ERR_DBR ERR_OBJECT_REMOVED オブジェクトはすでに削除されています。 正しいオブジェクトを指定してください。
ERR_DBR ERR_OIID_NOT_SET OIIDが設定されていません。 SetOIIDメソッドをコールしてから,このメソッドをコールしてください。
ERR_DBR ERR_SESSION_NOT_CONNECT セッションが接続されていません。 セッションを接続してください。
ERR_DMA DMARC_BAD_CLASSID 指定された識別子は,利用できるオブジェクトのクラスではありません。 正しいクラス識別子を指定してください。
ERR_DMA DMARC_BAD_OIID SetOIIDメソッドで設定されたOIIDが不正です。 正しいOIIDを指定してください。
ERR_DMA DMARC_BAD_PARAMETER 不正な引数が入力されました。 正しい引数を指定してください。
ERR_DMA DMARC_BAD_PROPID プロパティの識別子が不正です。 正しいプロパティ識別子を指定してください。
ERR_DMA DMARC_BAD_VALUE 次のどれかの要因が考えられます。
  1. プロパティやリストの値が,許容範囲外の値であるか,または最大値を超えました。
  2. VariableArray型プロパティに設定する可変長配列の要素数が最大値を超えました。
  3. docspace.iniの[Entry0001]セクションに「VArrayElementCheck=Yes」の定義がある場合に,VariableArray型プロパティの要素の値が,許容範囲外の値であるか,または最大値を超えました。
次のどれかの方法で対処してください。
  1. プロパティやリストの値の範囲を見直してください。
  2. VariableArray型プロパティに設定する可変長配列の要素数を見直してください。
  3. VariableArray型プロパティの要素の値の範囲を見直してください。
ERR_DMA DMARC_NO_MEMORY メモリ不足で実行できません。 メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMA DMARC_NO_RESERVATION バージョン識別子が予約されていません。 チェックイン後に割り当てられる正式なバージョン識別子を,入力引数に設定してください。
ERR_DMA DMARC_NOT_FOUND 要求された要素が見つかりません。 正しいオブジェクトを設定してください。
ERR_DMA DMARC_NOT_SUPPORTED このセッションまたはオブジェクトではサポートされていないメソッドです。 この操作は実行できません。
ERR_DMA DMARC_READ_ONLY 読み取り専用のオブジェクトまたはプロパティのため,異常終了しました。 このプロパティの値は更新できません。
ERR_DMA DMARC_UNEXPECTED 予期しないエラーが発生しました。 処理を終了してください。