CdbrVersionableDocument::UpdateContentメソッド

機能

ファイルの更新

形式

// シングルファイル文書の場合
// (マスタレンディションのファイルの更新)
DmaBoolean UpdateContent(
 const pDmaString_T    pFilePath,
 const pDmaString_T    pVersionId = NULL,
 DmaInteger32          lCreateIndexFlg = DBR_CREATE_INDEX)
 
// シングルファイル文書の場合
// (RenditionTypeを指定したファイルの更新)
DmaBoolean UpdateContent(
 const pDmaString_T    pFilePath,
 pDmaString_T          pRenditionType,
 const pDmaString_T    pVersionId,
 DmaInteger32          lCreateIndexFlg)
 
// マルチファイル文書の場合
DmaBoolean UpdateContent(
 SDBR_PATHLIST&         PathList,
 pDmaString_T           pRenditionType,
 const pDmaString_T     pVersionId)
 
// File Link文書の場合
DmaBoolean UpdateContent(
 SDBR_FILELINK_PATHINFO&   FileLinkPath,
 pDmaString_T              pRenditionType,
 const pDmaString_T        pVersionId)
 
// ファイルパス情報構造体
struct SDBR_PATHINFO {
 pDmaString_T    pFilePath;         // ファイルのURL
 pDmaString_T      pComponentType;  // ファイルを識別する文字列
};
 
// ファイルパス情報リスト構造体
struct SDBR_PATHLIST {
 DmaInteger32    lCount;            // 登録ファイル数
 SDBR_PATHINFO*    pItem;           // ファイルパス情報構造体のポインタ
};
 
// File Linkパス情報構造体
struct SDBR_FILELINK_PATHINFO {
 pDmaString_T  pFilePath;          // 登録ファイルまたはディレクトリのURL
 pDmaString_T  pFamName;           // FAM名
 pDmaString_T  pFamFilePath;       // コンテント保管先パス
 DmaInteger32  lContentDeleteMode; // コンテント削除モード
 DmaInteger32  lFileNamingMode;    // コンテント名自動
                                   // 生成モード
};

詳細

登録されているCdbrVersionableDocumentオブジェクトの指定したバージョンの内容を,指定したパスのファイルで更新するメソッドです。

このメソッドは,リファレンスファイルを管理する文書に対しては実行できません。

Windowsの場合,次のことに注意してください。

シングルファイル文書の場合(マスタレンディションのファイルの更新)
シングルファイル文書(マルチレンディション文書の場合はマスタレンディションであるシングルファイル文書)を更新する場合は,更新に使用するファイルのパス,対象バージョンおよび全文検索インデクスを作成するかどうかを指定します。
内容を更新するCdbrVersionableDocumentオブジェクト(マルチレンディション文書の場合はマスタレンディション)が次の条件に当てはまる場合に,lCreateIndexFlgにDBR_CREATE_INDEXを指定すると,全文検索インデクスを作成できます。
  • 全文検索機能付き文書クラスを基に作成されたDocVersionオブジェクトを構成要素とするCdbrVersionableDocumentオブジェクトである。
  • RenditionTypeがテキスト型(MIME::text/で始まるMIME::text/plain,MIME::text/sgmlまたはMIME::text/html)である。
更新が正常に完了すると,パス名を除いたファイル名がRetrievalNameプロパティに設定されます。例えば,UNIXの場合,"/tmp/sample.doc"で更新すると,"sample.doc"が設定されます。Windowsの場合,"c:¥temp¥sample.doc"で更新すると,"sample.doc"が設定されます。
UNIXの場合に,チェックアウトした文書に登録されたコンテントの内容をファイル"/tmp/sample.doc"で更新する例を次に示します。Windowsの場合は,ファイル"c:¥temp¥sample.doc"で更新する例として,例中の"file:///tmp/sample.doc"を"file:///c:¥temp¥sample.doc"と読み替えてください。なお,この例で更新できるのは,マスタレンディションのコンテントです。
チェックアウトした文書の内容(コンテント)を更新する例

pDmaString_T  pReservedVerId;
pDbrVerDoc->VersionCheckOut(&pReservedVerId);
pDbrVerDoc->UpdateContent("file:///tmp/sample.doc" ,
             pReservedVerId, DBR_CREATE_INDEX);
pDbrVerDoc->VersionCheckIn();
dbrDelete (pReservedVerId);

