はじめに

uCosminexus DocumentBroker Version 3　クラスライブラリ　C++　リファレンス　基本機能編

はじめに

このマニュアルは，次に示すプログラムプロダクトで提供するクラスライブラリのクラスの詳細とメソッドの文法について説明したものです。

このマニュアルは，次に示す章と付録から構成されています。

第1章　クラスライブラリのクラス，メソッドおよび関数: クラスライブラリで提供するクラス，メソッドおよび関数を簡単な機能概略付きの一覧表形式で説明しています。

第2章　クラスライブラリで使用するデータ型とクラスおよびメソッドの記述形式: クラスライブラリのリファレンスマニュアルで使用するデータ型の定義，およびクラス，メソッドの記述形式（ページレイアウト）について説明しています。

第3章　CdbrCompoundクラス（複合データを扱うクラス）: CdbrCompoundクラスの詳細とメソッドの文法について説明しています。

第4章　CdbrConfiguratedReferentialContainerクラス（バージョン付き構成管理コンテナを扱うクラス）: CdbrConfiguratedReferentialContainerクラスの詳細とメソッドの文法について説明しています。

第5章　CdbrContainableクラス（包含要素を扱うクラス）: CdbrContainableクラスの詳細とメソッドの文法について説明しています。

第6章　CdbrCoreクラス（エラー情報を取得するクラス）: CdbrCoreクラスの詳細とメソッドの文法について説明しています。

第7章　CdbrDMAクラス（OIIDの設定やプロパティを扱うクラス）: CdbrDMAクラスの詳細とメソッドの文法について説明しています。

第8章　CdbrDocumentクラス（バージョンなし文書を扱うクラス）: CdbrDocumentクラスの詳細とメソッドの文法について説明しています。

第9章　CdbrEqlStatementクラス（edmSQL文を操作，実行するクラス）: CdbrEqlStatementクラスの詳細とメソッドの文法について説明しています。

第10章　CdbrIndependentPersistenceクラス（独立データを扱うクラス）: CdbrIndependentPersistenceクラスの詳細とメソッドの文法について説明しています。

第11章　CdbrPublicACLクラス（パブリックACLを扱うクラス）: CdbrPublicACLクラスの詳細とメソッドの文法について説明しています。

第12章　CdbrReferentialContainerクラス（バージョンなしコンテナを扱うクラス）: CdbrReferentialContainerクラスの詳細とメソッドの文法について説明しています。

第13章　CdbrSessionクラス（セッションを確立するクラス）: CdbrSessionクラスの詳細とメソッドの文法について説明しています。

第14章　CdbrVariableArrayクラス（可変長配列を扱うクラス）: CdbrVariableArrayクラスの詳細とメソッドの文法について説明しています。

第15章　CdbrVersionableクラス（バージョン管理機能を提供するクラス）: CdbrVersionableクラスの詳細とメソッドの文法について説明しています。

第16章　CdbrVersionableDocumentクラス（バージョン付き文書を扱うクラス）: CdbrVersionableDocumentクラスの詳細とメソッドの文法について説明しています。

第17章　CdbrVersionTraceableContainerクラス（バージョンなし構成管理コンテナを扱うクラス）: CdbrVersionTraceableContainerクラスの詳細とメソッドの文法について説明しています。

第18章　CdbrXmlTranslatorクラス（XML変換を扱うクラス）: CdbrXmlTranslatorクラスの詳細とメソッドの文法について説明しています。

第19章　CdbrXmlTranslatorFactoryクラス（XMLの操作環境を管理するクラス）: CdbrXmlTranslatorFactoryクラスの詳細とメソッドの文法について説明しています。

第20章　関数: クラスライブラリが提供する関数について説明しています。

付録A　コーディング例: クラスライブラリの機能を使用してクライアントアプリケーションを作成する場合のコーディング例について説明しています。

付録B　DMAオブジェクトのプロパティ: DMAオブジェクトが保持しているプロパティのうち，クラスライブラリによって操作できるプロパティについて説明しています。

