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.hCdbrConfiguratedReferentialContainerクラスの定義
DBR_Common.h共通のマクロの定義
DBR_CommonStruct.h構造体についての共通の定義
DBR_Compound.hCdbrCompoundクラスの定義
DBR_Containable.hCdbrContainableクラスの定義
DBR_Core.hCdbrCoreクラスの定義
DBR_Delete.h構造体メモリの解放関数の定義
DBR_DMA.hCdbrDMAクラスの定義
DBR_Document.hCdbrDocumentクラスの定義
DBR_ErrorCode.hエラーコードの定義
DBR_EqlStatement.hCdbrEqlStatementクラスの定義
DBR_IndependentPersistence.hCdbrIndependentPersistenceクラスの定義
DBR_PublicACL.hCdbrPublicACLクラスの定義
DBR_QueryStruct.h検索に使用する構造体の定義
DBR_Rfct.hCdbrReferentialContainerクラスの定義
DBR_Session.hCdbrSessionクラスの定義
DBR_Tools.hクラスライブラリが提供する関数の定義
DBR_VArray.hCdbrVariableArrayクラスの定義
DBR_Versionable.hCdbrVersionableクラスの定義
DBR_Vrdoc.hCdbrVersionableDocumentクラスの定義
DBR_Vtct.hCdbrVersionTraceableContainerクラスの定義
DBR_XmlTranslator.hCdbrXmlTranslatorクラスの定義
DBR_XmlTranslatorFactory.hCdbrXmlTranslatorFactoryクラスの定義

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と連携して動作する環境では,ディレクトリを追加する必要はありません。