付録C.1 オブジェクトの情報を設定,参照する構造体

ここでは,オブジェクトを作成,参照または更新するときに,オブジェクトの情報およびプロパティの情報を扱う構造体についてアルファベット順で説明します。

<この項の構成>
(1) SDBR_CONTENTINFO構造体(コンテント情報構造体)
(2) SDBR_CONTENTLIST構造体(コンテント情報リスト構造体)
(3) SDBR_DMAINFO構造体(DMAオブジェクト生成用の構造体)
(4) SDBR_DMAINFOLIST構造体(DMA情報リスト構造体)
(5) SDBR_FILELINK_PATHINFO構造体(File Linkパス情報構造体)
(6) SDBR_LINKEDOBJINFO構造体(リンク付きオブジェクト情報構造体)
(7) SDBR_LINKEDOBJLIST構造体(リンク付きオブジェクトリスト構造体)
(8) SDBR_OBJINFO構造体(オブジェクト情報構造体)
(9) SDBR_OBJLIST構造体(オブジェクトリスト構造体)
(10) SDBR_PATHINFO構造体(ファイルパス情報構造体)
(11) SDBR_PATHLIST構造体(ファイルパス情報リスト構造体)
(12) SDBR_PROP構造体(プロパティ構造体)
(13) SDBR_PROPDEF構造体(プロパティ定義情報構造体)
(14) SDBR_PROPLIST構造体(プロパティリスト構造体)
(15) SDBR_REFERENCE_PATHINFO構造体(リファレンスパス情報構造体)
(16) SDBR_RELATIONINFO構造体(リレーション情報構造体)
(17) SDBR_RELATIONLIST構造体(リレーションリスト構造体)
(18) SDBR_RENDITION_COMMENTINFO構造体(レンディションコメント情報構造体)
(19) SDBR_RENDITIONINFO構造体(レンディション情報構造体)
(20) SDBR_RENDITIONLIST構造体(レンディションリスト構造体)
(21) SDBR_VROBJINFO構造体(バージョン識別子付きオブジェクト情報構造体)
(22) SDBR_VROBJLIST構造体(バージョン識別子付きオブジェクトリスト構造体)
(23) SDBR_VTLINKEDOBJINFO構造体(構成管理リンク付きオブジェクト情報構造体)
(24) SDBR_VTLINKEDOBJLIST構造体(構成管理リンク付きオブジェクトリスト構造体)
(25) SDBR_VTOBJINFO構造体(構成管理オブジェクト情報構造体)
(26) SDBR_VTOBJLIST構造体(構成管理オブジェクトリスト構造体)

(1) SDBR_CONTENTINFO構造体コンテント情報構造体

説明
マルチファイル管理機能を使用する場合に,一つのコンテントの情報を指定したり,取得したりする場合に使用する構造体です。
形式

struct SDBR_CONTENTINFO {
 pDmaString_T   pComponentType;  //ファイルを識別する文字列
 pDmaString_T   pRetrievalName;  //ファイル名
 DmaUInteger32  lContentSize;    //コンテントのサイズ
};

メンバの説明
出力されるメンバの説明
  • pComponentType
    格納しているコンテントのComponentTypeが設定されます。
  • pRetrievalName
    格納しているコンテントのRetrievalNameが設定されます。
  • lContentSize
    格納しているコンテントのサイズが設定されます。
入力するメンバの説明
CdbrDocument::GetContentInfoメソッドまたはCdbrVersionableDocument::GetContentInfoメソッドで取得した構造体を変更しないで,入力する構造体としてください。
この構造体を出力または入力するメソッド
この構造体を出力するメソッド
  • CdbrDocument::GetContentInfoメソッド
  • CdbrVersionableDocument::GetContentInfoメソッド
この構造体を入力するメソッド
  • CdbrDocument::GetContentAndLockメソッド
  • CdbrVersionableDocument::GetContentAndLockメソッド

(2) SDBR_CONTENTLIST構造体コンテント情報リスト構造体

説明
マルチファイル管理機能を使用する場合に,マルチファイル文書の情報を指定したり,取得したりする場合に使用する構造体です。
形式

struct SDBR_CONTENTLIST {
 DmaInteger32        lCount;            //登録コンテント数
 SDBR_CONTENTINFO*   pItem;             //コンテント情報構造体の
                                        //ポインタ
 DmaInteger32        lValidMode;        //有効モード
 DmaBoolean          bIsMultiContents;  //マルチファイル識別
};

メンバの説明
出力されるメンバの説明
  • lCount
    登録したコンテント数が設定されます。
  • pItem
    すべてのコンテント情報を格納したSDBR_CONTENTINFO構造体のポインタが設定されます。
  • lValidMode
    DocumentBrokerがシステムとして定義する値が設定されます。
  • bIsMultiContents
    マルチファイル文書の場合,DMA_TRUEが設定されます。マルチファイル文書ではない場合,DMA_FALSEが設定されます。
入力するメンバの説明
CdbrDocument::GetContentInfoメソッドまたはCdbrVersionableDocument::GetContentInfoメソッドで取得した構造体を変更しないで,入力する構造体としてください。
この構造体を出力または入力するメソッド
この構造体を出力するメソッド
  • CdbrDocument::GetContentInfoメソッド
  • CdbrVersionableDocument::GetContentInfoメソッド
この構造体を入力するメソッド
  • CdbrDocument::GetContentAndLockメソッド
  • CdbrVersionableDocument::GetContentAndLockメソッド

(3) SDBR_DMAINFO構造体DMAオブジェクト生成用の構造体

説明
クラスライブラリのオブジェクトを作成するときに,構成要素にするDMAオブジェクトの基になるDMAのクラスの情報を指定します。
なお,それぞれのDMAオブジェクトにプロパティを設定する場合は,プロパティリスト構造体(SDBR_PROPLIST構造体)を指定します。
また,マッピング定義情報に従ってXMLファイルからプロパティを抽出する場合,DMAオブジェクト生成用の情報が設定される構造体です。
形式

// DMAオブジェクト生成用の構造体
struct SDBR_DMAINFO {
 DmaId            ClassId;   //DMAオブジェクトのクラス識別子
 SDBR_PROPLIST    PropList;  //プロパティ情報のリスト
};

メンバの説明
出力されるメンバの説明
  • ClassId
    DMAオブジェクトのクラス識別子が設定されます。
  • PropList
    マッピング定義情報に従ってXMLファイルから抽出したプロパティのリストを格納したSDBR_PROPLIST構造体のアドレスが設定されます。