付録C　クラスライブラリのメソッドで使用する構造体: クラスライブラリのメソッドを使用するときに，オブジェクトに設定する情報を指定したり既存のオブジェクトの情報を取得したりするために使用する構造体について説明しています。

付録D　メソッドの実行に必要なパーミッション（アクセス制御機能を使用する場合）: アクセス制御機能を使用する場合に，それぞれのメソッドをコールするときに必要なパーミッションについて説明しています。

付録E　メソッド実行時の排他制御（ロック）: クラスライブラリのメソッドの実行時に明示的に設定できるロックと暗黙で設定されるロックについて説明しています。

付録F　OIID指定時のURLの文法: OIIDの形式およびOIIDを指定するときのURLの文法について説明しています。

付録G　文書空間で使用する文字コード種別がUTF-8の場合に使用できるメソッドと関数: クラスライブラリのメソッドおよび関数で文字コード種別「UTF-8」をサポートしている範囲について説明しています。

付録H　戻り値一覧: クラスライブラリのメソッドを発行したときに返される戻り値について，一覧形式で説明しています。

付録I　障害が発生した時にDocumentBrokerが出力する情報: 障害が発生した時にuCosminexus DocumentBrokerが出力する情報の出力先などについて説明しています。

付録J　用語解説: uCosminexus DocumentBroker Version 3で使用する用語について説明しています。

このマニュアルは次のマニュアルと関連がありますので，必要に応じてお読みください。なお，本文に記載のマニュアル名称は，「uCosminexus DocumentBroker」を「DocumentBroker」と表記しています。

uCosuminexus DocumentBrokerのマニュアル

DocumentBroker Version 3　システム導入・運用ガイド（3000-3-D01）

uCosminexus DocumentBroker Version 3　システム導入・運用ガイド（3020-3-U71）: uCosminexus DocumentBrokerを使用する環境を定義，管理および運用する場合に参照してください。; UNIXの場合は，資料番号が3000-3-D01のマニュアルを参照してください。; Windowsの場合は，資料番号が3020-3-U71のマニュアルを参照してください。

uCosminexus DocumentBroker Version 3　クラスライブラリ　C++　解説（3000-3-F13）: クラスライブラリの機能と，クラスライブラリを使用するために必要なオブジェクトモデルについて知りたい場合に参照してください。

uCosminexus DocumentBroker Version 3　メッセージ（3000-3-F12）: uCosminexus DocumentBrokerが出力するメッセージについて知りたい場合に参照してください。

DocumentBroker Rendering Option Version 3（3020-3-N47）: Adobe Acrobat Distillerと連携したDocumentBroker Rendering Optionの機能，環境設定，およびコマンドの文法について知りたい場合に参照してください。

DocumentBroker Rendering Option Version 3　（活文PDFstaff編）（3020-3-N49）: PDFstaff RuntimeおよびPDFstaff SDKと連携したDocumentBroker Rendering Optionの機能，環境設定，およびコマンドの文法について知りたい場合に参照してください。

uCosminexus DocumentBroker Text Search Index Loader Version 3（3020-3-U72）: uCosminexus DocumentBrokerに格納されている文書からテキスト情報を抽出して，全文検索用のインデクスファイルを作成し，これを全文検索インデクスに登録するユティリティについて知りたい場合に参照してください。

関連製品のマニュアル（HiRDB）

スケーラブルデータベースサーバ　HiRDB Version 6　SQLリファレンス（UNIX(R)/Windows(R)用）（3000-6-237）^※¹
スケーラブルデータベースサーバ　HiRDB Version 6　SQLリファレンス（Windows(R)用）（3020-6-127）^※¹
スケーラブルデータベースサーバ　HiRDB Version 7　SQLリファレンス（UNIX(R)/Windows(R)用）（3000-6-277）^※¹
スケーラブルデータベースサーバ　HiRDB Version 7　SQLリファレンス（Windows(R)用）（3020-6-277）^※¹
スケーラブルデータベースサーバ　HiRDB Version 8　SQLリファレンス（3020-6-357）^※¹
HiRDBデジタルコンテンツアクセスプラグイン　HiRDB File Link（UNIX(R)用）（3000-6-253）^※²
HiRDBデジタルコンテンツアクセスプラグイン　HiRDB File Link（Windows(R)用）（3020-6-141）^※²