シングルファイル文書の場合(RenditionTypeを指定したファイルの更新)
マルチレンディション文書のサブレンディションであるシングルファイル文書を更新する場合は,更新に使用するファイルのパス,対象バージョンのほかに,更新対象のサブレンディションをpRenditionTypeで指定します。なお,サブレンディションの内容を更新する場合,全文検索インデクスは作成できません。
マルチファイル文書の場合
マルチファイル文書を更新する場合は,更新に使用するコンテントの情報として,SDBR_PATHLIST構造体を指定します。
マルチファイル文書の場合,次のことに注意してください。
  • CdbrVersionableDocumentクラスに格納した複数のファイルを,SDBR_PATHINFO構造体に設定したファイルパスのファイルで,一括して更新します。SDBR_PATHINFO構造体は,引数PathListで指定するSDBR_PATHINFO構造体に設定します。なお,特定のコンテントだけを更新することはできません。また,更新後は,更新前のファイルは使用できません。
  • 更新前のファイルを格納したBLOBのデータが書き換えられるため,BLOBのデータの長さは,更新後のファイルサイズの合計になります。
  • この形式のUpdateContentを,マルチファイル文書ではないバージョン付き文書に対して実行すると,ERR_NOT_MULTI_CONTENTSのエラーになります。
  • マルチファイル文書では,テキストファイルの部分が特定できないため,全文検索用インデクスは作成されません。全文検索インデクスを作成する場合,テキスト部分を抽出したファイルを,CreateIndexメソッドの引数に指定して実行してください。なお,マルチファイル文書の場合,CreateIndexメソッドの引数にNULLを指定するとERR_CONTENTTYPE_MISMATCHのエラーになります。
File Link文書の場合
File Link文書を更新する場合は,更新に使用するコンテントの情報として,SDBR_FILELINK_PATHINFO構造体を指定します。この構造体には,更新に使用するコンテントとして,ファイルまたはディレクトリを指定できます。ディレクトリを指定した場合,指定したディレクトリおよびそのサブディレクトリ下のすべてのファイルでコンテントを更新できます。また,すでにHiRDB File Linkで管理されているデータでコンテントを更新することもできます。
File Link文書の場合,次のことに注意してください。
  • このメソッドは,レンディションのコンテント種別がContentFileLinkオブジェクトの場合(dbrProp_ContentTypeプロパティの値がDBR_CONTENTTYPE_FILELINKの場合)にだけ有効です。そのほかのコンテント種別を持つレンディションに対して実行すると,ERR_CONTENTTYPE_MISMATCHのエラーになります。
  • このメソッドで,ERR_FILELINK_FAILEDのエラーが発生した場合は,詳細メッセージにHiRDB File Linkが出力するエラー情報が出力されます。HiRDB File Linkが出力するエラーを参照して,対処してください。
  • File Link文書では,全文検索用インデクスは作成されません。全文検索インデクスを作成する場合,テキスト部分を抽出したファイルを,CreateIndexメソッドの引数に指定して実行してください。なお,File Link文書の場合,CreateIndexメソッドの引数にNULLを指定するとERR_CONTENTTYPE_MISMATCHのエラーになります。

引数

PathList(入力)

登録するファイルのファイルパス情報が設定されたSDBR_PATHLIST構造体を指定します。SDBR_PATHLIST構造体については,「付録C.1(11) SDBR_PATHLIST構造体(ファイルパス情報リスト構造体)」を参照してください。

pFilePath(入力)

登録するファイルのパス名を指定します。ファイルのパス名はURL形式で設定します。例えば,UNIXの場合,ファイル"/tmp/sample.doc"を登録するには,"file:///tmp/sample.doc"と指定します。Windowsの場合,ファイル"c:¥temp¥sample.doc"を登録するには,"file:///c:¥temp¥sample.doc"と指定します。有効なプロトコルは"file:"だけです。これ以外のプロトコルを指定した場合はエラーになります。

なお,ここで指定するパスは,GetContentメソッドで取得したファイルである必要はありません。ただし,RenditionTypeが異なるファイルは指定できません。

pRenditionType(入力)

RenditionTypeを指定してレンディションの内容を更新する場合,内容を更新するレンディションのRenditionTypeを表す文字列を指定します。

この引数で指定したRenditionTypeが,対象バージョンのサブレンディションとして存在しない場合はエラーになります。

マスタレンディションの内容を更新する場合はNULLを指定するか,「マスタレンディションのファイルを更新する場合」の形式を使用することもできます。なお,空文字列("")は指定できません。

マルチファイル文書の場合,NULLまたは「シングルファイル文書の場合(マスタレンディションのファイルの更新)」の形式を指定してください。

pVersionId(入力)

対象となるバージョンのバージョン識別子を指定します。この識別子は,CdbrVersionable::GetVersionListメソッド,CdbrVersionable::GetVersionListAndLockメソッドまたはCdbrVersionable::VersionCheckOutメソッドで取得します。省略した場合またはNULLを指定した場合は,カレントバージョンが更新対象になります。

lCreateIndexFlg(入力)

全文検索インデクスを作成するかどうかを指定します。

次のどちらかを指定してください。この値を省略した場合は,DBR_CREATE_INDEXが指定されたものとして処理されます。

なお,全文検索機能付きクラス以外から作成されたDocVersionオブジェクトを指定した場合およびファイルのRenditionTypeがテキスト型でない場合は,lCreateIndexFlgの値は無視されます。