入力するメンバの説明
  • ClassId
    新規に作成するDMAオブジェクトのクラス識別子を指定します。
    作成するDMAオブジェクトと指定するクラス識別子の関係を次に示します。

    表C-1  DMAオブジェクトを作成する場合に指定するクラス識別子

    作成するオブジェクト指定するクラス識別子
    CdbrConfiguratedReferentialContainerオブジェクト1番目の要素としてdmaClass_ConfigurationHistoryクラスまたはそのサブクラスのクラス識別子,2番目の要素としてedmClass_ContainerVersionクラスまたはそのサブクラスのクラス識別子を指定します。
    2番目の要素を省略した場合(メソッドの引数lDMAInfoListCountが1の場合)は,edmClass_ContainerVersionクラスを使用してDMAオブジェクトが作成されます。1番目の要素を省略した場合(メソッドの引数lDMAInfoListCountが0でpDMAInfoListがNULLの場合),edmClass_ContainerVersionクラスとdmaClass_ConfigurationHistoryクラスを使用してDMAオブジェクトが作成されます。
    CdbrDocumentオブジェクトdmaClass_DocVersionクラスまたはそのサブクラスのクラス識別子を指定します。
    省略した場合(メソッドの引数lDMAInfoListCountが0でpDMAInfoListがNULLの場合),edmClass_VersionTracedComponentDocVersionクラスを使用してDMAオブジェクトが作成されます。
    CdbrIndependentPersistenceオブジェクトedmClass_IndependentPersistenceクラスまたはそのサブクラスのクラス識別子を指定します。
    省略した場合(メソッドの引数lDMAInfoListCountが0でpDMAInfoListがNULLの場合),edmClass_IndependentPersistenceクラスを使用してDMAオブジェクトが作成されます。
    CdbrPublicACLオブジェクトedmClass_PublicACLクラスのクラス識別子を指定します。
    省略した場合(メソッドの引数lDMAInfoListCountが0でpDMAInfoListがNULLの場合),edmClass_PublicACLクラスを使用してDMAオブジェクトが作成されます。
    CdbrReferentialContainerオブジェクトdmaClass_Containerクラスまたはそのサブクラスのクラス識別子を指定します。
    省略した場合(メソッドの引数lDMAInfoListCountが0でpDMAInfoListがNULLの場合),dmaClass_Containerクラスを使用してDMAオブジェクトが作成されます。
    CdbrVersionableDocumentオブジェクト1番目の要素としてdmaClass_ConfigurationHistoryクラスまたはそのサブクラスのクラス識別子,2番目の要素としてdmaClass_DocVersionクラスまたはそのサブクラスのクラス識別子を指定します。
    2番目の要素を省略した場合(メソッドの引数lDMAInfoListCountが1の場合),edmClass_VersionTracedComponentDocVersionクラスを使用してDMAオブジェクトが作成されます。1番目の要素を省略した場合(メソッドの引数lDMAInfoListCountが0でpDMAInfoListがNULLの場合),edmClass_VersionTracedComponentDocVersionクラスを使用してDocVersionオブジェクトが作成され,dmaClass_ConfigurationHistoryクラスを使用してConfigurationHistoryオブジェクトが作成されます。
    CdbrVersionTraceableContainerオブジェクトedmClass_ContainerVersionクラスまたはそのサブクラスのクラス識別子を指定します。
    省略した場合(メソッドの引数lDMAInfoListCountが0でpDMAInfoListがNULLの場合),edmClass_ContainerVersionクラスを使用してDMAオブジェクトが作成されます。
  • PropList
    オブジェクトの初期値として設定するプロパティを設定したSDBR_PROPLIST構造体のアドレスを指定します。
この構造体を出力または入力するメソッド
この構造体を出力するメソッド
  • CdbrXmlTranslator::GetDmaInfoListメソッド
この構造体を入力するメソッド
  • CdbrConfiguratedReferentialContainer::CreateObjectメソッド
  • CdbrDocument::CreateObjectメソッド
  • CdbrIndependentPersistence::CreateObjectメソッド
  • CdbrPublicACL::CreateObjectメソッド
  • CdbrReferentialContainer::CreateObjectメソッド
  • CdbrVersionableDocument::CreateObjectメソッド
  • CdbrVersionTraceableContainer::CreateObjectメソッド

(4) SDBR_DMAINFOLIST構造体DMA情報リスト構造体

説明

マッピング定義情報に従ってXMLファイルからプロパティを抽出してDMA情報リスト(文書オブジェクトを作成するときのプロパティの初期値のリスト)を作成する場合に,DMA情報(SDBR_DMAINFO構造体)の個数とポインタが設定される構造体です。

形式

struct SDBR_DMAINFOLIST {
 DmaInteger32     lCount;     //DMAオブジェクトの情報の個数
 SDBR_DMAINFO*    pItem;      //DMAオブジェクトの情報
};

メンバの説明
  • lCount
    DMAオブジェクトの情報の個数が設定されます。
  • pItem
    DMAオブジェクトの情報がSDBR_DMAINFO構造体として設定されます。なお,設定される構造体の配列の要素数は,マッピング定義情報で指定したクラスの数と同じです。
この構造体を出力するメソッド
  • CdbrXmlTranslator::GetDmaInfoListメソッド

(5) SDBR_FILELINK_PATHINFO構造体File Linkパス情報構造体

説明
File Link連携機能を使用する場合に,HiRDB File Linkで必要な情報を格納する構造体です。
File Link文書を登録または更新するときには,登録するファイルまたはディレクトリや登録先など,HiRDB File Linkが必要とする情報を指定します。File Link文書を取得するときには,取得先のクライアントのファイルパスまたはディレクトリパスを指定します。
形式

// File Linkパス情報構造体
struct SDBR_FILELINK_PATHINFO {
 pDmaString_T  pFilePath;          // 登録ファイルもしくは
                                   //   ディレクトリのURL
                                   // または取得先のファイルもしくは
                                   //   ディレクトリのURL
 pDmaString_T  pFamName;           // FAM名
 pDmaString_T  pFamFilePath;       // コンテント保管先パス
 DmaInteger32  lContentDeleteMode; // コンテント削除モード
 DmaInteger32  lFileNamingMode;    // コンテント名自動生成モード
};

メンバの説明
なお,文書の取得時には,メンバpFilePathの指定だけが有効になります。
  • pFilePath
    文書の登録・更新時に,クライアントにあるファイルを登録または更新する場合は,登録するコンテントとして,クライアントにあるファイルまたはディレクトリのパス名を,URL形式で指定します。ファイルパスを指定した場合は,指定したファイルが登録されます。ディレクトリパスを指定した場合は,指定したディレクトリおよびそのサブディレクトリ下のすべてのファイルが登録されます。
    文書の登録・更新時に,すでにHiRDB File Linkで管理されているデータをコンテントとして登録する場合は,NULLを指定します。
    文書の取得時には,コンテントの取得先として,クライアントのファイルパスまたはディレクトリパスを指定します。
  • pFamName
    HiRDB File Linkのflsetupコマンドの -famオプションで指定したFAM名を指定します。FAM名の詳細については,マニュアル「HiRDB File Link」を参照してください。
  • pFamFilePath
    コンテント保管先のパスを指定します。保管先のパスの設定については,マニュアル「HiRDB File Link」を参照してください。
  • lContentDeleteMode
    文書のコンテントをRemoveObjectメソッドまたはDeleteRenditionメソッドによって削除するときに,保管先のファイルの実体を削除することを指定します。必ず,DBR_CONTENTDELETE_SYNCを指定してください。
  • lFileNamingMode
    文書のコンテントを登録するときに,保管先でのコンテント名を自動生成するかどうかを指定します。
    自動生成機能を使用しない場合はDBR_FILENAMING_SPECIFYを指定してください。使用する場合はDBR_FILENAMING_AUTOを指定してください。
この構造体を出力するメソッド
  • CdbrDocument::AddRenditionメソッド
  • CdbrDocument::CreateObjectメソッド
  • CdbrDocument::GetContentAndLockメソッド
  • CdbrDocument::UpdateContentメソッド
  • CdbrDocument::UpdateContentAndRenditionTypeメソッド
  • CdbrVersionableDocument::AddRenditionメソッド
  • CdbrVersionableDocument::CreateObjectメソッド
  • CdbrVersionableDocument::GetContentAndLockメソッド
  • CdbrVersionableDocument::UpdateContentメソッド
  • CdbrVersionableDocument::UpdateContentAndRenditionTypeメソッド

(6) SDBR_LINKEDOBJINFO構造体リンク付きオブジェクト情報構造体

説明
コンテナによってオブジェクト間の関連づけを設定している場合に,コンテナが包含しているオブジェクトの情報やリンク識別子などが設定される構造体です。また,包含しているオブジェクトのプロパティやリンクのプロパティ情報を取得する場合,プロパティリスト構造体(SDBR_PROPLIST構造体)が設定されます。
形式

struct SDBR_LINKEDOBJINFO{
 pDmaString_T   pOIID;        //オブジェクトのOIID
 DmaInteger32   lType;        //オブジェクトの種別
 pDmaString_T   pLinkId;      //リンク識別子
 SDBR_PROPLIST  PropList;     //オブジェクトのプロパティリスト
 SDBR_PROPLIST  LinkPropList; //リンクのプロパティリスト
};

メンバの説明
  • pOIID
    コンテナが指しているオブジェクトのOIIDが設定されます。または,オブジェクトを指しているコンテナのOIIDが設定されます。
  • lType
    オブジェクトの種別を表す値として,対応するクラスライブラリのクラスを示す定数が設定されます。定数とクラスライブラリのクラスの関係は,「付録C.3 構造体で指定する定数」を参照してください。
  • pLinkId
    オブジェクトのリンク識別子が設定されます。
  • PropList
    オブジェクトがメソッドの引数で指定したプロパティを持つ場合,プロパティ情報がSDBR_PROPLIST構造体として設定されます。
  • LinkPropList
    オブジェクトのリンクがメソッドの引数で指定したプロパティを持つ場合,プロパティの識別子,型および値の一覧がSDBR_PROPLIST構造体として設定されます。