関連製品のマニュアル（その他）

VisiBroker Version 3 VisiBroker for C++　プログラマーズガイド（3000-3-651）^※³
VisiBroker Version 3 VisiBroker for C++　プログラマーズガイド（Windows(R)用）（3000-3-678）^※³

注※1: このマニュアルでは，これらのマニュアルを「HiRDB　SQLリファレンス」と表記しています。

注※2: このマニュアルでは，これらのマニュアルを「HiRDB File Link」と表記しています。

注※3: このマニュアルでは，これらのマニュアルを「VisiBroker for C++　プログラマーズガイド」と表記しています。

このマニュアルは，利用目的に合わせて章を選択してお読みいただけます。次に示す表を参考にして，お読みになる章を選択してください。

このマニュアルを読む目的		記述個所
どんなクラスやメソッド，関数があるのかを知りたい。	クラスライブラリのクラス，メソッドおよび関数	1章
	クラス一覧	1.1節
	メソッド一覧	1.2節
	関数一覧	1.3節
クラスライブラリで使用するデータ型やリファレンスマニュアルの記述形式を知りたい。	クラスライブラリで使用するデータ型とクラスおよびメソッドの記述形式	2章
	クラスライブラリで使用するデータ型	2.1節
	クラスおよびメソッドの記述形式	2.2節
各クラスの詳細とメソッドの文法について知りたい。	CdbrCompoundクラス（複合データを扱うクラス）	3章
	CdbrConfiguratedReferentialContainerクラス（バージョン付き構成管理コンテナを扱うクラス）	4章
	CdbrContainableクラス（包含要素を扱うクラス）	5章
	CdbrCoreクラス（エラー情報を取得するクラス）	6章
	CdbrDMAクラス（OIIDの設定やプロパティを扱うクラス）	7章
	CdbrDocumentクラス（バージョンなし文書を扱うクラス）	8章
	CdbrEqlStatementクラス（edmSQL文を操作，実行するクラス）	9章
	CdbrIndependentPersistenceクラス（独立データを扱うクラス）	10章
	CdbrPublicACLクラス（パブリックACLを扱うクラス）	11章
	CdbrReferentialContainerクラス（バージョンなしコンテナを扱うクラス）	12章
	CdbrSessionクラス（セッションを確立するクラス）	13章
	CdbrVariableArrayクラス（可変長配列を扱うクラス）	14章
	CdbrVersionableクラス（バージョン管理機能を提供するクラス）	15章
	CdbrVersionableDocumentクラス（バージョン付き文書を扱うクラス）	16章
	CdbrVersionTraceableContainerクラス（バージョンなし構成管理コンテナを扱うクラス）	17章
	CdbrXmlTranslatorクラス（XML変換を扱うクラス）	18章
	CdbrXmlTranslatorFactoryクラス（XMLの操作環境を管理するクラス）	19章
関数の詳細を知りたい。	関数	20章
コーディング例を見たい。	コーディング例	付録A
	作成するコーディング例	A.1
	コーディング例	A.2
DMAオブジェクトのプロパティについて知りたい。	DMAオブジェクトのプロパティ	付録B
	DMAのクラスのプロパティ一覧	B.1
	プロパティの説明	B.2
メソッドで使用する構造体について知りたい。	クラスライブラリのメソッドで使用する構造体	付録C
	オブジェクトの情報を設定，参照する構造体	C.1
	検索に使用する構造体	C.2
	構造体で指定する定数	C.3
メソッドの実行に必要なパーミッションについて知りたい。	メソッドの実行に必要なパーミッション（アクセス制御機能を使用する場合）	付録D
	パーミッション一覧で使用する記号	D.1
	メソッドの実行に必要なパーミッション一覧	D.2
メソッド実行時の排他制御（ロック）について知りたい。	メソッド実行時の排他制御（ロック）	付録E
	メソッド実行時の明示的なロックと暗黙のロック	E.1
	メソッド実行時のロック一覧	E.2
