2.2.9 createReferencePathInfoリファレンスファイル文書のパス情報オブジェクトの作成

<この項の構成>
(1) 機能
(2) 形式
(3) 引数
(4) 戻り値
(5) 例外

(1) 機能

リファレンスファイル文書のパス情報オブジェクトを作成し,そのインターフェース(DbjReferencePathInfoインターフェース)を取得します。

形式1では,オブジェクトのメンバにデフォルト値が入ります。形式2では,オブジェクトの初期値を引数で指定できます。オブジェクトの初期値として設定できるパラメタの詳細については,「3.14 DbjReferencePathInfoインターフェース」を参照してください。なお,引数に指定する値の妥当性は検証されません。

(2) 形式

(a) 形式1

DbjReferencePathInfo createReferencePathInfo()

(b) 形式2

DbjReferencePathInfo createReferencePathInfo(
       int           contentOperateMode,
       String        entry,
       String        targetPath,
       String        deleteRootPath )

(3) 引数

contentOperateMode(入力)
contentOperateModeプロパティの初期値を指定します。
entry(入力)
entryプロパティの初期値を指定します。
targetPath(入力)
targetPathプロパティの初期値を指定します。なお,文書空間で使用する文字コード種別がUTF-8の場合に指定できる値は,印刷が可能なASCIIコードだけです。
deleteRootPath(入力)
deleteRootPathプロパティの初期値を指定します。なお,文書空間で使用する文字コード種別がUTF-8の場合に指定できる値は,印刷が可能なASCIIコードだけです。

(4) 戻り値

リファレンスファイル文書のパス情報インターフェース(DbjReferencePathInfoインターフェース)

(5) 例外

なし