この構造体を出力するメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListAndLockメソッド
  • CdbrContainable::GetContainerListメソッド
  • CdbrContainable::GetContainerListAndLockメソッド
  • CdbrReferentialContainer::GetContainableListメソッド
  • CdbrReferentialContainer::GetContainableListAndLockメソッド

(7) SDBR_LINKEDOBJLIST構造体リンク付きオブジェクトリスト構造体

説明
リンク付きオブジェクト情報構造体(SDBR_LINKEDOBJINFO構造体)の個数とポインタが設定される構造体です。
形式

struct SDBR_LINKEDOBJLIST{
 DmaInteger32        lCount; //リンク付きオブジェクト情報の個数
 SDBR_LINKEDOBJINFO* pItem;  //リンク付きオブジェクト情報
};

メンバの説明
  • lCount
    リンク付きオブジェクト情報を表すSDBR_LINKEDOBJINFO構造体の個数が設定されます。
  • pItem
    SDBR_LINKEDOBJINFO構造体の先頭のアドレスへのポインタが設定されます。このとき,SDBR_LINKEDOBJINFO構造体の個数分の領域が確保されます。
この構造体を出力するメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListAndLockメソッド
  • CdbrContainable::GetContainerListメソッド
  • CdbrContainable::GetContainerListAndLockメソッド
  • CdbrReferentialContainer::GetContainableListメソッド
  • CdbrReferentialContainer::GetContainableListAndLockメソッド

(8) SDBR_OBJINFO構造体オブジェクト情報構造体

説明
オブジェクト間の情報が設定される構造体です。例えば,コンテナによってオブジェクト間の関連づけを設定している場合,指定したコンテナが包含しているオブジェクトの情報,または指定したオブジェクトが包含されているコンテナの情報が設定されます。
また,オブジェクトのプロパティ情報を取得する場合には,プロパティリスト構造体(SDBR_PROPLIST構造体)が設定されます。
形式

struct SDBR_OBJINFO {
 pDmaString_T     pOIID;      // オブジェクトのOIID
 DmaInteger32     lType;      // オブジェクトの種別
 SDBR_PROPLIST    PropList;   // プロパティリスト構造体
};

メンバの説明
  • pOIID
    メソッドの実行結果となるオブジェクトのOIIDが設定されます。例えば,バージョン付きコンテナの場合は,指定したバージョンに対応するオブジェクトのOIIDが設定されます。
    なお,次に示すメソッドではバージョン識別子が設定されます。
    CdbrVersionable::GetVersionListメソッド
    CdbrVersionable::GetVersionListAndLockメソッド
  • lType
    オブジェクトの種別を表す値として,対応するクラスライブラリのクラスを示す定数が設定されます。定数とクラスライブラリのクラスの関係は,「付録C.3 構造体で指定する定数」を参照してください。
    なお,次に示すメソッドではlTypeに相当する情報が設定されても,その内容は保証できません。
    CdbrVersionable::GetVersionListメソッド
    CdbrVersionable::GetVersionListAndLockメソッド
  • PropList
    対象オブジェクトが,メソッドの引数で指定したプロパティを持つ場合,プロパティ情報がSDBR_PROPLIST構造体として設定されます。
この構造体を出力するメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListAndLockメソッド
  • CdbrContainable::GetContainerListメソッド
  • CdbrContainable::GetContainerListAndLockメソッド
  • CdbrContainable::GetPublicACLListメソッド
  • CdbrContainable::GetPublicACLListAndLockメソッド
  • CdbrDocument::GetVersionableListメソッド
  • CdbrDocument::GetVersionableListAndLockメソッド
  • CdbrIndependentPersistence::GetPublicACLListメソッド
  • CdbrIndependentPersistence::GetPublicACLListAndLockメソッド
  • CdbrPublicACL::GetBindObjectListメソッド
  • CdbrPublicACL::GetBindObjectListAndLockメソッド
  • CdbrReferentialContainer::GetContainableListメソッド
  • CdbrReferentialContainer::GetContainableListAndLockメソッド
  • CdbrVersionable::GetPublicACLListメソッド
  • CdbrVersionable::GetPublicACLListAndLockメソッド
  • CdbrVersionable::GetVersionListメソッド
  • CdbrVersionable::GetVersionListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVersionableListメソッド
  • CdbrVersionTraceableContainer::GetVersionableListAndLockメソッド

(9) SDBR_OBJLIST構造体オブジェクトリスト構造体

説明
オブジェクト情報構造体(SDBR_OBJINFO構造体)の個数とポインタが設定される構造体です。
形式

struct SDBR_OBJLIST {
 DmaInteger32     lCount;    //オブジェクト情報の個数
 SDBR_OBJINFO*    pItem;     //オブジェクト情報
};

メンバの説明
  • lCount
    取得したOBJINFO構造体の個数が設定されます。
  • pItem
    SDBR_OBJINFO構造体の先頭のアドレスへのポインタが設定されます。このとき,SDBR_OBJINFO構造体の個数分の領域が確保されます。
この構造体を出力するメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListAndLockメソッド
  • CdbrContainable::GetContainerListメソッド
  • CdbrContainable::GetContainerListAndLockメソッド
  • CdbrContainable::GetPublicACLListメソッド
  • CdbrContainable::GetPublicACLListAndLockメソッド
  • CdbrDocument::GetVersionableListメソッド
  • CdbrDocument::GetVersionableListAndLockメソッド
  • CdbrIndependentPersistence::GetPublicACLListメソッド
  • CdbrIndependentPersistence::GetPublicACLListAndLockメソッド
  • CdbrPublicACL::GetBindObjectListメソッド
  • CdbrPublicACL::GetBindObjectListAndLockメソッド
  • CdbrReferentialContainer::GetContainableListメソッド
  • CdbrReferentialContainer::GetContainableListAndLockメソッド
  • CdbrVersionable::GetPublicACLListメソッド
  • CdbrVersionable::GetPublicACLListAndLockメソッド
  • CdbrVersionable::GetVersionListメソッド
  • CdbrVersionable::GetVersionListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVersionableListメソッド
  • CdbrVersionTraceableContainer::GetVersionableListAndLockメソッド

(10) SDBR_PATHINFO構造体ファイルパス情報構造体

説明
マルチファイル管理機能を使用する場合に,一つのファイルの情報を指定する構造体です。
形式

struct SDBR_PATHINFO {
 pDmaString_T      pFilePath;        //ファイルのURL
 pDmaString_T      pComponentType;   //ファイルを識別する文字列
};

メンバの説明
  • pFilePath
    ファイルのURLを指定します。"file://"で始まる文字列で指定してください。
    URLの値からファイル名が抽出され,そのファイル名がデータベースに登録されます。
  • pComponentType
    複数のファイルを識別するための任意の文字列を指定します。文書空間で使用する文字コード種別がUTF-8の場合,印刷可能なASCIIコードで記述してください。
    NULLを指定した場合,データベースには空文字列が格納されます。
    文字列長は,0~255(バイト)
この構造体を入力するメソッド
  • CdbrDocument::CreateObjectメソッド
  • CdbrDocument::UpdateContentメソッド
  • CdbrVersionableDocument::CreateObjectメソッド
  • CdbrVersionableDocument::UpdateContentメソッド

(11) SDBR_PATHLIST構造体ファイルパス情報リスト構造体

説明
マルチファイル管理機能を使用する場合に,マルチファイル文書の複数のファイルのファイルパス情報を指定する構造体です。
形式

struct SDBR_PATHLIST {
 DmaInteger32        lCount;   //登録ファイル数
 SDBR_PATHINFO*      pItem;    //ファイルパス情報構造体のポインタ
};