OIID指定時のURLの文法について知りたい。	OIID指定時のURLの文法	付録F
文書空間で使用する文字コード種別がUTF-8の場合に使用できるメソッドおよび関数について知りたい。	文書空間で使用する文字コード種別がUTF-8の場合に使用できるメソッドと関数	付録G
クラスライブラリの戻り値について知りたい。	戻り値一覧	付録H
	クラスライブラリの戻り値	H.1
	DMAの戻り値	H.2
	クラスライブラリ独自の戻り値（ERR_DBRの場合）	H.3
	データベースエラーが発生した場合の戻り値（ERR_DBの場合）	H.4
	詳細メッセージの出力について	H.5
障害が発生した時にuCosminexus DocumentBrokerが出力する情報について知りたい。	障害が発生した時にuCosminexus DocumentBrokerが出力する情報	付録I
uCosminexus DocumentBrokerの用語を知りたい。	用語解説	付録J

このマニュアルでは，製品名称を次に示す略称で表記しています。

製品名称	略称
AIX 5L V5.1	AIX
AIX 5L V5.2
AIX 5L V5.3
uCosminexus DocumentBroker Development Kit Version 3	DocumentBroker
uCosminexus DocumentBroker Runtime Version 3
uCosminexus DocumentBroker Server Version 3
uCosminexus DocumentBroker Development Kit Version 3	DocumentBroker Development Kit
uCosminexus DocumentBroker Runtime Version 3	DocumentBroker Runtime
uCosminexus DocumentBroker Server Version 3	DocumentBrokerサーバ
HiRDB/Single Server Version 6	HiRDB
HiRDB/Single Server Version 7
HiRDB/Single Server Version 8
HiRDB/Parallel Server Version 6
HiRDB/Parallel Server Version 7
HiRDB/Parallel Server Version 8
HiRDB Adapter for XML - Enterprise Edition	HiRDB Adapter for XML
HiRDB Adapter for XML - Standard Edition	HiRDB Adapter for XML
TPBroker Developer for C++	TPBroker
TPBroker for C++
TPBroker
Microsoft(R) Windows Server(R) 2003, Enterprise Edition 日本語版	Windows Server 2003
Microsoft(R) Windows Server(R) 2003, Standard Edition 日本語版	Windows Server 2003
Microsoft(R) Windows Server(R) 2003 R2, Enterprise Edition 日本語版	Windows Server 2003 R2
Microsoft(R) Windows Server(R) 2003 R2, Standard Edition 日本語版	Windows Server 2003 R2
Microsoft(R) Windows Server(R) 2003 R2, Enterprise x64 Edition 日本語版	Windows Server 2003 R2またはWindows Server 2003 R2 Edition
Microsoft(R) Windows Server(R) 2003 R2, Standard x64 Edition 日本語版	Windows Server 2003 R2またはWindows Server 2003 R2 Edition
Microsoft(R) Windows Server(R) 2008 Enterprise 32-bit 日本語版	Windows Server 2008 またはWindows Server 2008 x86
Microsoft(R) Windows Server(R) 2008 Standard 32-bit 日本語版	Windows Server 2008 またはWindows Server 2008 x86
Microsoft(R) Windows Server(R) 2008 R2 Enterprise 日本語版	Windows Server 2008 R2
Microsoft(R) Windows Server(R) 2008 R2 Standard 日本語版	Windows Server 2008 R2
Microsoft(R) Windows Server(R) 2012 Standard 日本語版	Windows Server 2012
Microsoft(R) Windows Server(R) 2012 Datacenter 日本語版	Windows Server 2012
Microsoft(R) Windows(R) XP Professional Operating System	Windows XP
Microsoft(R) Windows Vista(R) Ultimate 日本語版	Windows Vista
Microsoft(R) Windows Vista(R) Business 日本語版
Microsoft(R) Windows Vista(R) Enterprise 日本語版
Microsoft(R) Windows(R) 7 Professional 日本語版 (32ビット版)	Windows 7
Microsoft(R) Windows(R) 7 Enterprise 日本語版 (32ビット版)
Microsoft(R) Windows(R) 7 Ultimate 日本語版 (32ビット版)
Microsoft(R) Windows(R) 7 Professional 日本語版 (64ビット版)
Microsoft(R) Windows(R) 7 Enterprise 日本語版 (64ビット版)
Microsoft(R) Windows(R) 7 Ultimate 日本語版 (64ビット版)
Windows(R) 8 Pro 日本語版（32ビット版）	Windows 8
Windows(R) 8 Pro 日本語版（64ビット版）
Windows(R) 8 Enterprise 日本語版（32ビット版）
Windows(R) 8 Enterprise 日本語版（64ビット版）
Microsoft(R) Office Word	Word
Microsoft(R) Word	Word
活文 PDFstaff Runtime	PDFstaff Runtime
活文 PDFstaff SDK	PDFstaff SDK

