CdbrXmlTranslatorFactory::Initializeメソッド

機能

オブジェクトの初期化

形式

DmaBoolean Initialize(
 const DmaId*          pDocSpaceId,
 const pDmaString_T    pXmsFileName,
 ppDmaString_T         ppMessage)

詳細

指定した文書空間用に,CdbrXmlTranslatorFactoryオブジェクトを初期化するメソッドです。

このメソッドでは,指定したxmsファイル(マッピングセット定義ファイル)に基づいて,プロパティマッピング情報の読み込みと解析を実行します。xmsファイル名にNULLを指定した場合,デフォルトのxmsファイル(ファイル名"<文書空間識別子>.xms")を読み込みます。

デフォルトのxmsファイルおよびxmsファイルから参照されるxmpファイル(マッピング定義ファイル)は,原則としてUNIXの場合は<インストールディレクトリ>/client/etc/xml_files,Windowsの場合は<インストールディレクトリ>¥client¥etc¥xml_filesに配置します。

マッピング定義情報の解析には秒単位の時間がかかるので,このメソッドの実行回数が少なくなるよう,初期化したCdbrXmlTranslatorFactoryオブジェクトはプロセス内で使い回すことを推奨します。

定義情報の解析でエラーやワーニング(警告)が発生した場合,引数ppMessageにその内容を示す文字列が設定されます。

このメソッドがすでに実行されている場合,初期化済みとしてエラーになります。

引数

pDocSpaceId(入力)

対象となる文書空間識別子を指定します。指定した文書空間が実際に存在するかどうかのチェックはしません。ただし,NULLを指定した場合はエラーになります。

pXmsFileName(入力)

使用するxmsファイルを指定します。

ファイルは,UNIXの場合は<インストールディレクトリ>/client/etc/xml_files,Windowsの場合は<インストールディレクトリ>¥client¥etc¥xml_filesを起点とした相対パスか,"file:///"で始まる絶対パスを指定します。また,NULLを指定した場合,UNIXの場合は<インストールディレクトリ>/client/etc/xml_files,Windowsの場合は<インストールディレクトリ>¥client¥etc¥xml_filesにあるデフォルトのxmsファイル"<文書空間識別子>.xms"を使用して処理を実行します。

ppMessage(出力)

定義情報の解析などで発生したエラーやワーニング(警告)の詳細情報が設定されます。詳細情報を格納する領域のアドレスを指定してください。NULLを指定するとエラーになります。なお,返却する詳細情報がない場合はNULLが設定されます。ppMessageの領域は,dbrDelete関数を使ってユーザプログラムで解放してください。

NULLが設定されるかどうかはこのメソッドの戻り値に依存しません。メソッドが正常終了した場合でもNULL以外の値が設定される場合があり,また,異常終了した場合でもNULLが設定される場合があります。

取得した文字列は改行コードで区切られ,複数行で構成される場合があります。

戻り値

DMA_TRUE  正常終了

DMA_FALSE 異常終了

戻り値の詳細

major_codeminor_code説明対処
ERR_DBRERR_OBJECT_ALREADY_INITIALIZEDオブジェクトは初期化済みです。この操作は実行できません。
ERR_DBRERR_INVALID_DEFINITION定義情報が不正です。定義ファイルの内容を見直してください。
ERR_DMADMARC_BAD_PARAMETER不正な引数が入力されました。正しい引数を指定してください。
ERR_DMADMARC_NO_MEMORYメモリ不足で実行できません。メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて,処理を再実行してください。
ERR_DMADMARC_UNEXPECTED予期しないエラーが発生しました。処理を終了してください。