メンバの説明
  • lCount
    登録するファイルの数を指定します。指定できるのは,「1~メタ情報の初期設定コマンド(EDMInitMeta)で定義する最大要素数」の範囲の値です。なお,この範囲内の値であっても,BLOBに定義した最大サイズを超えた場合はエラーになります。
  • pItem
    ファイルパス情報構造体のメンバを配列として確保した領域の先頭アドレスを指定します。
この構造体を入力するメソッド
  • CdbrDocument::CreateObjectメソッド
  • CdbrDocument::UpdateContentメソッド
  • CdbrVersionableDocument::CreateObjectメソッド
  • CdbrVersionableDocument::UpdateContentメソッド

(12) SDBR_PROP構造体プロパティ構造体

説明
参照系メソッドによってオブジェクトのプロパティを参照するときに,取得したプロパティの情報が設定される構造体です。
また,更新系メソッドによってオブジェクトのプロパティを設定するときに,設定するプロパティの情報を指定する構造体です。
なお,プロパティ構造体(SDBR_PROP構造体)を入力に使用する場合,同じプロパティ識別子を指定したプロパティ構造体(SDBR_PROP構造体)をプロパティリスト構造体(SDBR_PROPLIST構造体)に複数指定した場合は,エラーになります。
形式

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;
};

メンバの説明
出力されるメンバの説明
  • PropId
    プロパティ識別子が設定されます。
  • lType
    プロパティのデータ型が設定されます。設定される値を次に示します。
    DMA_DATATYPE_BOOLEAN:Boolean型
    DMA_DATATYPE_ID: ID型
    DMA_DATATYPE_INTEGER32: Integer32型
    DMA_DATATYPE_OBJECT:Object型
    DMA_DATATYPE_STRING:String型
  • lCardinality
    基本単位が設定されます。設定される値を次に示します。
    DMA_CARDINALITY_SINGLE:Scalar(スカラー)型
    DMA_CARDINALITY_ENUM:Enumeration(列挙)型
    DMA_CARDINALITY_LIST:List(リスト)型
    EDM_DMA_CARDINALITY_VARRAY:VariableArray(可変長配列)型
  • lCount
    プロパティの値の要素数が設定されます。要素数は,lCardinalityの値に応じて設定されます。lCardinalityの値と設定される値を次に示します。
    DMA_CARDINALITY_SINGLEの場合:1
    DMA_CARDINALITY_ENUMまたはDMA_CARDINALITY_LISTの場合:0以上の値
    EDM_DMA_CARDINALITY_VARRAYの場合:1
  • 共用体uniValueのメンバ
    プロパティの値は,共用体uniValueのメンバpbBoolean,plInteger32,pId,ppObject,ppStringのうち,lTypeに設定された型と名前が一致するものが示す領域に設定されます。
注意事項
lTypeがDMA_DATATYPE_OBJECTで,lCardinalityがEDM_DMA_CARDINALITY_VARRAYの場合,CdbrVariableArrayオブジェクトへのポインタを取得します。このポインタは,構造体をdbrDelete関数で削除すると,同時に解放または削除されますので,個別に解放する必要はありません。ただし,dbrDelete関数をコールしたあとで,このポインタは使用できません。
入力するメンバの説明
  • PropId
    プロパティ識別子を指定します。
    同じプロパティ識別子を指定したSDBR_PROP構造体をSDBR_PROPLIST構造体に複数指定した場合は,エラーになります。
  • lType
    プロパティの型を示す値として,次の値を指定します。
    DMA_DATATYPE_BOOLEAN:Boolean型
    DMA_DATATYPE_ID: ID型
    DMA_DATATYPE_INTEGER32: Integer32型
    DMA_DATATYPE_OBJECT:Object型
    DMA_DATATYPE_STRING:String型
  • lCardinality
    基本単位として,次の値を指定します。
    DMA_CARDINALITY_SINGLE:Scalar(スカラー)型
    DMA_CARDINALITY_LIST:List(リスト)型
    EDM_DMA_CARDINALITY_VARRAY:VariableArray(可変長配列)型
  • lCount
    プロパティの値の要素数を指定します。要素数は,lCardinalityの値に応じて指定します。lCardinalityの値と指定する値を次に示します。
    DMA_CARDINALITY_SINGLEの場合:この値は無視されます。
    DMA_CARDINALITY_LISTの場合:0以上の値を指定します。
    EDM_DMA_CARDINALITY_VARRAYの場合:1を指定します。
  • 共用体uniValueのメンバ
    プロパティの値は,共用体uniValueのメンバpbBoolean,plInteger32,pId,ppObject,ppStringのうち,lTypeに指定した型と名前が一致するものが示す領域に指定します。
この構造体を出力または入力するメソッド
この構造体を出力するメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListAndLockメソッド
  • CdbrConfiguratedReferentialContainer::GetLinkPropertyValuesメソッド
  • CdbrConfiguratedReferentialContainer::GetLinkPropertyValuesAndLockメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListAndLockメソッド
  • CdbrContainable::GetContainerListメソッド
  • CdbrContainable::GetContainerListAndLockメソッド
  • CdbrContainable::GetPublicACLListメソッド
  • CdbrContainable::GetPublicACLListAndLockメソッド
  • CdbrDMA::GetPropertyValuesメソッド
  • CdbrDMA::GetPropertyValuesAndLockメソッド
  • CdbrDocument::GetRelationListメソッド
  • CdbrDocument::GetRelationListAndLockメソッド
  • CdbrDocument::GetRenditionListメソッド
  • CdbrDocument::GetRenditionListAndLockメソッド
  • CdbrDocument::GetVersionableListメソッド
  • CdbrDocument::GetVersionableListAndLockメソッド
  • CdbrIndependentPersistence::GetPublicACLListメソッド
  • CdbrIndependentPersistence::GetPublicACLListAndLockメソッド
  • CdbrPublicACL::GetBindObjectListメソッド
  • CdbrPublicACL::GetBindObjectListAndLockメソッド
  • CdbrReferentialContainer::GetContainableListメソッド
  • CdbrReferentialContainer::GetContainableListAndLockメソッド
  • CdbrReferentialContainer::GetLinkPropertyValuesメソッド
  • CdbrReferentialContainer::GetLinkPropertyValuesAndLockメソッド
  • CdbrSession::GetUserInfoメソッド
  • CdbrVersionable::GetPropertyValuesメソッド
  • CdbrVersionable::GetPropertyValuesAndLockメソッド
  • CdbrVersionable::GetPublicACLListメソッド
  • CdbrVersionable::GetPublicACLListAndLockメソッド
  • CdbrVersionable::GetVersionListメソッド
  • CdbrVersionable::GetVersionListAndLockメソッド
  • CdbrVersionableDocument::GetRelationListメソッド
  • CdbrVersionableDocument::GetRelationListAndLockメソッド
  • CdbrVersionableDocument::GetRenditionListメソッド
  • CdbrVersionableDocument::GetRenditionListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVersionableListメソッド
  • CdbrVersionTraceableContainer::GetVersionableListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListAndLockメソッド
  • CdbrXmlTranslator::GetDmaInfoListメソッド
この構造体を入力するメソッド
  • CdbrConfiguratedReferentialContainer::CreateObjectメソッド
  • CdbrConfiguratedReferentialContainer::Linkメソッド
  • CdbrConfiguratedReferentialContainer::LinkAndLockメソッド
  • CdbrConfiguratedReferentialContainer::LinkVTFixメソッド
  • CdbrConfiguratedReferentialContainer::LinkVTFixAndLockメソッド
  • CdbrConfiguratedReferentialContainer::LinkVTFloatメソッド
  • CdbrConfiguratedReferentialContainer::LinkVTFloatAndLockメソッド
  • CdbrConfiguratedReferentialContainer::PutLinkPropertyValuesメソッド
  • CdbrDMA::PutPropertyValuesメソッド
  • CdbrDocument::AddRenditionメソッド
  • CdbrDocument::CreateObjectメソッド
  • CdbrDocument::CreateRelationメソッド
  • CdbrDocument::PutRelationPropertyValuesメソッド
  • CdbrDocument::PutRenditionPropertyValuesメソッド
  • CdbrIndependentPersistence::CreateObjectメソッド
  • CdbrPublicACL::CreateObjectメソッド
  • CdbrReferentialContainer::CreateObjectメソッド
  • CdbrReferentialContainer::Linkメソッド
  • CdbrReferentialContainer::LinkAndLockメソッド
  • CdbrReferentialContainer::PutLinkPropertyValuesメソッド
  • CdbrVersionable::PutPropertyValuesメソッド
  • CdbrVersionableDocument::AddRenditionメソッド
  • CdbrVersionableDocument::CreateObjectメソッド
  • CdbrVersionableDocument::CreateRelationメソッド
  • CdbrVersionableDocument::PutRelationPropertyValuesメソッド
  • CdbrVersionableDocument::PutRenditionPropertyValuesメソッド
  • CdbrVersionTraceableContainer::CreateObjectメソッド
  • CdbrVersionTraceableContainer::LinkVTFixメソッド
  • CdbrVersionTraceableContainer::LinkVTFixAndLockメソッド
  • CdbrVersionTraceableContainer::LinkVTFloatメソッド
  • CdbrVersionTraceableContainer::LinkVTFloatAndLockメソッド