このほか，このマニュアルでは，次に示す表記方法を使用しています。

DocumentBroker Development Kitの01-21以前のバージョンについては，Version 1と表記します。
AIXをUNIXと表記することがあります。
Windows Server 2003，Windows Server 2003 R2，Windows Server 2003 R2 x64 Edition，Windows Server 2008 x86，Windows Server 2008 R2，Windows Server 2012，Windows XP，Windows Vista，Windows 7，およびWindows 8を合わせてWindowsと表記することがあります。

uCosminexus DocumentBrokerのマニュアルで使用する英略語を次に示します。

英略語	英字での表記
ACE	Access Control Element
ACFlag	Access Control Flag
ACL	Access Control List
AIIM	Association for Information and Image Management International
API	Application Programming Interface
ASCII	American Standard Code for Information Interchange
BES	Back End Server
BLOB	Binary Large Object
BMP	Bit Map
BNF	Backus Normal Form
BOA	Basic Object Adapter
CD-ROM	Compact Disc Read Only Memory
CGI	Common Gateway Interface
CORBA	Common Object Request Broker Architecture
CPU	Central Processing Unit
CR	Carriage Return
CSV	Comma Separated Value
DAP	Directory Access Protocol
DAT	Digital Audio Tape
DB	Database
DBMS	Database Management System
DCD	Document Content Description
DDE	Dynamic Data Exchange
DIT	Directory Information Tree
DLL	Dynamic Linking Library
DMA	Document Management Alliance
DN	Distinguished Name
EOF	End of File
ESIS-B	Element Structure Information Set-Binary Format
EUC	Extended UNIX Code
FAM	File Access Module
GIF	Graphics Interchange Format
GUI	Graphical User Interface
GUID	Globally Unique Identifier
HTML	Hypertext Markup Language
HTTP	Hypertext Transfer Protocol
IANA	Internet Assigned Numbers Authority
ID	Identifier
IPF	Itanium(R) Processor Family
ISO	International Organization for Standardization
JIS	Japanese Industrial Standards
JPEG	Joint Photographic Expert Group
LAN	Local Area Network
LDAP	Lightweight Directory Access Protocol
LF	Line Feed
MFC	Microsoft Foundation Class
MIME	Multipurpose Internet Mail Extensions
OCR	Optical Character Reader
OIID	Object Instance Identifier
OLE	Object Linking and Embedding
OMG	Object Management Group
ORB	Object Request Broker
ORDB	Object Relational Database
OS	Operating System
OTS	Object Transaction Service
PC	Personal Computer
PDF	Portable Document Format
RDB	Relational Database
RDN	Relative Distinguished Name
RFC	Request for Comment
RTF	Rich Text Format
SGML	Standard Generalized Markup Language
SQL	Structured Query Language
TCP/IP	Transmission Control Protocol/Internet Protocol
TIFF	Tag Image File Format
UNC	Universal Naming Convention
UOC	User Own Coding
URL	Uniform Resource Locator
UTC	Universal Time Coordinated
UTF-8	8-bit UCS Transformation Format
W3C	World Wide Web Consortium
WWW	World Wide Web
XML	Extensible Markup Language

