CdbrDMA::RemoveObjectメソッド

機能

オブジェクトの削除

形式

virtual DmaBoolean RemoveObject()
 
// リファレンスファイル文書の場合
DmaBoolean RemoveObject(
 SDBR_REFERENCE_PATHINFO&    ReferencePath)
 
// リファレンスパス情報構造体
struct SDBR_REFERENCE_PATHINFO{
 DmaInteger32  lContentOperateMode;    // 操作モード
 pDmaString_T  pEntry;                 // ファイルのパスおよびロケーション
 pDmaString_T  pTargetPath;            // コンテント格納先パス
 pDmaString_T  pDeleteRootPath;        // 削除ディレクトリのルートパス
};

詳細

オブジェクトを削除するメソッドです。対応するDMAオブジェクトを削除します。対応するDMAオブジェクトに関連づけ(リンク)が設定されていた場合,その関連づけ(リンク)も同時に削除します。

リファレンスファイル文書の場合
リファレンスファイル管理機能を使用した文書オブジェクトを削除する場合,コンテントの登録先のディレクトリも同時に削除します。
コンテントの登録先ディレクトリの削除は,削除ディレクトリのルートパスで指定されたディレクトリの下位のディレクトリまでの間のディレクトリが削除の対象となります。最下位層のディレクトリから順にディレクトリを削除します。削除するディレクトリやファイルにアクセス権がない場合や削除するディレクトリにファイルやフォルダが存在する場合,その時点までのディレクトリは削除され,処理は終了します。
この指定が,コンテントロケーションのパスと一致していない場合,ERR_FILE_REFERENCE_OPERATION_FAILEDのエラーになります。また,文書オブジェクト以外のオブジェクトに対して実行すると,DMARC_NOT_SUPPORTEDのエラーになります。
なお,UpdateContentAndRenditionTypeまたはこのメソッドでERR_FILE_REFERENCE_MISMATCH_STATUSエラーになった場合,このメソッドを再実行することで,オブジェクトは正常に削除されます。

引数

ReferencePath(入力)

リファレンスファイル文書を削除するために必要な情報を格納した,SDBR_REFERENCE_PATHINFO構造体を指定します。

コンテントの削除と同時にコンテントを格納したディレクトリを削除するときは,SDBR_REFERENCE_PATHINFO構造体のメンバpDeleteRootPathに,削除するディレクトリのルートパスを指定します。この指定したルートパスより下のディレクトリを削除します。この指定は,DocumentBrokerサーバがWindowsの場合UNC形式のパスで指定することもできます。ただし,通常のパス形式またはDocumentBrokerサーバがWindowsの場合UNC形式でのパス表記は,コンテント格納先の表記と同じである必要があります。

なお,pDeleteRootPathにNULLを指定した場合,DocumentBrokerがコンテントを管理するためのディレクトリと登録されているコンテントを削除します。また,メンバpDeleteRootPathで指定するパスの中に,カレントディレクトリの一つ上位のディレクトリを示す".."は指定できません。指定した場合,DMARC_BAD_PARAMETERのエラーになります。

リファレンスファイル文書を削除する場合,SDBR_REFERENCE_PATHINFO構造体のメンバpEntryおよびpTargetPathへの値の指定は,無効になります。

SDBR_REFERENCE_PATHINFO構造体に設定する内容については,「付録C.1(15) SDBR_REFERENCE_PATHINFO構造体(リファレンスパス情報構造体)」を参照してください。

戻り値

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_FILE_REFERENCE_CURRENT_CONTENT_NOTFOUNDリファレンスファイル管理機能でカレントバージョンのコンテントが存在しません。該当するレンディションを削除し,必要に応じて,削除したレンディションを追加してください。または,バージョンを最新(カレントバージョンを削除した場合は一つ前のバージョン)から順に確認し,コンテントが存在しないバージョンを削除してください。
ERR_DBRERR_FILE_REFERENCE_MISMATCH_STATUSリファレンスファイル管理機能で扱うサーバマシンでのコンテントの操作でエラーが発生し,オブジェクトとコンテントが不整合な状態となりました。再度実行して文書を削除してください。
ERR_DBRERR_FILE_REFERENCE_OPERATION_FAILEDリファレンスファイル管理機能で扱うサーバマシンでのコンテントの操作でエラーが発生しました。詳細メッセージを基に対処してください。
ERR_DBRERR_INVALID_STATUSセッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。
ERR_DBRERR_LAST_VERSION削除対象となるオブジェクトは,バージョン付き文書の唯一のバージョンであるため,削除できません。この操作は実行できません。
ERR_DBRERR_OBJECT_REMOVEDオブジェクトはすでに削除されています。正しいオブジェクトを指定してください。
ERR_DBRERR_OIID_NOT_SETOIIDが設定されていません。SetOIIDメソッドをコールしてから,このメソッドをコールしてください。
ERR_DBRERR_SESSION_NOT_CONNECTセッションが接続されていません。セッションを接続してください。
ERR_DBRERR_TARGETCONTENTPATH_NOT_SETリファレンスファイル管理機能でコンテント格納先ベースパスが設定されていません。または,UNC形式のパスの場合(Windowsだけ),コンテント格納先ベースパスにコンピュータ名またはIPアドレスだけが使用されています。コンテント格納先ベースパスを設定してください。
ERR_DMADMARC_BAD_OIIDSetOIIDメソッドで設定されたOIIDが不正です。正しいOIIDを指定してください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。
ERR_DMADMARC_NO_MEMORYメモリ不足で実行できません。メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMADMARC_NOT_FOUND要求された要素が見つかりません。正しいオブジェクトを設定してください。
ERR_DMADMARC_NOT_SUPPORTEDこのセッションまたはオブジェクトではサポートされていないメソッドです。この操作は実行できません。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。