(13) SDBR_PROPDEF構造体プロパティ定義情報構造体

説明
オブジェクトのプロパティを参照するときに,参照するプロパティのプロパティ識別子を指定する構造体です。
形式

struct SDBR_PROPDEF {
 DmaId        PropId;        // プロパティ識別子
};

メンバの説明
  • PropId
    プロパティ識別子を指定します。
この構造体を入力するメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListAndLockメソッド
  • CdbrConfiguratedReferentialContainer::GetLinkPropertyValuesメソッド
  • CdbrConfiguratedReferentialContainer::GetLinkPropertyValuesAndLockメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListAndLockメソッド
  • CdbrContainable::GetContainerListメソッド
  • CdbrContainable::GetContainerListAndLockメソッド
  • CdbrContainable::GetPublicACLListメソッド
  • CdbrContainable::GetPublicACLListAndLockメソッド
  • CdbrDMA::GetPropertyValuesメソッド
  • CdbrDMA::GetPropertyValuesAndLockメソッド
  • CdbrDocument::GetRelationListメソッド
  • CdbrDocument::GetRelationListAndLockメソッド
  • CdbrDocument::GetRenditionListメソッド
  • CdbrDocument::GetRenditionListAndLockメソッド
  • CdbrDocument::GetVersionableListメソッド
  • CdbrDocument::GetVersionableListAndLockメソッド
  • CdbrIndependentPersistence::GetPublicACLListメソッド
  • CdbrIndependentPersistence::GetPublicACLListAndLockメソッド
  • CdbrPublicACL::GetBindObjectListメソッド
  • CdbrPublicACL::GetBindObjectListAndLockメソッド
  • CdbrReferentialContainer::GetContainableListメソッド
  • CdbrReferentialContainer::GetContainableListAndLockメソッド
  • CdbrReferentialContainer::GetLinkPropertyValuesメソッド
  • CdbrReferentialContainer::GetLinkPropertyValuesAndLockメソッド
  • CdbrSession::GetUserInfoメソッド
  • CdbrVersionable::GetPropertyValuesメソッド
  • CdbrVersionable::GetPropertyValuesAndLockメソッド
  • CdbrVersionable::GetPublicACLListメソッド
  • CdbrVersionable::GetPublicACLListAndLockメソッド
  • CdbrVersionable::GetVersionListメソッド
  • CdbrVersionable::GetVersionListAndLockメソッド
  • CdbrVersionableDocument::GetRelationListメソッド
  • CdbrVersionableDocument::GetRelationListAndLockメソッド
  • CdbrVersionableDocument::GetRenditionListメソッド
  • CdbrVersionableDocument::GetRenditionListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVersionableListメソッド
  • CdbrVersionTraceableContainer::GetVersionableListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListAndLockメソッド

(14) SDBR_PROPLIST構造体プロパティリスト構造体

説明
参照系メソッドによってオブジェクトのプロパティを参照するときに,プロパティ構造体(SDBR_PROP構造体)の個数とポインタが設定される構造体です。
また,更新系メソッドによってオブジェクトのプロパティを設定するときに,プロパティ構造体(SDBR_PROP構造体)とその個数を指定する構造体です。なお,プロパティを設定する場合,同じプロパティ識別子を指定したプロパティ構造体(SDBR_PROP構造体)をプロパティリスト構造体(SDBR_PROPLIST構造体)に複数指定した場合は,エラーになります。
形式

struct SDBR_PROPLIST{
 DmaInteger32    lCount;    //プロパティ情報の個数
 SDBR_PROP*      pItem;     //プロパティ情報
};

メンバの説明
出力されるメンバの説明
  • lCount
    取得したSDBR_PROP構造体の個数が設定されます。取得する必要がある値がデータベースに設定されていないなどで,プロパティをまったく取得しなかった場合,0が設定されます。
  • pItem
    プロパティの識別子と値が格納されたSDBR_PROP構造体の先頭のアドレスへのポインタが設定されます。プロパティをまったく取得しなかった場合,NULLが設定されます。
    このとき,SDBR_PROP構造体の個数分の領域が確保されます。
入力するメンバの説明
  • lCount
    pItemに指定するプロパティ情報の個数を指定します。CreateObjectメソッドをコールするときに0を指定した場合は,プロパティの値は設定されません。負の数を指定した場合は,エラーになります。
  • pItem
    初期値として設定するプロパティの識別子と値を格納したSDBR_PROP構造体の先頭のアドレスを指定します。NULLを指定した場合,プロパティの値は設定されません。
    なお,lCountが正の整数のときにpItemにNULLを指定すると,エラーになります。
この構造体を出力または入力するメソッド
この構造体を出力するメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListメソッド
  • CdbrConfiguratedReferentialContainer::GetContainableListAndLockメソッド
  • CdbrConfiguratedReferentialContainer::GetLinkPropertyValuesメソッド
  • CdbrConfiguratedReferentialContainer::GetLinkPropertyValuesAndLockメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListAndLockメソッド
  • CdbrContainable::GetContainerListメソッド
  • CdbrContainable::GetContainerListAndLockメソッド
  • CdbrContainable::GetPublicACLListメソッド
  • CdbrContainable::GetPublicACLListAndLockメソッド
  • CdbrDMA::GetPropertyValuesメソッド
  • CdbrDMA::GetPropertyValuesAndLockメソッド
  • CdbrDocument::GetRelationListメソッド
  • CdbrDocument::GetRelationListAndLockメソッド
  • CdbrDocument::GetRenditionListメソッド
  • CdbrDocument::GetRenditionListAndLockメソッド
  • CdbrDocument::GetVersionableListメソッド
  • CdbrDocument::GetVersionableListAndLockメソッド
  • CdbrIndependentPersistence::GetPublicACLListメソッド
  • CdbrIndependentPersistence::GetPublicACLListAndLockメソッド
  • CdbrPublicACL::GetBindObjectListメソッド
  • CdbrPublicACL::GetBindObjectListAndLockメソッド
  • CdbrReferentialContainer::GetContainableListメソッド
  • CdbrReferentialContainer::GetContainableListAndLockメソッド
  • CdbrReferentialContainer::GetLinkPropertyValuesメソッド
  • CdbrReferentialContainer::GetLinkPropertyValuesAndLockメソッド
  • CdbrSession::GetUserInfoメソッド
  • CdbrVersionable::GetPropertyValuesメソッド
  • CdbrVersionable::GetPropertyValuesAndLockメソッド
  • CdbrVersionable::GetPublicACLListメソッド
  • CdbrVersionable::GetPublicACLListAndLockメソッド
  • CdbrVersionable::GetVersionListメソッド
  • CdbrVersionable::GetVersionListAndLockメソッド
  • CdbrVersionableDocument::GetRelationListメソッド
  • CdbrVersionableDocument::GetRelationListAndLockメソッド
  • CdbrVersionableDocument::GetRenditionListメソッド
  • CdbrVersionableDocument::GetRenditionListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVersionableListメソッド
  • CdbrVersionTraceableContainer::GetVersionableListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListAndLockメソッド
  • CdbrXmlTranslator::GetDmaInfoListメソッド
