CdbrVersionableDocument::AddRenditionメソッド
機能
レンディションの追加
形式
// シングルファイル文書であるコンテントを
// レンディションの追加と同時に登録する場合
DmaBoolean AddRendition(
pDmaString_T pVersionId,
pDmaString_T pFilePath,
pDmaString_T pRenditionType,
SDBR_PROPLIST* pPropList )
// シングルファイル文書であるコンテントを
// レンディション変換機能を使って登録する場合
DmaBoolean AddRendition(
pDmaString_T pVersionId,
pDmaString_T pFilePath,
pDmaString_T pRenditionType,
SDBR_PROPLIST* pPropList,
DmaInteger32 lConvertType)
// リファレンスファイル文書であるコンテントをレンディションの追加と同時に登録する場合
DmaBoolean AddRendition(
pDmaString_T pVersionId,
SDBR_REFERENCE_PATHINFO& ReferencePath,
pDmaString_T pRenditionType,
SDBR_PROPLIST* pPropList)
// File Link文書であるコンテントをレンディションの追加と同時に登録する場合
DmaBoolean AddRendition(
pDmaString_T pVersionId,
SDBR_FILELINK_PATHINFO& FileLinkPath,
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;
};
// リファレンスパス情報構造体
struct SDBR_REFERENCE_PATHINFO {
DmaInteger32 lContentOperateMode; // 操作モード
pDmaString_T pEntry; // ファイルのパスおよびロケーション
pDmaString_T pTargetPath; // コンテント格納先パス
pDmaString_T pDeleteRootPath; // 削除ディレクトリのルートパス
};
// File Linkパス情報構造体
struct SDBR_FILELINK_PATHINFO {
pDmaString_T pFilePath; // 登録ファイルまたはディレクトリのURL
pDmaString_T pFamName; // FAM名
pDmaString_T pFamFilePath; // コンテント保管先パス
DmaInteger32 lContentDeleteMode; // コンテント削除モード
DmaInteger32 lFileNamingMode; // コンテント名自動生成モード
};
詳細
バージョン付き文書の指定されたバージョンに,指定されたレンディションとコンテントを追加するメソッドです。レンディション変換機能を使ってコンテントを登録する場合,コンテントが空のレンディションを追加できます。ただし,レンディション変換機能を使うには,DocumentBroker Rendering Optionが必要です。
このメソッドを使うことで,レンディションを複数持つ,マルチレンディション文書にすることができます。
なお,レンディションを複数持つマルチレンディション文書の場合,すべてのレンディションに空でないRenditionTypeが設定されている必要があります。つまり,RenditionTypeがNULLまたは空文字列("")のレンディションは存在できません。したがって,マスタレンディションのRenditionTypeが設定されていない(NULLまたは空文字列("")の場合)か,このメソッドの引数pRenditionTypeがNULLまたは空文字列("")の場合,このメソッドはエラーになります。
このメソッドは,マルチファイルを管理するバージョン付き文書に対しては実行できません。
引数
pVersionId(入力)
対象となるバージョンのバージョン識別子を指定します。バージョン識別子はCdbrVersionable::GetVersionListメソッド,CdbrVersionable::GetVersionListAndLockメソッドまたはCdbrVersionable::VersionCheckOutメソッドによって取得します。NULLを指定した場合,カレントバージョンがレンディション追加の対象になります。
pFilePath(入力)
追加するサブレンディションに登録するファイルのパス名をURL形式で指定します。
例えば,レンディションの追加と同時にコンテントを登録する場合で,UNIXの場合にファイル"/tmp/sample.doc"を登録するには,"file:///tmp/sample.doc"と指定します。Windowsの場合にファイル"c:¥temp¥sample.doc"を登録するには,"file:///c:¥temp¥sample.doc"と指定します。有効なプロトコルは"file:"だけです。"file:"以外のプロトコルを指定した場合,指定を省略した場合またはNULLを指定した場合,エラーになります。
なお,レンディション変換機能を使ってコンテントを登録する場合(lConvertTypeにDBR_CONVERT_TYPE_BATCHを指定した場合)だけ,pFilePathにNULLを指定できます。
pRenditionType(入力)
追加するサブレンディションのRenditionTypeを表す文字列を指定します。例えばHTML文書の場合は,"MIME::text/html"などとします。NULLまたは空文字列("")は指定できません。
レンディションを追加しようとする文書に,この引数で指定するRenditionTypeと同じレンディションがすでにある場合,エラーになります。
pPropList(入力)
追加するレンディションに設定するプロパティを格納したプロパティリスト構造体である,SDBR_PROPLIST構造体を指定します。プロパティを設定しない場合はNULLを指定してください。
なお,SDBR_PROPLIST構造体に,同じプロパティ識別子を指定したSDBR_PROP構造体を複数指定した場合はエラーになります。
SDBR_PROPLIST構造体およびSDBR_PROP構造体については,「付録C.1(14) SDBR_PROPLIST構造体(プロパティリスト構造体)」および「付録C.1(12) SDBR_PROP構造体(プロパティ構造体)」を参照してください。
このメソッドで値を設定できるプロパティのプロパティ識別子を次に示します。
lConvertType(入力)
レンディション変換の方法を指定します。次に示す値のどちらかを指定してください。
ReferencePath(入力)
リファレンスファイル文書を登録するために必要な情報を格納した,SDBR_REFERENCE_PATHINFO構造体を指定します。SDBR_REFERENCE_PATHINFO構造体のメンバlContentOperateModeにDBR_OPERATEMODE_USER_RELATIVE_CONTENTを指定し,pEntryに追加するサブレンディションに登録するファイルのパス名をURL形式で指定します。
また,SDBR_REFERENCE_PATHINFO構造体のメンバpTargetPathに,コンテント格納先パスを,CdbrSession::SetReferencePathメソッドで設定したコンテント格納先ベースパスを基点とする相対パスで指定します。DocumentBrokerサーバがWindowsの場合UNC形式のパスで指定することもできます。
なお,lContentOperateModeにDBR_OPERATEMODE_NONEを指定した場合,コンテントを持たないオブジェクトが作成されます。
このメソッドを実行する場合,次に示すことに注意してください。
また,pTargetPathで指定するコンテント格納先パスの中に,カレントディレクトリの一つ上位のディレクトリを示す".."は指定できません。指定した場合,DMARC_BAD_PARAMETERのエラーになります。
リファレンスファイル文書を登録する場合,SDBR_REFERENCE_PATHINFO構造体のメンバpDeleteRootPathへの値の指定は,無効になります。
SDBR_REFERENCE_PATHINFO構造体に設定する内容については,「付録C.1(15) SDBR_REFERENCE_PATHINFO構造体(リファレンスパス情報構造体)」を参照してください。
FileLinkPath(入力)
File Link文書を登録するために必要な情報を格納した,SDBR_FILELINK_PATHINFO構造体を指定します。
なお,SDBR_FILELINK_PATHINFO構造体のメンバpFilePathとメンバpFamFilePathの両方にNULLを設定した場合には,DMARC_BAD_PARAMETERのエラーになります。
SDBR_FILELINK_PATHINFO構造体に設定する内容については,「付録C.1(5) SDBR_FILELINK_PATHINFO構造体(File Linkパス情報構造体)」を参照してください。
戻り値
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_CONTENTTYPE_MISMATCH | 指定したレンディションタイプのコンテントに対して実行できません。 | 正しい文書オブジェクトを指定してメソッドを実行してください。 |
ERR_DBR | ERR_FAL_NOT_LOADED | HiRDB File Linkのライブラリがロードできません。 | 詳細メッセージを基に対処してください。 |
ERR_DBR | ERR_FILELINK_FAILED | HiRDB File Linkでエラーが発生しました。 | 詳細メッセージを基に対処してください。 |
ERR_DBR | ERR_INVALID_STATUS | セッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。 | 一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。 |
ERR_DBR | ERR_LIMITNUM_OF_RENDITIONS | 保持できるレンディション数の上限に達しています。 | この操作は実行できません。 |
ERR_DBR | ERR_MASTERRENDTYPE_NOT_SET | マスタレンディションのRenditionTypeに値が設定されていません。 | この操作は実行できません。 |
ERR_DBR | ERR_NONEXISTS_VERSION | 指定されたバージョンは存在しません。 | 正しいバージョンを指定してください。 |
ERR_DBR | ERR_OBJECT_ALREADY_CONNECTED | オブジェクトはすでに接続されています。 | この操作は実行できません。 |
ERR_DBR | ERR_OBJECT_REMOVED | オブジェクトはすでに削除されています。 | 正しいオブジェクトを指定してください。 |
ERR_DBR | ERR_OIID_NOT_SET | OIIDが設定されていません。 | SetOIIDメソッドをコールしてから,このメソッドをコールしてください。 |
ERR_DBR | ERR_RENDITIONTYPE_DUPLICATED | RenditionTypeが重複しています。 | 重複しないRenditionTypeを指定してください。 |
ERR_DBR | ERR_SESSION_NOT_CONNECT | セッションが接続されていません。 | セッションを接続してください。 |
ERR_DBR | ERR_FILE_REFERENCE_OPERATION_FAILED | リファレンスファイル管理機能で扱うサーバマシンでのコンテントの操作でエラーが発生しました。 | 詳細メッセージを基に対処してください。 |
ERR_DBR | ERR_TARGETCONTENTPATH_NOT_SET | リファレンスファイル管理機能でコンテント格納先ベースパスが設定されていません。または,UNC形式のパスの場合(Windowsだけ),コンテント格納先ベースパスにコンピュータ名またはIPアドレスだけが使用されています。 | コンテント格納先ベースパスを設定してください。 |
ERR_DMA | DMARC_ACCESS_DENIED | 要求された操作に対してアクセス権がありません。 | 正しいアクセス権を設定してください。 |
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_URL | リソースのURLが不正です。 | URLの内容を見直してください。 |
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_RESOURCE_NOT_FOUND | 指示されたリソースが見つかりません。 | 正しいリソースを指定してください。 |
ERR_DMA | DMARC_UNEXPECTED | 予期しないエラーが発生しました。 | 処理を終了してください。 |
ERR_DMA | DMARC_URL_PROTOCOL_NOT_SUPPORTED | サポートしていないURLプロトコルです。 | file:///で始まっているか確認してください。 |
ERR_DMA | EDMRC_FTPSERVICE_LOST_CONNECTION | ファイル転送サービスへのセッションが切断されました。 | ネットワーク環境を確認してください。または,時間を置いて,再度実行してください。 |
ERR_DMA | EDMRC_FTPSERVICE_MAX_SESSION | ファイル転送サービスに同時に接続できるセッション数の上限に達しています。 | 時間を置いて,Connectユーザ数が減ったあと,再度実行してください。または,ファイル転送サービス環境定義ファイルのFtpSessionMaxエントリを見直してください。 |
ERR_DMA | EDMRC_FTPSERVICE_NOT_AVAILABLE | ファイル転送サービスが利用できません。 | サーバのバージョンに対応したクライアントを利用してください。 |
ERR_DMA | EDMRC_NO_FTPSERVICE | 使用できるファイル転送サービスがありません。 |
|