CdbrVersionableDocument::PutRenditionPropertyValuesメソッド
機能
レンディションのプロパティの設定
形式
DmaBoolean PutRenditionPropertyValues(
pDmaString_T pVersionId,
pDmaString_T pRenditionType,
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; //プロパティ情報
};
詳細
サブレンディションのプロパティを設定するメソッドです。
マルチレンディション文書のサブレンディションのプロパティ(RenditionType以外)を設定,変更する場合,このメソッドを使用します。
なお,RenditionTypeを変更する場合は,CdbrVersionableDocument::UpdateContentAndRenditionTypeメソッドを使用してください。
引数
pVersionId(入力)
対象となるバージョンのバージョン識別子を指定します。バージョン識別子はCdbrVersionable::GetVersionListメソッド,CdbrVersionable::GetVersionListAndLockメソッドまたはCdbrVersionable::VersionCheckOutメソッドによって取得します。NULLを指定した場合,カレントバージョンがレンディションのプロパティ設定の対象になります。
pRenditionType(入力)
プロパティを設定するレンディションのRenditionTypeを表す文字列を指定します。この引数で指定したRenditionTypeが対象バージョンのレンディションとして存在しない場合はエラーになります。NULLを指定した場合,マスタレンディションが処理対象になります。空文字列("")は指定できません。
pPropList(入力)
設定するプロパティを格納したプロパティリスト構造体である,SDBR_PROPLIST構造体を指定します。NULLを指定するとエラーになります。
なお,SDBR_PROPLIST構造体に,同じプロパティ識別子を指定したSDBR_PROP構造体を複数指定した場合はエラーになります。
指定できるプロパティ識別子を次に示します。
メソッド実行時のRenditionStatusプロパティの値 | 変換フラグの値の設定に関する制限の内容 |
---|---|
状態フラグがDBR_RENDSTATUS_NO_SUBRENDの場合 | DBR_RENDSTATUS_CONVERT_NOTREQUIREDを設定できません。 |
変換フラグがDBR_RENDSTATUS_CONVERT_ERRORの場合 | DBR_RENDSTATUS_CONVERT_REQUIREDまたはDBR_RENDSTATUS_CONVERT_NOTREQUIREDに変更できません。 |
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_INVALID_STATUS | セッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。 | 一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。 |
ERR_DBR | ERR_NONEXISTS_RENDITION | 指定されたレンディションは存在しません。 | 正しいRenditionTypeを指定してください。 |
ERR_DBR | ERR_NONEXISTS_VERSION | 指定されたバージョンは存在しません。 | 正しいバージョンを指定してください。 |
ERR_DBR | ERR_OBJECT_NOT_CONNECT | オブジェクトは接続されていません。 | オブジェクトを接続してください。 |
ERR_DBR | ERR_OBJECT_REMOVED | オブジェクトはすでに削除されています。 | 正しいオブジェクトを指定してください。 |
ERR_DBR | ERR_OIID_NOT_SET | OIIDが設定されていません。 | SetOIIDメソッドをコールしてから,このメソッドをコールしてください。 |
ERR_DBR | ERR_SESSION_NOT_CONNECT | セッションが接続されていません。 | セッションを接続してください。 |
ERR_DMA | DMARC_BAD_OIID | SetOIIDメソッドで設定されたOIIDが不正です。 | 正しいOIIDを指定してください。 |
ERR_DMA | DMARC_BAD_PARAMETER | 不正な引数が入力されました。 | 正しい引数を指定してください。 |
ERR_DMA | DMARC_BAD_PROPID | プロパティの識別子が不正です。 | 正しいプロパティ識別子を指定してください。 |
ERR_DMA | DMARC_BAD_VALUE | プロパティやリストの値が,許容範囲外の値であるかまたは最大値を超えました。 | 値の範囲を見直してください。 |
ERR_DMA | DMARC_DATATYPE_MISMATCH | プロパティのデータ型に適切ではないメソッドです。 | 正しい型を指定してください。 |
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 | 予期しないエラーが発生しました。 | 処理を終了してください。 |