この構造体を入力するメソッド
  • CdbrConfiguratedReferentialContainer::CreateObjectメソッド
  • CdbrConfiguratedReferentialContainer::Linkメソッド
  • CdbrConfiguratedReferentialContainer::LinkAndLockメソッド
  • CdbrConfiguratedReferentialContainer::LinkVTFixメソッド
  • CdbrConfiguratedReferentialContainer::LinkVTFixAndLockメソッド
  • CdbrConfiguratedReferentialContainer::LinkVTFloatメソッド
  • CdbrConfiguratedReferentialContainer::LinkVTFloatAndLockメソッド
  • CdbrConfiguratedReferentialContainer::PutLinkPropertyValuesメソッド
  • CdbrDMA::PutPropertyValuesメソッド
  • CdbrDocument::AddRenditionメソッド
  • CdbrDocument::CreateObjectメソッド
  • CdbrDocument::CreateRelationメソッド
  • CdbrDocument::PutRelationPropertyValuesメソッド
  • CdbrDocument::PutRenditionPropertyValuesメソッド
  • CdbrIndependentPersistence::CreateObjectメソッド
  • CdbrPublicACL::CreateObjectメソッド
  • CdbrReferentialContainer::CreateObjectメソッド
  • CdbrReferentialContainer::Linkメソッド
  • CdbrReferentialContainer::LinkAndLockメソッド
  • CdbrReferentialContainer::PutLinkPropertyValuesメソッド
  • CdbrVersionable::PutPropertyValuesメソッド
  • CdbrVersionableDocument::AddRenditionメソッド
  • CdbrVersionableDocument::CreateObjectメソッド
  • CdbrVersionableDocument::CreateRelationメソッド
  • CdbrVersionableDocument::PutRelationPropertyValuesメソッド
  • CdbrVersionableDocument::PutRenditionPropertyValuesメソッド
  • CdbrVersionTraceableContainer::CreateObjectメソッド
  • CdbrVersionTraceableContainer::LinkVTFixメソッド
  • CdbrVersionTraceableContainer::LinkVTFixAndLockメソッド
  • CdbrVersionTraceableContainer::LinkVTFloatメソッド
  • CdbrVersionTraceableContainer::LinkVTFloatAndLockメソッド

(15) SDBR_REFERENCE_PATHINFO構造体リファレンスパス情報構造体

説明
リファレンスファイル管理機能を使用する場合に,リファレンスファイル管理機能で必要な情報が設定される構造体です。
形式

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

メンバの説明
  • lContentOperateMode
    リファレンスパス情報構造体で指定するパス操作モードを指定します。リファレンスパス情報構造体で指定する内容は,この指定に基づき,チェックされます。コンテントロケーションをコンテントの相対パスで管理する場合は,DBR_OPERATEMODE_USER_RELATIVE_CONTENTを指定します。コンテントがないオブジェクトを作成する場合は,DBR_OPERATEMODE_NONEを指定します。
  • pEntry
    文書の作成時に登録するコンテントのパス,またはコンテント取得時のコンテントのダウンロード先のパスを,URL形式で指定します。なお,CdbrSession::SetReferencePathで指定したコンテント格納先ベースパス,pTargetPath,DocumentBrokerがコンテントを管理するためのディレクトリ(35バイト),およびpEntryで指定したファイル名を合わせた文字列長(パスの区切り文字も含む)が,Windowsの場合1~259(バイト),AIXの場合1~1022(バイト)となるように指定してください。また,ファイルURLから切り出したファイル名長は,1~255(バイト)としてください。
  • pTargetPath
    コンテントの登録先となるサーバマシン上のディレクトリのパスを指定します。pTargetPathを指定するときの注意事項を次に示します。
    ●DocumentSpace構成定義ファイルのReferenceStorageModeエントリにOriginを指定した場合
    コンテントロケーション(ContentLocationプロパティ)には,このメンバで指定された文字列に,DocumentBrokerがコンテントを管理するためのディレクトリおよびpEntryで指定されたファイル名が結合されて格納されます。このとき,"/"(半角)を区切り文字として設定します。CdbrSession::SetReferencePathで指定したコンテント格納先ベースパス,pTargetPathで指定したコンテント格納先パス,DocumentBrokerがコンテントを管理するためのディレクトリ(35バイト),およびpEntryで指定したファイル名を合わせた文字列長(パスの区切り文字も含む)が,Windowsのときは1~259(バイト),AIXのときは1~1022(バイト)となるように指定してください。
    ●DocumentSpace構成定義ファイルのReferenceStorageModeエントリにDivideを指定した場合
    コンテントロケーション(ContentLocationプロパティ)には,このメンバで指定された文字列に,DocumentBrokerがコンテントを管理するためのディレクトリおよびDocumentBrokerが指定するファイル名が結合されて格納されます。このとき,"/"(半角)を区切り文字として設定します。CdbrSession::SetReferencePathで指定したコンテント格納先ベースパス,pTargetPathで指定したコンテント格納先パス,DocumentBrokerがコンテントを管理するためのディレクトリ(6バイト),およびDocumentBrokerが指定するファイル名(最大59バイト)を合わせた文字列長(パスの区切り文字も含む)が,Windowsのときは1~259(バイト),AIXのときは1~1022(バイト)となるように指定してください。
    また,ファイルURLから切り出したファイル名長は,1~255(バイト)としてください。なお,文書空間で使用する文字コード種別がUTF-8の場合,印刷可能なASCIIコードで記述できる値を指定してください。
  • pDeleteRootPath
    文書を削除する場合,登録したコンテントの削除と同時にコンテントを格納したディレクトリを削除するときは,削除するディレクトリのルートパスを指定します。ただし,この指定は,コンテントを登録したオブジェクトの場合だけ有効になります。ディレクトリの削除は,コンテントロケーションで示されるパス上の格納ディレクトリから,この引数で指定されたディレクトリの下位のディレクトリまでの間のディレクトリが,削除の対象となります。最下位層のディレクトリから順に削除し,エラーとなった時点で処理を終了します。この指定が,コンテントロケーションのパスと一致していない場合,エラーになります。NULLを指定した場合,登録されているコンテントおよびDocumentBrokerがコンテントを管理するためのディレクトリが削除されます。
    パス長は,Windowsの場合1~259(バイト),AIXの場合1~1022(バイト)で指定してください。指定できるパスは,CdbrSession::SetReferencePathメソッドで指定したコンテント格納先ベースパスから,コンテント格納先ベースパスとpTargetPathで指定したコンテント格納先パス(DocumentBrokerがコンテントを管理するためのディレクトリを含まない)の間のパスです。コンテント格納先ベースパスより上位のパスおよびDocumentBrokerがコンテントを管理するためのディレクトリは指定できません。なお,文書空間で使用する文字コード種別がUTF-8の場合,印刷可能なASCIIコードで記述できる値を指定してください。
この構造体を出力するメソッド
  • CdbrDMA::RemoveObjectメソッド
  • CdbrDocument::AddRenditionメソッド
  • CdbrDocument:: ConvertContentTypeメソッド
  • CdbrDocument::CreateObjectメソッド
  • CdbrDocument::GetContentAndLockメソッド
  • CdbrDocument::UpdateContentAndRenditionTypeメソッド
  • CdbrVersionableDocument::AddRenditionメソッド
  • CdbrVersionableDocument::ConvertContentTypeメソッド
  • CdbrVersionableDocument::CreateObjectメソッド
  • CdbrVersionableDocument::GetContentAndLockメソッド
  • CdbrVersionableDocument::UpdateContentAndRenditionTypeメソッド

(16) SDBR_RELATIONINFO構造体リレーション情報構造体

説明
文書間リレーション情報の一覧を取得した場合に,個々のリレーションに関する情報が設定される構造体です。
形式

// リレーション情報構造体
struct SDBR_RELATIONINFO {
 pDmaString_T   pOIID;       //文書オブジェクトのOIID
 DmaInteger32   lType;       //オブジェクトの種別
 pDmaString_T   pRelId;      //リレーション識別子
 SDBR_PROPLIST  PropList;    //オブジェクトのプロパティリスト
 SDBR_PROPLIST  RelPropList; //リレーションのプロパティリスト
}