このマニュアルで使用する記号を次に示します。

記号	意味
｜	横に並べられた複数の項目に対する項目間の区切りを示し，「または」を意味します。（例）　A｜B 　AまたはBを指定することを示します。
＿	括弧で囲まれた複数項目のうち1項目に対し使用され，括弧内のすべてを省略したときシステムが取る標準値を示します。（例）　〔A｜B〕　「何も指定しない」か「AまたはBを指定する」ことを示します。何も指定しない場合はAが仮定されます。
｛　｝	この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの一つを選択します。（例）　｛A｜B｜C｝　A，BまたはCのどれかを指定することを示します。
〔　〕	この記号で囲まれている項目は省略してもよいことを示します。複数の項目が横に並べて記述されている場合には，すべてを省略するか，記号｛｝と同じくどれか一つを選択します。（例１）　〔A〕　「何も指定しない」か「Aを指定する」ことを示します。（例２）　〔B｜C〕　「何も指定しない」か「BまたはCを指定する」ことを示します。
：：＝	この記号の左にあるものを右にあるもので定義することを示します。（例）　A：：＝B 　「AとはBである」と定義することを示します。
…	記述が省略されていることを示します。（例）ABC… 　ABCの後ろに記述があり，その記述が省略されていることを示します。
<　>	この記号で囲まれている項目は，該当する要素を指定することを示します。（例）　<プロパティ> 　プロパティを記述します。
(　)	この記号で囲まれている項目を省略しないで記述することを示します。（例）　(<プロパティ>) 　項目<プロパティ>は省略しないで記述します。
...	この記号の直前に示す記号を繰り返し，複数個指定できることを示します。（例）　(<プロパティ>)... 　プロパティは一つ以上で複数個，繰り返して指定できます。

種類	定義
英字	A～Z　a～z
英小文字	a～z
英大文字	A～Z
数字	0～9
英数字	A～Z　a～z　0～9
記号	!　"　#　$　%　&　'　(　)　+　,　_　・　.　/　:　;　<　=　>　@　[　]　^　－　｛　｝　￣　タブ　空白

DocumentBroker Version 2とuCosminexus DocumentBroker Version 3の製品体系の違い

DocumentBroker Version 2とuCosminexus DocumentBroker Version 3のマニュアルの対応

バージョンアップおよび製品体系の変更に伴い，uCosminexus DocumentBroker Version 3では次に示すようにマニュアル名称を変更しました。

Version 2のマニュアル名称	Version 3のマニュアル名称
DocumentBroker Version 2　システム導入・運用ガイド	uCosminexus DocumentBroker Version 3　システム導入・運用ガイド
DocumentBroker Version 2　クラスライブラリ　解説	uCosminexus DocumentBroker Version 3　クラスライブラリ　C++　解説
DocumentBroker Version 2　クラスライブラリ　リファレンス　基本機能編	uCosminexus DocumentBroker Version 3　クラスライブラリ　C++　リファレンス　基本機能編
DocumentBroker Version 2　クラスライブラリ　リファレンス　概念SGML文書管理機能編	廃版
DocumentBroker Version 2　オブジェクト操作ツール	uCosminexus DocumentBroker Version 3　オブジェクト操作ツール
DocumentBroker Version 2　統計解析ツール	uCosminexus DocumentBroker Version 3　統計解析ツール
DocumentBroker Version 2　メッセージ	uCosminexus DocumentBroker Version 3　メッセージ
DocumentBroker Web Component Version 2　解説	uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　解説
DocumentBroker Web Component Version 2　リファレンス	uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　リファレンス
DocumentBroker Web Component Version 2　サンプルWebアプリケーション	uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　サンプルWebアプリケーション
DocumentBroker Text Search Index Loader Version 2	uCosminexus DocumentBroker Text Search Index Loader Version 3
DocumentBroker Rendering Option　システム導入・運用ガイド	uCosminexus DocumentBroker Rendering Option Version 3
DocumentBroker Object Loader Version 2	uCosminexus DocumentBroker Object Loader Version 3