ここでは，ユーザ管理システムのアクセスルーチンとしてDocumentBrokerが定めている関数の形式および仕様について説明します。DocumentBrokerで提供する関数を使用して，運用中のユーザ管理システムにアクセスできるようにアクセスルーチンを作成してください。DocumentBrokerがUOCで提供する関数の一覧を次の表に示します。

なお，DocumentBrokerでは，サンプルとしてUOCを使用するための関数の例およびUOCライブラリのmakeファイルを提供しています。これらは，"インストールディレクトリ\Server\sample\libdsuoc"に格納されています。

表F-1　DocumentBrokerがUOCで提供する関数の一覧

関数	機能
dbrinitLibrary	UOCライブラリの初期化
dbrinitSession	UOCセッションの初期化
dbrAuthenticateUser	ユーザとパスワードのチェック
dbrGetUserInformation	ユーザ情報の取得
dbrFinalizeSession	UOCセッションの破棄
dbrFinalizeLibrary	UOCライブラリの破棄
dbrSetDocSpaceCharacterSet	文書空間の文字コード種別の設定

各関数の詳細では，次に示す項目について説明します。

機能

関数の概要を記述しています。

形式

関数の概要を記述しています。/* */内にコメントを記述しています。

機能説明

関数の機能の詳細を記述しています。

引数

引数について次のように記述しています。

引数（入力）

指定する値についての説明

引数（出力）

指定する領域の説明

指定した領域に設定される値の説明

• 引数は，「形式」で記述した文字列です。
• （入力）は，ユーザが値を指定することを示しています。
• （出力）は，ユーザが，DocumentBrokerによって設定される値を格納する領域を指定することを示しています。

戻り値

関数を呼び出して，正常な場合に返される値，およびエラーが発生した場合に返される主な値を列挙しています。

注意事項

関数を使用する場合の注意事項を記述しています。

＜この節の構成＞

付録F.1　dbrinitLibrary

付録F.2　dbrinitSession

付録F.3　dbrAuthenticateUser

付録F.4　dbrGetUserInformation

付録F.5　dbrFinalizeSession

付録F.6　dbrFinalizeLibrary

付録F.7　dbrSetDocSpaceCharacterSet