メンバの説明
  • pOIID
    文書を表すオブジェクトのOIIDが設定されます。
  • lType
    オブジェクトの種別を表す値として,対応するクラスライブラリのクラスを示す定数が設定されます。定数とクラスライブラリのクラスの関係は,「付録C.3 構造体で指定する定数」を参照してください。
  • pRelId
    リレーション識別子が設定されます。
  • PropList
    オブジェクトがメソッドの引数pPropDefListで指定されたプロパティを持つ場合,プロパティの識別子,型,および値の一覧が,SDBR_PROPLIST構造体として設定されます。
  • RelPropList
    リレーションがメソッドの引数pRelLinkPropDefListで指定されたプロパティを持つ場合,プロパティの識別子,型,および値の一覧が,SDBR_PROPLIST構造体として設定されます。
なお,リレーション先のオブジェクトが削除されていてリレーション情報だけが残っている場合,pOIID = NULL,lType = DBR_CLASS_UNKNOWN,PropList.lCount = 0,PropList.pItem = NULLになり,pRelIdとRelPropListだけに正当な値が設定されます。
この構造体を出力するメソッド
  • CdbrDocument::GetRelationListメソッド
  • CdbrDocument::GetRelationListAndLockメソッド
  • CdbrVersionableDocument::GetRelationListメソッド
  • CdbrVersionableDocument::GetRelationListAndLockメソッド

(17) SDBR_RELATIONLIST構造体リレーションリスト構造体

説明
文書間リレーション情報の一覧を取得した場合に,リレーション情報構造体(SDBR_RELATIONINFO構造体)の個数とそのポインタが設定される構造体です。
形式

// リレーションリスト構造体
struct SDBR_RELATIONLIST {
 DmaInteger32       lCount; //リレーションしている数
 SDBR_RELATIONINFO* pItem;  //リレーション情報構造体へのポインタ
}

メンバの説明
  • lCount
    文書間リレーション情報である,SDBR_RELATIONINFO構造体の個数が設定されます。
  • pItem
    SDBR_RELATIONINFO構造体へのポインタが設定されます。この領域は,SDBR_RELATIONINFO構造体の個数分確保されます。
この構造体を出力するメソッド
  • CdbrDocument::GetRelationListメソッド
  • CdbrDocument::GetRelationListAndLockメソッド
  • CdbrVersionableDocument::GetRelationListメソッド
  • CdbrVersionableDocument::GetRelationListAndLockメソッド

(18) SDBR_RENDITION_COMMENTINFO構造体レンディションコメント情報構造体

説明
コンテント変換格納機能を使用する場合に,追加するサブレンディションに付与するコメントの情報をコメント情報構造体で指定します。
形式

// レンディションコメント情報構造体
struct SDBR_RENDITION_COMMENTINFO {
 DmaBoolean      bIsInvestSourceComment; // 変換元コメント付与フラグ
 DmaInteger32    lInvestMode;            // コメント付与方式
 pDmaString_T    pRenditionComment;      // レンディションコメント
};

メンバの説明
  • bIsInvestSourceComment
    pRenditionCommentで指定するレンディションコメントを変換前のレンディションに付与するか,変換後のレンディションに付与するかを指定します。
    ・DMA_TRUE
    変換前のレンディションにコメントを付与します。
    ・DMA_FALSE
    変換後のレンディションにコメントを付与します。
    ユティリティ製品を使用する場合などにマスタレンディションのレンディションタイプを変更したくない場合などでは,bIsChangeMaster とbIsInvestSourceCommentの指定によりサブレンディションにコメントを付与します。
  • lInvestMode
    コメントの付与方式を指定します。
    ・DBR_INVESTMODE_APPEND
    レンディションタイプの末尾にコメントを追加します。
    ・DBR_INVESTMODE_REPLACE
    レンディションタイプの末尾にコメントがある場合,コメント部分を指定されたコメントで置き換えます。複数のコメントが存在する場合は,末尾のコメントを置き換えます。コメントがない場合は,レンディションタイプの末尾にコメントを追加します。
  • pRenditionComment
    レンディションに付与するレンディションコメントを指定します。コメントの指定には,コンテントタイプを表す文字列を指定することを推奨します。レンディションタイプとコメントの間には1バイトのスペースが設定されます。NULLを指定した場合は,DocumentBrokerが自動的にコメント(”edms-cnv”)を付与します。空文字列("")は指定できません。
    指定するコメントは,変換するレンディションのレンディションタイプの文字列長とレンディションコメントの文字列長を合わせて255バイト以内にしてください。255バイトを超えた場合は,DMARC_BAD_PARAMETERのエラーとなります。なお,レンディションコメントには,印刷可能なASCIIコードで記述できる値を指定してください。
この構造体を入力するメソッド
  • CdbrDocument:: ConvertContentTypeメソッド
  • CdbrVersionableDocument::ConvertContentTypeメソッド

(19) SDBR_RENDITIONINFO構造体レンディション情報構造体

説明
マルチレンディション文書のレンディション一覧を取得した場合に,個々のレンディションに関する情報が設定される構造体です。この構造体の配列要素の1番目に格納されるのは,マスタレンディションに関する情報です。サブレンディションの情報は二番目以降に格納されます。
形式

// レンディション情報構造体
struct SDBR_RENDITIONINFO {
 pDmaString_T  pRenditionType; //RenditionTypeを表す文字列
 SDBR_PROPLIST PropList;       //プロパティリスト構造体
};

メンバの説明
  • pRenditionType
    RenditionTypeを表す文字列が設定されます。サブレンディションのRenditionTypeは必ず設定されます。
  • PropList
    オブジェクトがメソッドの引数pPropDefListで指定されたプロパティを持つ場合,そのプロパティの個数,プロパティ識別子,型,および値の一覧が,SDBR_PROPLIST構造体として設定されます。
この構造体を出力するメソッド
  • CdbrDocument::GetRenditionListメソッド
  • CdbrDocument::GetRenditionListAndLockメソッド
  • CdbrVersionableDocument::GetRenditionListメソッド
  • CdbrVersionableDocument::GetRenditionListAndLockメソッド

(20) SDBR_RENDITIONLIST構造体レンディションリスト構造体

説明
マルチレンディション文書のレンディション一覧を取得した場合に,レンディション情報構造体(SDBR_RENDITIONINFO構造体)の個数とそのポインタが設定される構造体です。
形式

// レンディションリスト構造体
struct SDBR_RENDITIONLIST {
 DmaInteger32         lCount;  //レンディション情報の数
 SDBR_RENDITIONINFO*  pItem;   //レンディション情報構造体
};

メンバの説明
  • lCount
    取得したレンディション情報構造体である,SDBR_RENDITIONINFO構造体の個数が設定されます。
  • pItem
    レンディション情報構造体(SDBR_RENDITIONINFO構造体)の配列の先頭アドレスが設定されます。この領域は,SDBR_RENDITIONINFO構造体の個数分確保されます。
この構造体を出力するメソッド
  • CdbrDocument::GetRenditionListメソッド
  • CdbrDocument::GetRenditionListAndLockメソッド
  • CdbrVersionableDocument::GetRenditionListメソッド
  • CdbrVersionableDocument::GetRenditionListAndLockメソッド

(21) SDBR_VROBJINFO構造体バージョン識別子付きオブジェクト情報構造体

説明
指定したオブジェクトを1バージョンとして包含しているバージョン管理オブジェクト(CdbrVersionableクラスのサブクラスのオブジェクト)の一覧を取得する時に,そのバージョン管理オブジェクトの情報が設定される構造体です。同時に,メソッドをコールしたオブジェクトがバージョン管理オブジェクトのどのバージョンに当たるかを示すバージョン識別子も取得できます。
形式

// バージョン識別子付きオブジェクト情報構造体
struct SDBR_VROBJINFO {
 pDmaString_T     pOIID;        // オブジェクトのOIID
 DmaInteger32     lType;        // オブジェクトの種別
 pDmaString_T     pVersionId;   // バージョン識別子
 SDBR_PROPLIST    PropList;     // プロパティリスト構造体
};

