3.8.2 記述規則
プラグイン環境設定ファイルの記述規則を次に示します。
- 規則
- セクション名やエントリは1行で記述します。
- 文字列の後ろに半角空白またはタブを含めることができます。
- 使用できる改行コードは(0x0d0a)です。
- 英字の大文字と小文字は区別されます。
- シャープ(#)で始まる行はコメント行になります。
- 一つのセクションに複数のエントリを指定できるエントリ以外は,同じエントリが複数存在する場合には,最上位の指定が有効になります(ワーニングメッセージKMBV12207-Wが出力されます)。
- 同じRenditionTypeエントリの値が複数のセクションで存在する場合は,最上位の指定が有効になります(ワーニングメッセージKMBV12207-Wが出力されます)。
- 同じ[filterE_XXXX]セクションが複数存在する場合は,最上位の指定が有効になります(ワーニングメッセージKMBV12208-Wが出力されます)。例えば,filterE_0001を二つ指定した場合は,最初に指定したfilterE_0001が有効になります。filterE_0001とfilterE_0002を指定した場合は,どちらも有効です。
- [filterE_XXXX]セクションのXXXXは,0000~9999の範囲で指定します。この範囲を超えた値を指定した場合はエラーとなります(エラーメッセージKMBV12203-Eが出力されます)。
- フィルタプラグイン機能を使用しないときでも,次の場合にはエラーとなります(エラーメッセージKMBV12202-Eが出力されます)。
- プラグイン環境設定ファイルを削除した場合
- プラグイン環境設定ファイルに読み取り権限がない場合
- 0バイトのファイルを作成した場合
- <この項の構成>
- (1) [filterE_XXXX]セクション
- (2) [function]セクション
(1) [filterE_XXXX]セクション
[filterE_XXXX]セクション名には,RenditionTypeエントリの値に一致する文書のテキスト抽出後に定義ファイルで指定したフィルタ拡張子を指定します。このセクションには,次のエントリを定義します。
(a) Library
- 形式
Library = テキスト抽出フィルタプラグインライブラリ
- 指定方法
- テキストインデクサーが定義するフィルタ呼び出しインタフェースに従ったテキスト抽出フィルタプラグインライブラリを,255バイト以内のフルパス名で指定します。
- 半角空白を含むパス名を指定する場合は,パス名を"で囲んでください。
- この指定は省略できません。
- テキスト抽出フィルタプラグインライブラリを256バイト以上で指定した場合は,エラーメッセージKMBV12205-Eが出力されます。
- このエントリに指定したテキスト抽出フィルタプラグインライブラリおよびフィルタプラグイン関数(dbrIdxTextFilter)のローディングに失敗した場合は,ワーニングメッセージKMBV12252-WまたはエラーメッセージKMBV12308-Eが出力されます。
(b) DataMode
- 形式
DataMode = [MEMORY|FILE]
- 指定方法
- テキストインデクサーとテキスト抽出フィルタプラグインライブラリとのデータの受け渡し方法を指定します。
MEMORY:メモリ上でデータを受け渡す
FILE:ファイルでデータを受け渡す
- この指定は省略できます。省略した場合は,「MEMORY」が仮定されます。
- 不正な値(「MEMORY」および「FILE」以外の値)を指定した場合は,エラーメッセージKMBV12205-Eを出力します。
(2) [function]セクション
[function]セクションには,RenditionTypeエントリに指定した文書のテキスト抽出後にプロパティ値取得用プラグインライブラリを動作させる場合に指定します。このセクションは,複数指定できます。
指定するエントリを次に示します。
(a) RenditionType
- 形式
RenditionType = RenditionType名
- 指定方法
- 処理対象クラスのRenditionTypeプロパティから「MIME::」を取り除いたものを,255バイト以内で指定します。
- この指定は省略できません。
- 不正な値(256バイト以上の名称)を指定した場合は,エラーメッセージKMBV12205-Eを出力します。
(b) Library
- 形式
Library = プロパティ値取得用プラグインライブラリ
- 指定方法
- テキストインデクサーが定義するプロパティ値の取得呼び出しインタフェースに従った,プロパティ値取得用プラグインライブラリを,255バイト以内のフルパス名で指定します。
- パス名に半角空白文字を含む場合は,パス名をダブルクォーテーションで囲んで指定してください。このとき,パス名はダブルクォーテーションを含めないで255バイト以内としてください。
- この指定は省略できません。
- 不正な値(256バイト以上のパス名)を指定した場合は,エラーメッセージKMBV12005-Eを出力します。
- 指定したプロパティ値取得用プラグインライブラリのローディングに失敗した場合は,ワーニングメッセージKMBV12254-WまたはエラーメッセージKMBV12309-Eが出力されます。
(c) Function
- 形式
Function = 関数名
- 指定方法
- テキストインデクサーが定義するプロパティ値の取得呼び出しインタフェースに従った関数の関数名を,128バイト以内で指定します。
- この指定は省略できません。
- 不正な値(129バイト以上の関数名)を指定した場合は,エラーメッセージKMBV12205-Eを出力します。
(d) Argv
- 形式
Argv = 文書オブジェクトのユーザプロパティのプロパティ名
- 指定方法
- 文書オブジェクトのユーザプロパティのプロパティ名を128バイト以内で指定します。
- 指定できるプロパティのデータ型は,String,Integer32,Booleanの3種類です。
- 複数のプロパティを取得する場合は,取得したい数だけArgvエントリを指定してください。
- この指定は省略できません。
- 129バイト以上のプロパティ名を指定した場合はエラーメッセージKMBV12205-Eを,存在しないプロパティ名を指定した場合はエラーメッセージKMBV12009-Eを出力します。