CdbrDMA::PutPropertyValuesメソッド

機能

プロパティの設定

形式

DmaBoolean PutPropertyValues(
 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;
};

詳細

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

次に,Number(Integer32型)プロパティに値を設定する例を示します。プロパティ識別子は,PROP_ID_OF_NUMBERとします。

プロパティに値を設定する例

SDBR_PROP      Props;
SDBR_PROPLIST  PropList;
DmaInteger32   lNum = 25;
 
// 設定したいプロパティの識別子と値を用意します。
Props.PropId = PROPERTY_ID_OF_NUMBER;
Props.lType = DMA_DATATYPE_INTEGER32;
Props.lCardinality = DMA_CARDINALITY_SINGLE;
Props.uniValue.plInteger32 = &lNum;
Props.lCount = 1;
PropList.lCount = 1;
PropList.pItem = &Props;
 
// プロパティに値を設定します。
pDbrDMA->PutPropertyValues(&PropList);

引数

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 システム導入・運用ガイド」を参照してください。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_codeminor_code説明対処
ERR_CORBACORBAの戻り値が設定されます。CORBAでエラーが発生しました。ユーザプログラムでは対処できません。エラー情報として文字列の値を取得して,ユーザプログラムを終了してください。
ERR_DBERR_DB_DEADLOCK_OCCURREDデータベースでデッドロックが発生しました。時間を置いて,再度実行してください。
ERR_DBERR_DB_FAILEDデータベースで障害が発生しました。syslogを参照して,障害の原因を取り除いてください。
ERR_DBERR_DB_LOCKEDオブジェクトがロックされています。時間を置いて,再度実行してください。
ERR_DBRERR_ACCESS_NOT_PERMITTEDアクセス権がありません。この操作は実行できません。
ERR_DBRERR_BAD_PERMISSION不正なパーミッションが指定されました。正しいパーミッションを指定してください。
ERR_DBRERR_BAD_SUBJECT_TYPE不正なサブジェクト種別が指定されました。正しいサブジェクト種別を指定してください。
ERR_DBRERR_INVALID_ACE不正なアクセス制御エレメント(ACE)が指定されました。ACEとして正しいCdbrCompoundオブジェクトを指定してください。
ERR_DBRERR_INVALID_ACE_COUNT設定するアクセス制御エレメント(ACE)の個数が制限値を超えています。ACEは64個以内で指定してください。
ERR_DBRERR_INVALID_PUBLICACL_COUNTバインドするパブリックACLの個数が制限値を超えています。パブリックACLは10個以内で指定してください。
ERR_DBRERR_INVALID_STATUSセッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。
ERR_DBRERR_INVALID_SUBJECT_LENGTHサブジェクトの長さが不正です。次に示す範囲内でサブジェクトを指定してください。
  • サブジェクトの種別がユーザ識別子の場合,1文字以上,ユーザ識別子の最大長以下の文字列を指定してください。
    ユーザ識別子の最大長は,通常254文字ですが,DocumentBrokerの環境設定時に512文字まで拡張できます。
  • サブジェクトの種別がグループ識別子の場合,1文字以上,グループ識別子の最大長以下の文字列を指定してください。
    グループ識別子の最大長は,通常254文字ですが,DocumentBrokerの環境設定時に512文字まで拡張できます。
  • サブジェクトの種別がシステムサブジェクトの場合,1文字以上,254文字以下の文字列を指定してください。
ユーザ識別子とグループ識別子の最大長を拡張する方法の詳細は,マニュアル「DocumentBroker Version 3 システム導入・運用ガイド」を参照してください。
ERR_DBRERR_NONEXISTS_PUBLICACL指定されたパブリックACLは存在しません。存在しないパブリックACLを指定しないで処理を再実行してください。
ERR_DMADMARC_BAD_CLASSID指定された識別子は,利用できるオブジェクトのクラスではありません。正しいクラス識別子を指定してください。
ERR_DMADMARC_BAD_OIIDSetOIIDメソッドで設定されたOIIDが不正です。正しいOIIDを指定してください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。
ERR_DMADMARC_BAD_PROPIDプロパティの識別子が不正です。正しいプロパティ識別子を指定してください。
ERR_DMADMARC_BAD_VALUE次のどれかの要因が考えられます。
  1. プロパティやリストの値が,許容範囲外の値であるか,または最大値を超えました。
  2. VariableArray型プロパティに設定する可変長配列の要素数が最大値を超えました。
  3. docspace.iniの[Entry0001]セクションに「VArrayElementCheck=Yes」の定義がある場合に,VariableArray型プロパティの要素の値が,許容範囲外の値であるか,または最大値を超えました。
次のどれかの方法で対処してください。
  1. プロパティやリストの値の範囲を見直してください。
  2. VariableArray型プロパティに設定する可変長配列の要素数を見直してください。
  3. VariableArray型プロパティの要素の値の範囲を見直してください。
ERR_DMADMARC_DATATYPE_MISMATCHプロパティのデータ型に適切ではないメソッドです。正しい型を指定してください。
ERR_DMADMARC_NO_MEMORYメモリ不足で実行できません。メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMADMARC_NOT_FOUND要求された要素が見つかりません。正しいオブジェクトを設定してください。
ERR_DMADMARC_NOT_SUPPORTEDこのセッションまたはオブジェクトではサポートされていないメソッドです。この操作は実行できません。
ERR_DMADMARC_READ_ONLY読み取り専用のオブジェクトまたはプロパティのため,異常終了しました。このプロパティの値は更新できません。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。