メンバの説明
  • pOIID
    オブジェクトのOIIDが設定されます。
  • lType
    オブジェクトの種別を表す値として,対応するクラスライブラリのクラスを示す定数が設定されます。定数とクラスライブラリのクラスの関係は,「付録C.3 構造体で指定する定数」を参照してください。
  • pVersionId
    バージョン識別子が設定されます。
  • PropList
    オブジェクトがメソッドの引数で指定されたプロパティを持つ場合,プロパティリスト(SDBR_PROPLIST構造体)が設定されます。
この構造体を出力するメソッド
  • CdbrDocument::GetVersionableListメソッド
  • CdbrDocument::GetVersionableListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVersionableListメソッド
  • CdbrVersionTraceableContainer::GetVersionableListAndLockメソッド

(22) SDBR_VROBJLIST構造体バージョン識別子付きオブジェクトリスト構造体

説明
バージョン識別子付きオブジェクト情報構造体(SDBR_VROBJINFO構造体)の個数とポインタが設定される構造体です。
形式

// バージョン識別子付きオブジェクトリスト構造体
struct SDBR_VROBJLIST {
 DmaInteger32       lCount;
 SDBR_VROBJINFO*    pItem;
};

メンバの説明
  • lCount
    バージョン識別子付きオブジェクト構造体である,SDBR_VROBJINFO構造体の個数が設定されます。
  • pItem
    SDBR_VROBJINFO構造体へのポインタが設定されます。この領域はSDBR_VROBJINFO構造体の個数分確保されます。
この構造体を出力するメソッド
  • CdbrDocument::GetVersionableListメソッド
  • CdbrDocument::GetVersionableListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVersionableListメソッド
  • CdbrVersionTraceableContainer::GetVersionableListAndLockメソッド

(23) SDBR_VTLINKEDOBJINFO構造体構成管理リンク付きオブジェクト情報構造体

説明
バージョン付きコンテナが構成管理しているオブジェクトと,そのオブジェクトを関連づけているリンクの情報が設定される構造体です。
形式

struct SDBR_VTLINKEDOBJINFO{
 pDmaString_T  pOIID;        //オブジェクトのOIID
 pDmaString_T  pVerOIID;     //バージョントレースの対象になる
                             // オブジェクトのOIID
 pDmaString_T  pLinkID;      //リンク識別子
 DmaInteger32  lTraceMode;   //構成管理モード
 DmaInteger32  lType;        //オブジェクトの種別
 SDBR_PROPLIST PropList;     //プロパティリスト
 SDBR_PROPLIST LinkPropList; //リンクのプロパティリスト
};

メンバの説明
  • pOIID
    指している構成要素のバージョン(構成管理モードがFLOATINGモードの場合は最新のバージョン,FIXモードの場合は固定のバージョン)に対応するオブジェクトのOIIDが設定されます。DMAオブジェクトでは,DocVersionオブジェクトのOIIDまたはContainerVersionオブジェクトのOIIDに該当します。
  • pVerOIID
    構成要素のOIIDが設定されます。DMAオブジェクトでは,ConfigurationHistoryオブジェクトのOIIDに該当します。
  • pLinkID
    対応する構成管理型の関連づけのリンク識別子が設定されます。
  • lTraceMode
    オブジェクトのバージョンが固定されているかどうかが設定されます。バージョンが固定されている(FIXモード)場合はDBR_MODE_FIXが,バージョンが固定されていない(FLOATINGモード)場合はDBR_MODE_UNFIXが設定されます。
  • lType
    オブジェクトの種別を表す値として,対応するクラスライブラリのクラスを示す定数が設定されます。定数とクラスライブラリのクラスの関係は,「付録C.3 構造体で指定する定数」を参照してください。
  • PropList
    オブジェクトがメソッドの引数で指定したプロパティを持つ場合,プロパティ情報のリスト(SDBR_PROPLIST構造体)が設定されます。
  • LinkPropList
    リンクがメソッドの引数で指定したプロパティを持つ場合,プロパティ情報のリスト(SDBR_PROPLIST構造体)が設定されます。
この構造体を出力するメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListAndLockメソッド

(24) SDBR_VTLINKEDOBJLIST構造体構成管理リンク付きオブジェクトリスト構造体

説明
バージョン付きコンテナが構成管理をしているオブジェクトの情報と関連づけているリンクの情報を参照するときに,構成管理リンク付きオブジェクト情報構造体(SDBR_VTLINKEDOBJINFO構造体)の個数とポインタが設定される構造体です。
形式

struct SDBR_VTLINKEDOBJLIST{
 DmaInteger32          lCount; //リンク付きオブジェクト情報の個数
 SDBR_VTLINKEDOBJINFO* pItem;  //リンク付きオブジェクト情報
};

メンバの説明
  • lCount
    取得したSDBR_VTLINKEDOBJLIST構造体の個数が格納されます。
  • pItem
    SDBR_VTLINKEDOBJINFO構造体の先頭のアドレスへのポインタが格納されます。このとき,lCountに設定されたSDBR_VTLINKEDOBJINFO構造体の個数分の領域が確保されます。
この構造体を出力するメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListAndLockメソッド

(25) SDBR_VTOBJINFO構造体構成管理オブジェクト情報構造体

説明
バージョン付きコンテナが構成管理しているオブジェクトの情報が設定される構造体です。
形式

struct SDBR_VTOBJINFO{
 pDmaString_T  pOIID;      //オブジェクトのOIID
 pDmaString_T  pVerOIID;   //バージョントレースの対象になる
                           // オブジェクトのOIID
 pDmaString_T  pLinkID;    //オブジェクトのリンク識別子
 DmaInteger32  lTraceMode; //構成管理モード
 DmaInteger32  lType;      //オブジェクトの種別
 SDBR_PROPLIST PropList;   //プロパティ情報のリスト
};

メンバの説明
  • pOIID
    指している構成要素のバージョン(構成管理モードがFLOATINGモードの場合は最新のバージョン,FIXモードの場合は固定のバージョン)に対応するオブジェクトのOIIDが設定されます。DMAオブジェクトでは,DocVersionオブジェクトのOIIDまたはContainerVersionオブジェクトのOIIDに該当します。
  • pVerOIID
    構成要素のOIIDが設定されます。DMAオブジェクトでは,ConfigurationHistoryオブジェクトのOIIDに該当します。
  • pLinkID
    対応する構成管理型の関連づけのリンク識別子が設定されます。
  • lTraceMode
    オブジェクトのバージョンが固定されているかどうかが設定されます。バージョンが固定されている(FIXモード)場合はDBR_MODE_FIXが,バージョンが固定されていない(FLOATINGモード)場合はDBR_MODE_UNFIXが設定されます。
  • lType
    オブジェクトの種別を表す値として,対応するクラスライブラリのクラスを示す定数が設定されます。定数とクラスライブラリのクラスの関係は,「付録C.3 構造体で指定する定数」を参照してください。
  • PropList
    オブジェクトがメソッドの引数で指定したプロパティを持つ場合,プロパティリスト構造体(SDBR_PROPLIST構造体)が設定されます。
この構造体を出力するメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListAndLockメソッド

(26) SDBR_VTOBJLIST構造体構成管理オブジェクトリスト構造体

説明
バージョン付きコンテナが構成管理しているオブジェクトの情報を参照するときに,オブジェクト情報構造体(SDBR_VTOBJINFO構造体)の個数とポインタが設定される構造体です。
形式

struct SDBR_VTOBJLIST{
 DmaInteger32    lCount; //構成管理オブジェクト情報の個数
 SDBR_VTOBJINFO* pItem;  //構成管理オブジェクト情報
};

メンバの説明
  • lCount
    取得したSDBR_VTOBJINFO構造体の個数が格納されます。
  • pItem
    SDBR_VTOBJINFO構造体の先頭のアドレスへのポインタが設定されます。このとき,lCountに設定されたSDBR_VTOBJINFO構造体の個数分の領域が確保されます。
この構造体を出力するメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListメソッド
  • CdbrConfiguratedReferentialContainer::GetVTContaineeListAndLockメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListメソッド
  • CdbrVersionTraceableContainer::GetVTContaineeListAndLockメソッド