また,マルチレンディション文書の場合,lCreateIndexFlgはマスタレンディションの内容を更新する場合だけ有効です。

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_codeminor_code説明対処
ERR_CORBACORBAの戻り値が設定されます。CORBAでエラーが発生しました。ユーザプログラムでは対処できません。エラー情報として文字列の値を取得して,ユーザプログラムを終了してください。
ERR_DBERR_DB_DEADLOCK_OCCURREDデータベースでデッドロックが発生しました。時間を置いて,再度実行してください。
ERR_DBERR_DB_FAILEDデータベースで障害が発生しました。
または,マルチファイル文書で指定したファイルのサイズの合計が,BLOBの定義長を超えました。
syslogを参照して,障害の原因を取り除いてください。
ERR_DBERR_DB_LOCKEDオブジェクトがロックされています。時間を置いて,再度実行してください。
ERR_DBRERR_ACCESS_NOT_PERMITTEDアクセス権がありません。この操作は実行できません。
ERR_DBRERR_ACLIB_OBJECT_INVALIDクラスライブラリのオブジェクトは無効です。有効なクラスライブラリのオブジェクトを指定してください。
ERR_DBRERR_BAD_CONTENTSCOUNT登録しようとするファイルの数が多過ぎます。登録するファイルの数を見直してください。
ERR_DBRERR_CONTENTTYPE_MISMATCH指定したレンディションタイプのコンテントに対して実行できません。正しい文書オブジェクトを指定してメソッドを実行してください。
ERR_DBRERR_FAL_NOT_LOADEDHiRDB File Linkのライブラリがロードできません。詳細メッセージを基に対処してください。
ERR_DBRERR_FILELINK_FAILEDHiRDB File Linkでエラーが発生しました。詳細メッセージを基に対処してください。
ERR_DBRERR_INVALID_STATUSセッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。
ERR_DBRERR_NONEXISTS_RENDITION指定されたRenditionTypeは存在しません。RenditionTypeを見直してください。
ERR_DBRERR_NONEXISTS_VERSION指定されたバージョンは存在しません。正しいバージョンを指定してください。
ERR_DBRERR_NOT_MULTI_CONTENTSマルチファイル文書ではありません。マルチファイル管理機能を使用しない場合の形式で実行してください。
ERR_DBRERR_OBJECT_NOT_CONNECTオブジェクトは接続されていません。オブジェクトを接続してください。
ERR_DBRERR_RETRIEVALNAME_DUPLICATEDRetrievalNameが重複して指定されています。RetrievalNameが重複しないように指定してください。
ERR_DBRERR_OIID_NOT_SETOIIDが設定されていません。SetOIIDメソッドをコールしてから,このメソッドをコールしてください。
ERR_DBRERR_SESSION_NOT_CONNECTセッションが接続されていません。セッションを接続してください。
ERR_DMADMARC_ACCESS_DENIED要求された操作に対してアクセス権がありません。正しいアクセス権を設定してください。
ERR_DMADMARC_BAD_CLASSID指定された識別子は,利用できるオブジェクトのクラスではありません。正しいクラス識別子を指定してください。
ERR_DMADMARC_BAD_OIIDSetOIIDメソッドで設定されたOIIDが不正です。正しいOIIDを指定してください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。
ERR_DMADMARC_BAD_URLリソースのURLが不正です。URLの内容を見直してください。
ERR_DMADMARC_NO_MEMORYメモリ不足で実行できません。メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMADMARC_NO_RESERVATIONバージョン識別子が予約されていません。チェックイン後に割り当てられる正式なバージョン識別子を,入力引数に設定してください。
ERR_DMADMARC_NOT_FOUND要求された要素が見つかりません。正しいオブジェクトを設定してください。
ERR_DMADMARC_NOT_SUPPORTEDこのセッションまたはオブジェクトではサポートされていないメソッドです。この操作は実行できません。
ERR_DMADMARC_RESOURCE_NOT_FOUND指示されたリソースが見つかりません。正しいリソースを指定してください。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。
ERR_DMADMARC_URL_PROTOCOL_NOT_SUPPORTEDサポートしていないURLプロトコルです。file:///で始まっているか確認してください。
ERR_DMAEDMRC_FTPSERVICE_LOST_CONNECTIONファイル転送サービスへのセッションが切断されました。ネットワーク環境を確認してください。または,時間を置いて,再度実行してください。
ERR_DMAEDMRC_FTPSERVICE_MAX_SESSIONファイル転送サービスに同時に接続できるセッション数の上限に達しています。時間を置いて,Connectユーザ数が減ったあと,再度実行してください。または,ファイル転送サービス環境定義ファイルのFtpSessionMaxエントリを見直してください。
ERR_DMAEDMRC_FTPSERVICE_NOT_AVAILABLEファイル転送サービスが利用できません。サーバのバージョンに対応したクライアントを利用してください。
ERR_DMAEDMRC_NO_FTPSERVICE使用できるファイル転送サービスがありません。
  • ネットワーク環境を確認してください。
  • _HIEDMS_FTPMODE=STATICを指定してファイル転送サービスを起動しているかどうかを,確認してください。
  • 時間を置いて,再度実行してください。
  • ファイル転送サービスのセットアップコマンドを実行しているかどうかを,確認してください。