CdbrDocument::GetContentInfoメソッド

機能

マルチファイル文書の情報の取得

形式

DmaBoolean GetContentInfo(
 pDmaString_T        pRenditionType,
 SDBR_CONTENTLIST**  ppContentList,
 DmaInteger32       lLockType = DMA_LOCK_READ)
 
//コンテント情報構造体
struct SDBR_CONTENTINFO {
 pDmaString_T    pComponentType;   // ファイルを識別する文字列
 pDmaString_T    pRetrievalName;   // ファイル名
 DmaUInteger32   lContentSize;     // ファイルのサイズ
};
 
//コンテント情報リスト構造体
struct SDBR_CONTENTLIST {
 DmaInteger32       lCount;           // 取得ファイル数
 SDBR_CONTENTINFO*  pItem;            // コンテント情報構造体の
                                      // ポインタ
 DmaInteger32       lValidMode;       // 有効モード
 DmaBoolean         bIsMultiContents; // マルチファイル識別
};

詳細

指定したレンディションのコンテントの情報を取得します。取得した情報は,引数ppContentListで指定したSDBR_CONTENTLIST構造体の領域に格納されます。返却されたSDBR_CONTENTLIST構造体のメンバに設定される値については,「付録C.1(2) SDBR_CONTENTLIST構造体(コンテント情報リスト構造体)」を参照してください。

このppContentListに返却されたSBDR_CONTENTLIST構造体は,直接GetContentAndLockメソッドの引数として指定できます。ただし,返却されたSDBR_CONTENTLIST構造体のlCountが0でないことを確認してから,GetContentAndLockメソッドの引数として指定してください。lCountが0であるSDBR_CONTENTLIST構造体をGetContentAndLockメソッドの引数として指定すると,DMARC_BAD_PARAMETERのエラーになります。

引数

pRenditionType(入力)

レンディションのRenditionTypeを表す文字列を指定します。指定したレンディションのコンテントの情報が取得されます。

NULLを指定した場合,マスタレンディションが処理対象になります。

ppContentList(出力)

コンテント情報リスト構造体のポインタを格納する領域を指定します。このポインタが示す領域はクラスライブラリが確保するため,使用後はこのポインタをdbrDelete関数で解放してください。

lLockType(入力)

ロックの種別を指定します。次のどちらかの値を指定してください。

戻り値

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_INVALID_STATUSセッションの状態が不正です。一つのセッションに同時に複数のメソッド処理要求が出されています。一つのセッションに対しては,一度に一つの処理要求しか出さないように見直してください。
ERR_DBRERR_NONEXISTS_RENDITION指定されたRenditionTypeは存在しません。RenditionTypeを見直してください。
ERR_DBRERR_OBJECT_NOT_CONNECTオブジェクトは接続されていません。オブジェクトを接続してください。
ERR_DBRERR_OBJECT_REMOVEDオブジェクトはすでに削除されています。正しいオブジェクトを指定してください。
ERR_DBRERR_OIID_NOT_SETOIIDが設定されていません。SetOIIDメソッドをコールしてから,このメソッドをコールしてください。
ERR_DBRERR_SESSION_NOT_CONNECTセッションが接続されていません。セッションを接続してください。
ERR_DMADMARC_BAD_LOCK_TYPE不正な種類のロックが指定されています。正しいロックタイプを指定してください。
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予期しないエラーが発生しました。処理を終了してください。