CdbrDocument::GetRenditionListメソッド
機能
レンディション一覧の取得
形式
DmaBoolean GetRenditionList(
DmaInteger32 lPropDefListCount,
SDBR_PROPDEF* pPropDefList,
SDBR_RENDITIONLIST** ppRenditionList )
// プロパティ定義情報構造体
struct SDBR_PROPDEF {
DmaId PropId; //プロパティ識別子
};
// プロパティ構造体
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_RENDITIONLIST {
DmaInteger32 lCount; //レンディション情報の数
SDBR_RENDITIONINFO* pItem; //レンディション情報構造体
};
// レンディション情報構造体
struct SDBR_RENDITIONINFO {
pDmaString_T pRenditionType; //RenditionTypeを表す文字列
SDBR_PROPLIST PropList; //プロパティリスト構造体
};
詳細
文書に登録されているレンディションの一覧情報とそのプロパティを取得するメソッドです。
マルチレンディション文書の場合,マスタレンディションの情報は,レンディション情報構造体である,SDBR_RENDITIONINFO構造体の配列要素の1番目に格納され,サブレンディションの情報は2番目以降に格納されます。
引数
lPropDefListCount(入力)
レンディションの一覧と同時に取得するプロパティの数(pPropDefListに指定する配列の要素数)を指定します。0を指定した場合は,プロパティは取得されません。負の値を指定した場合はエラーになります。
pPropDefList(入力)
レンディションの一覧と同時に取得するプロパティの定義情報である,SDBR_PROPDEF構造体の配列を指定します。プロパティを取得しない場合はNULLを指定してください。lPropDefListCountに正の値を指定してpPropDefListにNULLを指定した場合はエラーになります。
指定できるプロパティ識別子を次に示します。
SDBR_PROPDEF構造体については,「付録C.1(13) SDBR_PROPDEF構造体(プロパティ定義情報構造体)」を参照してください。
ppRenditionList(出力)
取得したレンディション一覧へのポインタである,SDBR_RENDITIONLIST構造体が設定されます。ポインタを格納する領域を指定してください。*ppRenditionListがポイントするメモリは,ライブラリが新たに確保したものです。このメモリは,ユーザプログラムでdbrDelete関数を使用して解放してください。なお,*ppRenditionListを指定してメモリを解放すると,構造体のメンバ(*ppRenditionList)->pItemおよびその先に確保されているメモリはすべて解放されます。したがってメソッドをコールした側がこれらのメンバのメモリを個別に解放する必要はありません。
SDBR_RENDITIONLIST構造体およびSDBR_RENDITIONINFO構造体に設定される内容については,「付録C.1(20) SDBR_RENDITIONLIST構造体(レンディションリスト構造体)」および「付録C.1(19) SDBR_RENDITIONINFO構造体(レンディション情報構造体)」を参照してください。
また,プロパティ情報が設定される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_OIID_NOT_SET | OIIDが設定されていません。 | SetOIIDメソッドをコールしてから,このメソッドをコールしてください。 |
ERR_DBR | ERR_OBJECT_NOT_CONNECT | オブジェクトは接続されていません。 | オブジェクトを接続してください。 |
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_NO_MEMORY | メモリ不足で実行できません。 | メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。 |
ERR_DMA | DMARC_NOT_FOUND | 要求された要素が見つかりません。 | 正しいオブジェクトを設定してください。 |
ERR_DMA | DMARC_NOT_SUPPORTED | このセッションまたはオブジェクトまたはクラスではサポートされていないメソッドです。 | この操作は実行できません。 |
ERR_DMA | DMARC_UNEXPECTED | 予期しないエラーが発生しました。 | 処理を終了してください。 |