uCosminexus DocumentBroker Version 3 クラスライブラリ C++ 解説

[目次][用語][索引][前へ][次へ]

5.2.2 ヘッダファイル

クライアントがインクルードしなければならないヘッダファイルについて説明します。

ヘッダファイルには,クラスライブラリのヘッダファイル,DMAの基本ヘッダファイルおよびDocumentBrokerの拡張ヘッダファイルがあります。

インクルードするヘッダファイルを,OSごとに説明します。

<この項の構成>
(1) ヘッダファイル(UNIXの場合)
(2) ヘッダファイル(Windowsの場合)

(1) ヘッダファイル(UNIXの場合)

DocumentBrokerのアプリケーションプログラムをクラスライブラリを使用して作成する際には,クラスライブラリのヘッダファイルをインクルードしてください。

次に,クラスライブラリのヘッダファイルについて説明します。クラスライブラリのヘッダファイルは,次のディレクトリに格納されています。

/opt/HiEDMS/ACLibrary/include
/opt/HiEDMS/client/include

クラスライブラリのヘッダファイルを次の表に示します。

表5-4 クラスライブラリのヘッダファイルの一覧

ヘッダファイル名 定義内容
DBR.h クラスライブラリで使用するすべての定義
DBR_CfgRfct.h CdbrConfiguratedReferentialContainerクラスの定義
DBR_Common.h 共通のマクロの定義
DBR_CommonStruct.h 構造体についての共通の定義
DBR_Compound.h CdbrCompoundクラスの定義
DBR_Containable.h CdbrContainableクラスの定義
DBR_Core.h CdbrCoreクラスの定義
DBR_Delete.h 構造体メモリの解放関数の定義
DBR_DMA.h CdbrDMAクラスの定義
DBR_Document.h CdbrDocumentクラスの定義
DBR_ErrorCode.h エラーコードの定義
DBR_EqlStatement.h CdbrEqlStatementクラスの定義
DBR_IndependentPersistence.h CdbrIndependentPersistenceクラスの定義
DBR_PublicACL.h CdbrPublicACLクラスの定義
DBR_QueryStruct.h 検索に使用する構造体の定義
DBR_Rfct.h CdbrReferentialContainerクラスの定義
DBR_Session.h CdbrSessionクラスの定義
DBR_Tools.h クラスライブラリが提供する関数の定義
DBR_VArray.h CdbrVariableArrayクラスの定義
DBR_Versionable.h CdbrVersionableクラスの定義
DBR_Vrdoc.h CdbrVersionableDocumentクラスの定義
DBR_Vtct.h CdbrVersionTraceableContainerクラスの定義
DBR_XmlTranslator.h CdbrXmlTranslatorクラスの定義
DBR_XmlTranslatorFactory.h CdbrXmlTranslatorFactoryクラスの定義

DBR.hは,クラスライブラリのメインヘッダファイルです。このヘッダファイルをインクルードすると,すべてのヘッダファイルをインクルードしたことになります。なお,DBR.hをインクルードする場合は,コンパイル時のインクルードパスに,次のディレクトリを追加してください。

/opt/TPBroker/include

ただし,TPBroker V5と連携して動作する環境では,ディレクトリを追加する必要はありません。

(2) ヘッダファイル(Windowsの場合)

DocumentBrokerのアプリケーションプログラムをクラスライブラリを使用して作成する際には,次のヘッダファイルをインクルードします。

まず,stdafx.hまたはwindows.hをインクルードしてから,クラスライブラリのヘッダファイルをインクルードしてください。

stdafx.hとwindows.hは,MFCを使用するかどうかで,次のように選択してください。

MFCを使用する場合
stdafx.h

それ以外の場合
windows.h

クラスライブラリのヘッダファイルは,次のディレクトリに格納されています。

<インストールディレクトリ>\include

クラスライブラリのヘッダファイルについては,「(1)ヘッダファイル(UNIXの場合)」を参照してください。なお,クラスライブラリのヘッダファイルDBR.hをインクルードする場合は,コンパイル時のインクルードパスに,次のディレクトリを追加してください。

<TPBrokerのインクルードディレクトリ>\include

ただし,TPBroker V5と連携して動作する環境では,ディレクトリを追加する必要はありません。