Text Search Filter Library Version 3

手引・文法書

3000-6-302-10

目　　次

前書き

変更内容

はじめに

1.　概要

1.1　目的

1.2　機能

1.2.1　ヒット位置情報の取得機能

1.2.2　同義語・異表記展開結果の取得機能

1.2.3　検索結果の取得機能

1.2.4　検索オプション指定機能

1.2.5　検索条件式別のヒット数取得機能

1.3　前提プログラム

1.3.1　UAP作成時に必要なプログラム

1.3.2　UAP実行時に必要なプログラム

2.　UAPの作成

2.1　提供するファイルおよびAPI関数一覧

2.1.1　ファイル一覧

2.1.2　API関数一覧

2.2　API関数の発行順序

2.2.1　ヒット位置情報取得時のAPI関数の発行順序

2.2.2　同義語・異表記展開ターム取得時のAPI関数の発行順序

2.2.3　検索結果の取得時のAPI関数の発行順序

2.2.4　検索オプション指定および検索結果取得時のAPI関数の発行順序

2.2.5　検索条件式別のヒット数取得時のAPI関数の発行順序

2.3　コンパイルおよびリンケージ

2.3.1　AIXの場合

2.3.2　Windowsの場合

2.3.3　HP-UXの場合

2.4　マルチスレッド実行機能

2.5　Text Search Filter Libraryで使用できる文字コード

2.6　検索条件式と異表記展開検索

2.6.1　検索条件式の記述形式

2.6.2　異表記展開検索

2.7　同義語辞書テキストファイル

2.7.1　同義語辞書テキストファイルとは

2.7.2　同義語辞書テキストファイルの記述形式

2.7.3　同義語辞書テキストファイルの記述例

2.8　検索オプション指定機能

2.8.1　検索オプション指定機能とは

2.8.2　検索オプション指定機能で使用できる機能

2.8.3　検索オプション指定機能の記述形式と記述例

2.8.4　文字統一機能

2.8.5　削除文字指定機能

2.9　検索時の注意事項

2.10　バージョンアップ時の注意事項

2.11　その他の注意事項

3.　API関数

TS0F_Compile（検索条件式のコンパイル）

TS0F_Compile_Ex（検索条件式のコンパイル（検索オプション指定機能対応））

TS0F_DicMake（同義語辞書の作成）

TS0F_DicMake_Ex（同義語辞書の作成（検索オプション指定機能対応））

TS0F_Free（実行結果の解放）

TS0F_GetTermNum（条件式別のヒット数の取得）

TS0F_GetTermPos（ヒット位置情報の取得）

TS0F_Mlook（同義語・異表記展開タームの取得）

TS0F_OptMake（検索オプションデータの作成）

TS0F_Search（検索結果の取得）

4.　エラーコード

4.1　エラーコードの見方

4.1.1　エラーコードの分類

4.1.2　エラーコードの記述形式

4.2　システムエラー

4.3　API関数の引数エラー

4.4　API関数実行中に発生したエラー

索引

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2006, Hitachi, Ltd.

前書き

■ 対象製品

P-1MD3-3831*　 Text Search Filter Library Version 3　 03-10（適用OS：AIX 5L V5.2，AIX 5L V5.3）
P-24D3-3834　 Text Search Filter Library Version 3　 03-10（適用OS：Windows 2000，Windows XP Professional，Windows XP x64 Edition，Windows Server 2003，Windows Server 2003 x64 Edition）
P-1BD3-3831　 Text Search Filter Library Version 3　 03-10（適用OS：HP-UX 11.0，HP-UX 11.0i，HP-UX 11.0i V2）

＊印のプログラムプロダクトについてはサポート時期をご確認ください。

■ 輸出時の注意

本製品を輸出される場合には，外国為替および外国貿易法ならびに米国の輸出管理関連法規などの規制をご確認の上，必要な手続きをお取りください。
なお，ご不明な場合は，弊社担当営業にお問い合わせください。

■ 商標類

AIXは，米国における米国International Business Machines Corp.の登録商標です。
IBMは，米国における米国International Business Machines Corp.の登録商標です。
HP-UXは，米国Hewlett-Packard Companyのオペレーティングシステムの名称です。
Microsoftは，米国およびその他の国における米国Microsoft Corp.の登録商標です。
UNIXは，X/Open Company Limitedが独占的にライセンスしている米国ならびに他の国における登録商標です。
VisualAgeは，米国における米国International Business Machines Corp.の商標です。
Visual C++は，米国およびその他の国における米国Microsoft Corp.の登録商標です。
Visual Studioは，米国およびその他の国における米国Microsoft Corp.の登録商標です。
Win32は，米国およびその他の国における米国Microsoft Corp.の登録商標です。
Windowsは，米国およびその他の国における米国Microsoft Corp.の登録商標です。
Windows NTは，米国およびその他の国における米国Microsoft Corp.の登録商標です。
Windows Serverは，米国およびその他の国における米国Microsoft Corp.の商標です。
X/Openは，X/Open Company Limited の英国ならびに他の国における登録商標です。
すべてのSPARC商標は，米国SPARC International, Inc. のライセンスを受けて使用している同社の米国およびその他の国における商標または登録商標です。SPARC商標がついた製品は，米国Sun Microsystems, Inc. が開発したアーキテクチャに基づくものです。

■ 発行

2006年6月（第1版）3000-6-302
2006年9月（第2版）3000-6-302-10

■ 著作権

All Rights Reserved. Copyright (C) 2006, Hitachi, Ltd.

変更内容

変更内容(3000-6-302-10)　Text Search Filter Library Version 3　03-10

追加・変更機能 | 変更個所
検索オプション指定機能を追加した。 | 1.2.4，2.2.4，2.8
検索条件式別のヒット数取得機能を追加した。 | 1.2.5，2.2.5
適用OSにHP-UXを追加した。 | 1.3.1，2.1.1，2.3.3
API関数を追加した。 | 2.1.2，3
エラーコードを追加した。 | 4.3，4.4

はじめに

このマニュアルは，次に示すプログラムプロダクトで提供するファイルおよびAPI関数を使用したUAPの作成方法について説明したものです。

P-1MD3-3831　Text Search Filter Library Version 3

P-24D3-3834　Text Search Filter Library Version 3

P-1BD3-3831　Text Search Filter Library Version 3

以降，このマニュアルでは，上記プログラムプロダクトの総称をText Search Filter Libraryとします。

対象読者

このマニュアルは，次の方にお読みいただくことを前提に説明しています。

Text Search Filter Libraryで提供するファイルおよびAPI関数を使用してUAPを作成するプログラマの方

C言語の知識をお持ちの方

マニュアルの構成

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

第1章　概要

Text Search Filter Libraryの目的，機能および前提プログラムについて説明しています。

第2章　UAPの作成

Text Search Filter Libraryで提供するファイルとAPI関数の一覧を示し，UAPを作成する方法について説明しています。また，検索条件式，異表記展開検索および同義語テキストファイルの記述形式について説明しています。さらに，作成したUAPで検索を実行する場合の注意事項について説明しています。

第3章　API関数

Text Search Filter Libraryで提供するAPI関数について，リファレンス形式で説明しています。

第4章　エラーコード

Text Search Filter Libraryで提供するAPI関数が異常終了したときに戻り値として出力される，エラーコードの詳細について説明しています。

関連マニュアル

このマニュアルの関連マニュアルを次に示します。必要に応じてお読みください。

HiRDB 全文検索プラグイン　HiRDB Text Search Plug-in Version 2（3000-6-245）

HiRDB 全文検索プラグイン　HiRDB Text Search Plug-in Version 2（3020-6-140）

HiRDB 全文検索プラグイン　HiRDB Text Search Plug-in Version 7（3000-6-288）

Text Search Enhancer for English（3000-6-301）

読書手順

このマニュアルは，利用目的に合わせて章を選択してお読みいただけます。利用目的別に次の流れに従ってお読みいただくことをお勧めします。

このマニュアルで使用する記号

このマニュアルで画面の構成要素を説明するときに使用する記号を，次のように定義します。

記号
意味

［　］
ウィンドウ名およびダイアログ名を示しています。

（例）

［新規作成］ウィンドウ

［プロジェクトの設定］ダイアログ

［A］－［B］
－の前に示した［A］メニューから，［B］コマンドを選択することを示します。

（例）

［ファイル］－［新規作成］

「　」
ウィンドウまたはダイアログ中に表示される項目を示します。

（例）

「オブジェクト/ライブラリモジュール」テキストボックス

文法に使用する記号

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

記号
意味と例

｛　｝
波括弧
この記号で囲まれている複数の項目から一つを選択することを示します。

（例）

｛ A | B | C ｝は，A，BまたはCのどれか一つを選択することを意味します。

<　>
山括弧
この記号で囲まれている項目は該当する要素を指定することを示します。

（例）

<要素名>は，要素名を記述します。

…
リーダ
この記号の直前に示す記号を繰り返し，複数個指定できることを示します。

（例）

<要素名>…は，要素名を一つ以上で複数個，繰り返して指定できます

△
白三角
1文字の半角スペースを示します。

このマニュアルで使用する構文要素

このマニュアルで使用する構文要素を次に示します。

構文要素
意味

英字
A～Z　a～z

英小文字
a～z

英大文字
A～Z

数字
0～9

英数字
英字または数字

半角かたかな
ア～ン，ヲ

半角文字
英字，数字，半角かたかな，スペース

全角文字
2バイトコードで表す文字

記号
！　"　＃　＄　％　＆　？　'　（　）　＋　，　ー※　．　／　：　＊
；　＜　＝　＞　＠　［　］　＾　＿　｛　｝　￣　｜
タブ　空白

注※

かたかな文字の直後にある「ー」は，かたかな文字になります。

このマニュアルでの表記

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

製品名称
略称

HiRDB Text Search Plug-in Version 7
Text Search Plug-in

AIX5L V5.2，V5.3
AIX

HP-UX
HP-UX

HP-UX 11i，11i V2

Microsoft(R) Windows(R) 2000 Professional Operating System
Windows 2000
Windows

Microsoft(R) Windows(R) 2000 Server Operating System

Microsoft(R) Windows(R) 2000 Advanced Server Operating System

Microsoft(R) Windows(R) 2000 Datacenter Server Operating System

Microsoft(R) Windows(R) XP Professional Operating System
Windows XPまたは
Windows XP Professional

Microsoft(R) Windows(R) XP Professional x64 Edition
Windows XPまたはWindows XP x64 Edition

Microsoft(R) Windows Server(TM) 2003, Standard Edition
Windows Server 2003

Microsoft(R) Windows Server(TM) 2003, Enterprise Edition

Microsoft(R) Windows Server(TM) 2003, Standard x64 Edition
Windows Server 2003またはWindows Server 2003 x64 Editions

Microsoft(R) Windows Server(TM) 2003, Enterprise x64 Edition

Visual C++ 5.0
Visual C++

Visual Age C++ for AIX V5.0，V6.0
Visual Age

XL C Enterprise Edition V7.0
XL C

XL C/C++ Enterprise Edition V7.0
XL C/C++

注

OSによる機能差がない場合，Windows 2000，Windows XPおよびWindows Server 2003を総称して，Windowsと表記します。

このマニュアルで使用する英略語

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

英略語 | 説明
API | Application Programming Interface
DLL | Dynamic Link Library
HTML | Hyper Text Markup Language
JIS | Japanese Industrial Standard code
LF | Line Feed
OS | Operating System
SGML | Standard Generalized Markup Language
UAP | User Application Program
XML | eXtensible Markup Language

適用OSの違いによる機能相違点の表記

このマニュアルは，AIX，WindowsおよびHP-UXに適用します。OSによって機能差がある場合，それぞれの説明にOS名を明記しています。

なお，このマニュアルでは「ディレクトリ」または「フォルダ」のことを「ディレクトリ」と記述している個所があります。Windowsをご使用の方は「フォルダ」に置き換えてお読みください。

常用漢字以外の漢字の使用について

このマニュアルでは，常用漢字を使用することを基本としていますが，次の用語については，常用漢字以外の漢字を使用しています。

拗音（ようおん）

KB（キロバイト）などの単位表記について

1KB（キロバイト），1MB（メガバイト），1GB（ギガバイト），1TB（テラバイト）はそれぞれ1,024バイト，1,024²バイト，1,024³バイト，1,024⁴バイトです。

1.　概要

この章では，Text Search Filter Libraryの目的，機能および前提プログラムについて説明します。

＜この章の構成＞

1.1　目的

1.2　機能

1.3　前提プログラム

1.1　目的

この節では，Text Search Filter Libraryの目的について説明します。

Text Search Filter Libraryは，文書検索時の検索条件として指定したキーワード（検索ターム）が文書中のどの位置に出現しているかといった，ヒット位置情報を取得するUAP作成用のライブラリ機能を提供する32ビットのアプリケーションプログラムです。

Text Search Filter Libraryでは，UAP作成に必要な各種ファイルおよびAPI関数を提供していますので，UAPを効率良く作成できます。

ヒット位置情報取得の基となるデータは，データベースの全文検索用プログラムの検索結果です。Text Search Filter Libraryで作成したUAPでは，全文検索用プログラムの検索結果から，「先頭から何文字目」という形式でヒット位置情報を取得できます。

取得したヒット位置情報は，検索タームのヒット位置を検索結果の表示画面上に反転表示したり，ヒット位置情報の一覧を出力したりするなどの活用ができます。

また，ヒット位置情報が必要ない場合は，簡易的な機能としてヒットの有無だけを，またはヒット数だけを検索結果として取得することもできます。

1.2　機能

Text Search Filter Libraryで作成するUAPには次の機能が備えられます。

ヒット位置情報の取得機能

同義語・異表記展開結果の取得機能

検索結果の取得機能

検索オプション指定機能

検索条件式別のヒット数取得機能

この節では，各機能の概要について説明します。

＜この節の構成＞

1.2.1　ヒット位置情報の取得機能

1.2.2　同義語・異表記展開結果の取得機能

1.2.3　検索結果の取得機能

1.2.4　検索オプション指定機能

1.2.5　検索条件式別のヒット数取得機能

1.2.1　ヒット位置情報の取得機能

ヒット位置情報（検索タームが文書中に出現する位置）を「先頭から何文字目」という形式で取得します。

また，指定した検索タームのヒット位置情報だけでなく，同義語・異表記展開検索した場合のヒット位置情報も取得できます。例えば，「Japan」を検索タームにする場合，「日本」「JAPAN」などのヒット位置情報を取得することもできます。

ヒット位置情報を取得する対象として利用できるのは，テキスト，SGML，HTML，XMLなどのフォーマットで作成された文書です。また，Text Search Plug-inの検索結果を利用することもできます。

ヒット位置情報を取得するUAPの作成方法については，「2.　UAPの作成」を参照してください。

1.2.2　同義語・異表記展開結果の取得機能

指定した検索タームが同義語・異表記展開される結果を取得します。同義語・異表記展開検索をする場合に，指定した検索タームが同義語・異表記展開されて，どのような検索タームで検索されるかを知ることができます。

同義語展開検索では，同義語辞書の定義に基づいて，検索タームの同義語が自動的に展開されます。異表記展開検索では，Text Search Filter Libraryでのルールに基づいて，検索タームの異表記が展開されます。

同義語辞書の作成方法については，「2.7　同義語辞書テキストファイル」を参照してください。また，異表記展開検索の詳細については，「2.6.2　異表記展開検索」を参照してください。

1.2.3　検索結果の取得機能

指定した検索条件式の実行結果が，指定した文書に対して「真」であるかどうかを知ることができます。

検索条件式は複数指定することができ，結果が「真」となった検索条件式がどれかを知ることができます。

例えば，特定の文書に対して以下のような三つの検索条件式を指定して検索を実行したとします。

「日立」AND「製作所」

「テキスト」OR「ドキュメント」

「株式会社」

文書中に「株式会社」と「テキスト」という文字列が存在した場合は，2と3の条件式の実行結果が「真」となります。

検索条件式の記述形式については，「2.6　検索条件式と異表記展開検索」を参照してください。

1.2.4　検索オプション指定機能

検索結果の取得機能を使用する場合，検索オプション指定機能が使用できます。検索オプションを指定することにより，検索するときの条件設定を行うことができます。

検索オプション指定機能の記述形式については，「2.8　検索オプション指定機能」を参照してください。

＜この項の構成＞

(1)　文字統一機能

(2)　削除文字指定機能

(1)　文字統一機能

検索対象となる文書情報には，大文字と小文字，全角文字と半角文字のように，表記の異なる文字が含まれています。この表記の違いによって，期待する検索結果が得られない場合があります。例えば，「BASEBALL」または「baseball」と指定して検索すると，通常は「BaseBall」が検索されません。この大小文字または全角半角文字表記の違いを吸収した検索結果を得るためには，文字統一機能を利用します。

この機能には，次の3種類の利用方法があります。

英大文字と英小文字を区別しない（大小文字統一機能の使用）

全角文字と半角文字の英数字，かたかな，および記号を区別しない（全角文字半角文字統一機能の使用）

「あ」と「ぁ」，「や」と「ゃ」など，拗音の違いを区別しない（拗音統一機能の使用）

これらのうち，例えば，大小文字統一機能の使用を設定して「book」と指定して検索すると，「Book」や「BOOK」も検索できるようになります。

文字統一機能の詳細については，「2.8.4　文字統一機能」を参照してください。

(2)　削除文字指定機能

検索に使用しない文字を設定する機能を，削除文字指定機能といいます。

例えば，「X△M△L」のように，文字間に半角スペースを入れて表記されている場合，検索タームに半角スペースを入れなければヒットしません。しかし，削除文字指定機能を利用すると，スペースなどが登録した文書情報から削除されるため，検索タームにスペースを入れなくてもヒットさせることができます。

削除文字指定機能の詳細については，「2.8.5　削除文字指定機能」を参照してください。

1.2.5　検索条件式別のヒット数取得機能

複数の検索条件式を同時に実行した場合，検索条件式別にヒット数を知ることができます。例えば，「Apple」，「Orange」，「Cherry」を同時に指定して検索した場合，「Apple」が10件，「Orange」が8件，「Cherry」が20件のように，検索条件式ごとにヒット数を取得します。

1.3　前提プログラム

この節では，Text Search Filter Libraryを使用してUAPを作成するときに必要なプログラムと，作成したUAPを実行するときに必要なプログラムについて説明します。

＜この節の構成＞

1.3.1　UAP作成時に必要なプログラム

1.3.2　UAP実行時に必要なプログラム

1.3.1　UAP作成時に必要なプログラム

コンパイル時に使用するコンパイラは，ご使用のOSによって異なります。

コンパイル時に推奨するコンパイラを次の表に示します。

表1-1　コンパイル時に推奨するコンパイラ

OS
推奨するコンパイラ

Windows
Visual C++ 5.0，6.0，Visual Studio 2005

AIX
Visual Age C++ for AIX V5.0，
Visual Age C++ for AIX V6.0，
XL C Enterprise Edition V7.0，
XL C/C++ Enterprise Edition V7.0

HP-UX
HP-C

1.3.2　UAP実行時に必要なプログラム

UAPを実行するマシンには，Text Search Filter Libraryをインストールしてください。

2.　UAPの作成

この章では，Text Search Filter Libraryで提供するファイルとAPI関数の一覧を示し，UAPを作成する方法について説明します。また，検索条件式，異表記展開検索および同義語テキストファイルの記述形式について説明します。さらに，作成したUAPで検索を実行する場合の注意事項について説明します。

＜この章の構成＞

2.1　提供するファイルおよびAPI関数一覧

2.2　API関数の発行順序

2.3　コンパイルおよびリンケージ

2.4　マルチスレッド実行機能

2.5　Text Search Filter Libraryで使用できる文字コード

2.6　検索条件式と異表記展開検索

2.7　同義語辞書テキストファイル

2.8　検索オプション指定機能

2.9　検索時の注意事項

2.10　バージョンアップ時の注意事項

2.11　その他の注意事項

2.1　提供するファイルおよびAPI関数一覧

この節では，Text Search Filter Libraryで提供するファイルおよびAPI関数について説明します。

＜この節の構成＞

2.1.1　ファイル一覧

2.1.2　API関数一覧

2.1.1　ファイル一覧

Text Search Filter Libraryで提供するファイルの構成を，OSごとに示します。

＜この項の構成＞

(1)　AIXの場合

(2)　Windowsの場合

(3)　HP-UXの場合

(1)　AIXの場合

提供するファイルの構成を次の図に示します。

図2-1　提供するファイルの構成（AIXの場合）

(2)　Windowsの場合

提供するファイルの構成を次の図に示します。

図2-2　提供するファイルの構成（Windowsの場合）

(3)　HP-UXの場合

提供するファイルの構成を次の図に示します。

図2-3　提供するファイルの構成（HP-UXの場合）

2.1.2　API関数一覧

Text Search Filter Libraryで提供するAPI関数の一覧を次の表に示します。API関数の使用方法の詳細については，「3.　API関数」を参照してください。

表2-1　API関数一覧

API関数名 | 機能
TS0F_Compile | 検索条件式のコンパイル
TS0F_Compile_Ex | 検索条件式のコンパイル（検索オプション指定機能対応）
TS0F_DicMake | 同義語辞書の作成
TS0F_DicMake_Ex | 同義語辞書の作成（検索オプション指定機能対応）
TS0F_Free | 実行結果の解放
TS0F_GetTermNum | 検索条件式別のヒット数取得機能
TS0F_GetTermPos | ヒット位置情報の取得
TS0F_Mlook | 同義語・異表記展開結果の取得
TS0F_OptMake | 検索オプション指定機能
TS0F_Search | 検索結果の取得機能

2.2　API関数の発行順序

この節では，ヒット位置情報取得時，同義語・異表記展開ターム取得時，および検索結果の取得機能時のAPI関数の発行順序について説明します。

＜この節の構成＞

2.2.1　ヒット位置情報取得時のAPI関数の発行順序

2.2.2　同義語・異表記展開ターム取得時のAPI関数の発行順序

2.2.3　検索結果の取得時のAPI関数の発行順序

2.2.4　検索オプション指定および検索結果取得時のAPI関数の発行順序

2.2.5　検索条件式別のヒット数取得時のAPI関数の発行順序

2.2.1　ヒット位置情報取得時のAPI関数の発行順序

ヒット位置情報取得時のAPI関数の発行順序を次の図に示します。

図2-4　ヒット位置情報取得時のAPI関数の発行順序

2.2.2　同義語・異表記展開ターム取得時のAPI関数の発行順序

同義語・異表記展開ターム取得時のAPI関数の発行順序を次の図に示します。

図2-5　同義語・異表記展開ターム取得時のAPI関数の発行順序

2.2.3　検索結果の取得時のAPI関数の発行順序

検索結果の取得時のAPI関数の発行順序を次の図に示します。

図2-6　検索結果の取得時のAPI関数の発行順序

2.2.4　検索オプション指定および検索結果取得時のAPI関数の発行順序

検索オプション指定および検索結果取得時のAPI関数の発行順序を次の図に示します。

図2-7　検索オプション指定および検索結果取得時のAPI関数の発行順序

2.2.5　検索条件式別のヒット数取得時のAPI関数の発行順序

検索条件式別のヒット数取得時のAPI関数の発行順序を次の図に示します。

図2-8　検索条件式別のヒット数取得時のAPI関数の発行順序

2.3　コンパイルおよびリンケージ

この節では，作成したUAPのコンパイル方法およびリンケージ方法について，OSごとに説明します。

＜この節の構成＞

2.3.1　AIXの場合

2.3.2　Windowsの場合

2.3.3　HP-UXの場合

2.3.1　AIXの場合

AIXの場合のコンパイル方法およびリンケージ方法について説明します。

＜この項の構成＞

(1)　前提とするコンパイラ

(2)　コンパイルオプション（マルチスレッド）

(3)　コンパイルオプション（シングルスレッド）

(4)　リンクオプション（マルチスレッド）

(5)　リンクオプション（シングルスレッド）

(1)　前提とするコンパイラ

AIXを使用してコンパイルまたはリンケージを行う場合は，次の製品を使用してください。

Visual Age C++ for AIX V5.0

Visual Age C++ for AIX V6.0

XL C Enterprise Edition V7.0

XL C/C++ Enterprise Edition V7.0

(2)　コンパイルオプション（マルチスレッド）

マルチスレッドでコンパイルを実行する場合は，次のコンパイルオプションを指定してください。

表2-2　マルチスレッドのコンパイルオプション（AIXの場合）

指定するコンパイルオプション | オプションの意味
-I/opt/TSPlugin/TSFilter/include | インクルードパスの指定
-qthreaded※ | マルチスレッド実行の指定
-D_ALL_SOURCE | POSIXやそのほかの規格を有効にする
-D_POSIX_SOURCE | POSIX用ソース
-D_REENTRANT | マルチスレッド対応ライブラリの使用
-D_THREAD_SAFE | マルチスレッド対応

注※

接尾語に"r"が付いたコンパイラを使用した場合は，自動的にマルチスレッドのコンパイルオプションとして指定されます。

(3)　コンパイルオプション（シングルスレッド）

シングルスレッドでコンパイルを実行する場合は，次のコンパイルオプションを指定してください。

表2-3　シングルスレッドのコンパイルオプション（AIXの場合）

指定するコンパイルオプション | オプションの意味
-I/opt/TSPlugin/TSFilter/include | インクルードパスの指定
-D_ALL_SOURCE | POSIXやそのほかの規格を有効にする
-D_POSIX_SOURCE | POSIX用ソース

(4)　リンクオプション（マルチスレッド）

マルチスレッドでリンクする場合は，次のリンクオプションを指定してください。

表2-4　マルチスレッドのリンクオプション（AIXの場合）

指定するリンクオプション | オプションの意味
-L/opt/TSPlugin/TSFilter/lib | ライブラリパスの指定
-lts0_r | マルチスレッド用TSFilterライブラリの使用
-lc_r※ | マルチスレッド対応Ｃライブラリの使用
-lpthreads※ | POSIXスレッドの使用

注※

接尾語に"r"が付いたコンパイラを使用した場合は，自動的にマルチスレッドのリンクオプションとして指定されます。

(5)　リンクオプション（シングルスレッド）

シングルスレッドでリンクする場合は，次のリンクオプションを指定してください。

表2-5　シングルスレッドのリンクオプション（AIXの場合）

指定するリンクオプション | オプションの意味
-L/opt/TSPlugin/TSFilter/lib | ライブラリパスの指定
-lts0 | シングルスレッド用TSFilterライブラリの使用

2.3.2　Windowsの場合

Windowsの場合，コンパイル時にデバッグ版またはリリース版のどちらを作成するかを決定します。

UAPにデバッグ情報を埋め込んだり，デバッグ用コードを有効にしたりする場合には，デバッグ版を作成してください。それ以外の場合は，リリース版を作成してください。

＜この項の構成＞

(1)　前提とするコンパイラ

(2)　コンパイルオプション（デバッグ版の場合）

(3)　コンパイルオプション（リリース版の場合）

(4)　リンクオプション（デバッグ版の場合）

(5)　リンクオプション（リリース版の場合）

(1)　前提とするコンパイラ

Windowsを使用してコンパイルまたはリンケージを行う場合は，次の製品を使用してください。

Visual C++ 5.0

Visual C++ 6.0

Visual Studio 2005

(2)　コンパイルオプション（デバッグ版の場合）

デバッグ版でコンパイルする場合は，次のコンパイルオプションを指定してください。

表2-6　デバッグ版のコンパイルオプション

Visual C++での設定項目
設定値
設定されるコンパイルオプション

インクルードファイルのパス
インストールフォルダ
¥include
/I "インストールフォルダ¥INCLUDE"

使用するランタイムライブラリ
"マルチスレッド（DLL，デバッグ）"
/MDd

プリプロセッサマクロ
_DEBUG，WIN32
/D "_DEBUG" /D"WIN32"

(3)　コンパイルオプション（リリース版の場合）

リリース版でコンパイルする場合は，次のコンパイルオプションを指定してください。

表2-7　リリース版のコンパイルオプション

Visual C++での設定項目
設定値
設定されるコンパイルオプション

インクルードファイルのパス
インストールフォルダ
¥include
/I"インストールフォルダ¥INCLUDE"

使用するランタイムライブラリ
"マルチスレッド（DLL）"
/MD

プリプロセッサマクロ
NDEBUG，WIN32
/D"NDEBUG" /D"WIN32"

(4)　リンクオプション（デバッグ版の場合）

デバッグ版でリンクする場合は，次のリンクオプションを指定してください。

表2-8　デバッグ版のリンクオプション

Visual C++での設定項目 | 設定値 | 設定されるコンパイルオプション
ライブラリパス | インストールフォルダ¥lib | /libpath:"インストールフォルダ¥LIB"
ライブラリモジュール | ts0stlbd.lib | ts0stlbd.lib

(5)　リンクオプション（リリース版の場合）

リリース版でリンクする場合は，次のリンクオプションを指定してください。

表2-9　リリース版のリンクオプション

Visual C++での設定項目 | 設定値 | 設定されるコンパイルオプション
ライブラリパス | インストールフォルダ¥lib | /libpath:"インストールフォルダ¥LIB"
ライブラリモジュール | ts0stlib.lib | ts0stlib.lib

2.3.3　HP-UXの場合

HP-UXの場合のコンパイル方法およびリンケージ方法について説明します。

＜この項の構成＞

(1)　前提とするコンパイラ

(2)　コンパイルオプション（マルチスレッド）

(3)　コンパイルオプション（シングルスレッド）

(4)　リンクオプション（マルチスレッド）

(5)　リンクオプション（シングルスレッド）

(1)　前提とするコンパイラ

HP-UXを使用してコンパイルまたはリンケージを行う場合は，次の製品を使用してください。

HP-C

(2)　コンパイルオプション（マルチスレッド）

マルチスレッドでコンパイルを実行する場合は，次のコンパイルオプションを指定してください。

表2-10　マルチスレッドのコンパイルオプション（HP-UXの場合）

指定するコンパイルオプション | オプションの意味
-I/opt/TSPlugin/TSFilter/include | インクルードパスの指定
-D_ALL_SOURCE | POSIXやそのほかの規格を有効にする
-D_POSIX_SOURCE=199506L | POSIXのリビジョンレベルを指定する
-Aa | ANSIモードでコンパイルする
-D_HPUX_SOURCE | HP-UXで提供されるmacroやtypedefにアクセスする

(3)　コンパイルオプション（シングルスレッド）

シングルスレッドでコンパイルを実行する場合は，次のコンパイルオプションを指定してください。

表2-11　シングルスレッドのコンパイルオプション（HP-UXの場合）

指定するコンパイルオプション | オプションの意味
-I/opt/TSPlugin/TSFilter/include | インクルードパスの指定
-D_ALL_SOURCE | POSIXやそのほかの規格を有効にする
-D_POSIX_SOURCE | POSIX用ソース

(4)　リンクオプション（マルチスレッド）

マルチスレッドでリンクする場合は，次のリンクオプションを指定してください。

表2-12　マルチスレッドのリンクオプション（HP-UXの場合）

指定するリンクオプション | オプションの意味
-L/opt/TSPlugin/TSFilter/lib | ライブラリパスの指定
-lts0_r | マルチスレッド用TSFilterライブラリの使用
-lpthread | POSIXスレッドの使用

(5)　リンクオプション（シングルスレッド）

シングルスレッドでリンクする場合は，次のリンクオプションを指定してください。

表2-13　シングルスレッドのリンクオプション（HP-UXの場合）

指定するリンクオプション | オプションの意味
-L/opt/TSPlugin/TSFilter/lib | ライブラリパスの指定
-lts0 | シングルスレッド用TSFilterライブラリの使用

2.4　マルチスレッド実行機能

マルチスレッド実行用のライブラリロードモジュールを使用してUAPを作成することで，ライブラリ関数をマルチスレッド実行することができる機能です。

OSがUNIX系の場合，ファイル名称に”r”が付いているものが，マルチスレッド実行用のライブラリロードモジュールです。

注意事項

AIXの環境で，マルチスレッドのアプリケーションを実行する場合は，スレッドスタックサイズに196608バイト以上を指定してください。スレッドスタックサイズの指定は，環境変数AIXTHREAD_STK，またはpthread_create（）でスレッドを生成する前に，pthread_attr_setstacksize（）関数で指定してください。

2.5　Text Search Filter Libraryで使用できる文字コード

Text Search Filter Libraryでは，シフトJISコード，日本語EUC，およびUTF-8の3種類の文字コードが使用されます。異なる文字コードを使用した場合，検索結果が不正となりますのでご注意ください。

ここでは，Text Search Filter Libraryで使用できる文字コードについてそれぞれ説明します。

＜この節の構成＞

(1)　シフトJISコード

(2)　日本語EUCコード

(3)　UTF-8コード

(4)　文字コードの統一性

(5)　マルチバイト検索機能

(1)　シフトJISコード

使用できるシフトJISのコード範囲を次の表に示します。

表2-14　シフトJISコードで使用できる文字

文字種
長さ（バイト）
配置

2バイトコードの1バイト目
2バイトコードの2バイト目

文字コード
1バイト文字コード
1バイト
0x20～0x7E
0xA1～0xDF
－

2バイト文字コード
2バイト
0x81～0x9F
0xE0～0xFC
0x40～0x7E
0x80～0xFC

制御コード
JIS制御文字コード
1バイト
0x09
0x0A
0x0D
－

(2)　日本語EUCコード

使用できる日本語EUCの範囲を次の表に示します。

表2-15　日本語EUCコードで使用できる文字

文字種
長さ（バイト）
配置

2バイトコードの1バイト目
2バイトコードの2バイト目

文字コード
1バイト文字コード
1バイト
0x20～0x7E
－

2バイト文字コード
2バイト
0x8E
0xA1～0xDF

0xA1～0xFE
0xA1～0xFE

制御コード
JIS制御文字コード
1バイト
0x09
0x0A
0x0D
－

(3)　UTF-8コード

使用できるUTF-8の範囲を次の表に示します。

表2-16　UTF-8コードで使用できる文字

コードポイント | 1バイト | 2バイト | 3バイト | 4バイト | 5バイト | 6バイト
U+00000009，U+0000000a，U+0000000d，U+00000020～U+0000007E | 09，0a，0d，20～7E※ |  |  |  |  |
U+00000080～U+000007FF | C280～DFBF |  |  |  |
U+00000800～U+0000FFFF | E0A080～EFBFBF |  |  |
U+00010000～U+0010FFFF | F0908080～F48FBFBF |  |
U+00110000～U+001FFFFF | F4908080～F7BFBFBF |  |
U+00200000～U+03FFFFFF | F888808080～FBBFBFBFBF |
U+04000000～U+7FFFFFFF | FC8480808080～FDBFBFBFBFBF

注※

UCS4の範囲の制御文字については，記述できない範囲があります。

(4)　文字コードの統一性

同義語辞書，検索語，検索タームで使用するコードは，同じ文字コードにする必要があります。文字コードの判定は，TS0LIB_LANG環境変数を設定して判断します。TS0LIB_LANG環境変数が設定されていない場合は，TSLANG環境変数またはLANG環境変数を参照して文字コード種別を判断します。

環境変数の設定をしていない場合は，Text Search Filter LibraryはシフトJISと判断します。また，TS0LIB_LANG環境変数の設定値が不正の場合はエラーとなります。ただしTSLANG環境変数またはLANG環境変数の設定値は，不正の場合でもエラーになりません。

文字コードによる環境変数値を次の表に示します。

表2-17　文字コードの環境変数値

文字コード | 環境変数 | AIX | Windows | HP-UX
シフトJIS | TS0LIB_LANG | SJIS | SJIS | SJIS
TSLANGまたはLANG | ja_JP.SJIS | ja_JP.SJIS | ja_JP.SJISまたはjapanese
日本語EUC | TS0LIB_LANG | EUC | EUC | EUC
TSLANGまたはLANG | ja_JP.EUCまたはja_JP.UJIS | ja_JP.EUCまたはja_JP.UJIS | －
UTF-8 | TS0LIB_LANG | UTF-8 | UTF-8 | UTF-8
TSLANGまたはLANG | － | － | －

(5)　マルチバイト検索機能

マルチバイト文字を意識した検索を実行します。

例えば”B”（0x42）で検索した場合に，”。”（0x8142）のように下位バイトにヒットしません。

2.6　検索条件式と異表記展開検索

この節では，検索条件式の記述形式および異表記展開検索について説明します。

＜この節の構成＞

2.6.1　検索条件式の記述形式

2.6.2　異表記展開検索

2.6.1　検索条件式の記述形式

ヒット位置情報を検索するための条件は，検索条件式で指定します。検索条件式に指定した検索条件に従って検索タームが検索され，ヒット位置情報を取得できます。

検索条件式は，TS0F_Compile関数（検索条件式のコンパイル）の引数で指定します。

検索条件式の記述形式および指定する値を次に示します。

記述形式

演算子（＜項1＞，＜項2＞…）

指定する値

各項には，「演算子（＜項1＞，＜項2＞…）」などの演算子と一つ以上の項の組み合わせ，または検索タームを指定できます。

一つまたは複数の項や検索タームを，論理条件（論理積，論理和，論理否定）とともに指定する場合は，演算子を使用します。

注意事項

*（アスタリスク）および?（疑問符）によるワイルドカード指定は，検索条件式に使用できません。

検索タームおよび演算子の詳細について次に説明します。

＜この項の構成＞

(1)　検索ターム

(2)　演算子

(1)　検索ターム

検索条件に指定するキーワードを検索タームといいます。検索条件およびTS0F_Mlook関数（同義語・異表記展開結果の取得）の指定時，検索タームにさらに条件を付け加えることで，さまざまな条件で検索できます。

検索タームは，'（アポストロフィ）で囲んでください。

また，次に示す文字を指定する場合，直前に¥（0x5c）をエスケープ文字として記述してください。

*　?　|　¥　^　[　]　,　(　)　'　

指定例

「サッカー」を検索タームに指定する。
'サッカー'

「¥」を検索タームとして指定する。
'¥¥'

「'」を検索タームに指定する。
'¥''

(2)　演算子

直後の丸括弧で囲まれた，一つ以上の項の検索条件を指定するために演算子を使用します。

検索条件式に指定する演算子を次の表に示します。

表2-18　検索条件式に指定する演算子

演算子
検索の種類
指定できる項の数
説明

eq
一致
一つ
指定された検索タームが存在することを指定します。
一つの項に指定できる検索タームは一つです。

fnot※
論理否定
一つ
項の検索条件が存在しないか，または成立しないことを指定します。

fand※
論理積
二つ以上
すべての項の検索条件が存在するか，または成立することを指定します。

for※
論理和
二つ以上
すべての項の検索条件で，一つ以上の項の検索条件に合致した内容が存在するか，または成立することを指定します。

注※

演算子中の項に，検索タームまたはfand，for，fnot演算子を指定できます。

演算子を使用した検索条件式の指定例を次に示します。

指定例

「日本」を含む文書を検索する。
eq('日本')

「日本」を含まない文書を検索する。
fnot('日本')

「日本」および「代表」を含む文書を検索する。
fand('日本','代表')

「日本」または「代表」を含む文書を検索する。
for('日本','代表')

「日本」を含み，「代表」を含まない文書を検索する。
fand('日本',fnot('代表'))

「日本」を含み，「代表」または「候補」を含む文書を検索する。
fand('日本',for('代表','候補'))

2.6.2　異表記展開検索

例えば，「ｓｋｉ」を検索タームにする場合，「ski」「Ｓｋｉ」などで表記されている文書も検索したい場合があります。異表記展開検索はこのような場合に使用します。

異表記展開検索では，Text Search Filter Libraryでのルールに基づいて自動的に検索タームの異表記が展開されます。展開された異表記は，検索タームとあわせて検索されます。

異表記展開検索を実行するかどうかは，異表記オプションで指定します。異表記オプションは，TS0F_Compile関数（検索条件式のコンパイル）およびTS0F_Mlook関数（同義語・異表記展開結果の取得）の引数で指定します。

異表記オプションは，検索条件式ごとに指定できます。異表記オプションは，一つ以上の条件の論理和で指定できます。

異表記オプションの種類を次の表に示します。

表2-19　異表記オプションの種類

異表記オプション
種類
説明

TS0D_EXPANS_DIC
同義語辞書異表記
検索タームまたは検索タームの同義語を含む文書を検索するときに指定します。
同義語辞書の定義に基づいて，検索タームの同義語が自動的に展開されます。
同義語辞書の詳細については，「2.7　同義語辞書テキストファイル」を参照してください。

TS0D_EXPANS_KANA
かたかな異表記
検索タームまたは検索タームのかたかな異表記を含む文書を検索する場合に指定します。
このオプションは，全角のかたかなだけに有効です。検索タームの半角文字もかたかな異表記展開する場合は，「TS0D_EXPANS_EXCHG（全角半角異表記）」オプションも指定してください。

TS0D_EXPANS_ALPHA
アルファベット異表記
検索タームまたは検索タームのアルファベット異表記を含む文書を検索する場合に指定します。
このオプションは，全角の英字だけに有効です。検索タームの半角文字もアルファベット異表記展開する場合は，「TS0D_EXPANS_HALPHA（半角アルファベット異表記）」オプションも指定してください。
全角アルファベットの文字列は，次に示す四つのパターンで展開されます。

すべて大文字

すべて小文字

先頭だけ大文字

指定した文字列

TS0D_EXPANS_HALPHA
半角アルファベット異表記
検索タームまたは検索タームの半角アルファベット異表記を含む文書を検索する場合に指定します。
このオプションは，半角の英字だけに有効です。検索タームの全角文字もアルファベット異表記展開する場合は，「TS0D_EXPANS_ALPHA（アルファベット異表記）」オプションも指定してください。
半角アルファベットの文字列は，次に示す四つのパターンで展開されます。

すべて大文字

すべて小文字

先頭だけ大文字

指定した文字列

TS0D_EXPANS_EXCHG
全角半角異表記
検索タームまたは検索タームの全角半角異表記を含む文書を検索する場合に指定します。
全角から半角（または全角から半角）に変換できる検索タームが，次に示す三つのパターンで展開されます。

すべてが全角文字列

すべてが半角文字列

指定した文字列

TS0D_EXPANS_YOUON
ひらがな拗音異表記
検索タームまたは検索ターム（ひらがな）の拗音の展開を含む文書を検索する場合に指定します。

TS0D_EXPANS_STEM
英単語派生異表記※
検索タームまたは英単語の派生語を含む文書を検索する場合に指定します。

TS0D_EXPANS_INFLECTION
英単語語尾異表記※
検索タームまたは英単語の語尾の展開を含む文書を検索する場合に指定します。

TS0D_EXPANS_KANA_CHOHYPN
かたかな長音ハイフン異表記
検索タームまたはかたかな文字列を含む文書を検索する場合に指定します。
このオプションは，長音・ハイフンだけに有効です。前後のかたかな文字列は展開の対象になりません。

TS0D_EXPANS_KANA_BASIC
かたかなベーシック異表記
かたかなルールに基づいた展開だけを実行します。

TS0D_EXPANS_KANA_YOUON
かたかな拗音異表記
検索タームまたは検索ターム（かたかな）の拗音の展開結果を含む文書を検索する場合に指定します。

注※　この異表記オプションを使用する場合は，Text Search Enhancer for Englishが必要です。

異表記オプションは，単独または複数の異表記オプションを組み合わせて指定できます。異表記の展開例を次の図に示します。

図2-9　異表記オプションの指定例

2.7　同義語辞書テキストファイル

この節では，同義語辞書テキストファイルの記述形式および記述例について説明します。また，同義語グループ内の文字種の制限についても説明します。

＜この節の構成＞

2.7.1　同義語辞書テキストファイルとは

2.7.2　同義語辞書テキストファイルの記述形式

2.7.3　同義語辞書テキストファイルの記述例

2.7.1　同義語辞書テキストファイルとは

全文検索で検索タームの同義語を検索条件として使用する場合は，同義語辞書を作成します。同義語展開検索を実行する場合，同義語辞書の定義に基づいて，検索タームの同義語が自動的に展開されます。

同義語辞書の基になるファイルを同義語辞書テキストファイルといいます。同義語辞書テキストファイルには，キーワードとなる単語（検索ターム）の同義語の展開方法を定義します。

同義語辞書テキストファイルはテキストエディタなどで作成します。

なお，同義語展開検索を実行しない場合，同義語辞書テキストファイルを作成する必要はありません。

2.7.2　同義語辞書テキストファイルの記述形式

同義語辞書テキストファイルには，次の形式で同義語を定義します。

記述形式

同義語，同義語〔，同義語〕…

注意事項

同義語辞書は，「2.5　Text Search Filter Libraryで使用できる文字コード」に示す文字コードを使用できますが，制御コード（0x09，0x0d，0x0a）は使用できません。

一つの同義語のグループには，2語以上の同義語を記述してください。

行の先頭文字に*（半角アスタリスク）を記述すると，注釈行とみなされ，同義語として扱われません。*を同義語とする場合，¥*と記述してください。なお，¥は半角でも全角でもかまいません。ただし半角の場合は¥という文字ではなく，コード「0x5C」の文字になります。

行の途中に△（半角スペース）があった場合，半角スペース以降のデータは注釈として扱われます。ただし，行の先頭にある半角スペースは無視されます。
半角スペースを同義語とする場合，¥△と記述してください。なお，¥は半角でも全角でもかまいません。ただし半角の場合は¥という文字ではなく，コード「0x5C」の文字になります。

行の末尾が ,（半角コンマ）で終了している場合，行が継続しているものとして扱われます。,を同義語とする場合，¥,と記述してください。なお，¥は半角でも全角でもかまいません。ただし半角の場合は¥という文字ではなく，コード「0x5C」の文字になります。

△（半角スペース），*（半角アスタリスク）， ,（半角コンマ）または¥（エスケープ文字）を同義語とする場合，¥*のように，直前に¥を付けて記述してください。なお，¥は半角でも全角でもかまいません。ただし半角の場合は¥という文字ではなく，コード「0x5C」の文字になります。

単独の¥（全角エスケープ文字）は無視されます。¥を同義語として登録する場合は，¥¥と記述してください。

2.7.3　同義語辞書テキストファイルの記述例

同義語辞書テキストファイルの記述例を次の図に示します。

図2-10　同義語辞書テキストファイルの記述例

2.8　検索オプション指定機能

この節では，検索オプション指定機能の記述形式および記述例について説明します。また，検索オプション指定機能の制限についても説明します。

＜この節の構成＞

2.8.1　検索オプション指定機能とは

2.8.2　検索オプション指定機能で使用できる機能

2.8.3　検索オプション指定機能の記述形式と記述例

2.8.4　文字統一機能

2.8.5　削除文字指定機能

2.8.1　検索オプション指定機能とは

検索オプション指定機能は，文字表記の違いを吸収したり，検索に使用しない文字をあらかじめ指定した検索を実行する場合に使用します。

検索オプション指定機能で使用するオプション機能を設定するファイルを，検索オプション定義ファイルといいます。この定義ファイルを指定してTS0F_OptMake（検索データの生成）を実行すると検索オプションデータが作成されます。作成された検索オプションデータを指定して，TS0F_Compile_Ex（オプション指定対応のコンパイル）を実行すると，オプション指定をしたコンパイル結果のデータが作成されます。作成されたコンパイル結果のデータを指定して，検索を実行します。

なお，検索オプション指定機能を実行しない場合は，検索オプション定義ファイルを作成する必要はありません。

2.8.2　検索オプション指定機能で使用できる機能

使用できる機能と文字コードによる差異を説明します。

＜この項の構成＞

(1)　関数による機能差異

(2)　使用する文字コードによる機能差異

(1)　関数による機能差異

検索オプション指定機能で指定できる関数と機能の差異を次の表に示します。

表2-20　指定できる関数と機能の差異

機能
TS0F_GetTermPos
（ヒット位置情報の取得）
TS0F_Search
（検索）
TS0F_GetTermNum
（検索条件式別のヒット数取得）

大小文字統一機能
×
○
○

全角文字半角文字統一機能
×
○
○

拗音統一機能
×
○
○

削除文字指定機能
×
○
○

(2)　使用する文字コードによる機能差異

検索オプション指定機能で使用する文字コードによる機能差異を，次の表に示します。

表2-21　使用できる文字コード

機能 | Shift-JIS | EUC | utf-8（UCS4）
大小文字統一機能 | ○ | ○ | ○
全角文字半角文字統一機能 | ○ | ○ | ○
拗音統一機能 | ○ | ○ | ○
削除文字指定機能 | ○ | ○ | ○

2.8.3　検索オプション指定機能の記述形式と記述例

検索オプション指定機能は，次の形式でオプションを定義します。

＜この項の構成＞

(1)　記述形式

(2)　記述例

(1)　記述形式

記述形式

設定項目＝設定値

設定できる項目と設定値を次に示します。

表2-22　検索オプション指定機能の記述形式

設定項目 | 設定値 | 機能
SAMECASE | ON | 大小文字統一機能を使用する
OFF | 大小文字統一機能を使用しない
SAMEWIDE | ON | 全角文字半角文字統一機能を使用する
OFF | 全角文字半角文字統一機能を使用しない
SAMEY | ON | 拗音統一機能を使用する
OFF | 拗音統一機能を使用しない
DELcode | ON | 削除文字指定機能を使用する
OFF | 削除文字指定機能を使用しない

(2)　記述例

検索オプション指定機能の記述例を次の図に示します。

図2-11　検索オプション指定機能の記述例

注意事項

「ON」「OFF」以外の設定値を指定した場合は，TS0F_OptMake関数（検索オプションデータの作成）で定義ファイルのフォーマットエラーになります。

2.8.4　文字統一機能

検索条件式のコンパイルを実行する時に，検索オプション指定機能を使用して検索タームをコンパイルします。コンパイル後は，検索対象文字列に対して指定された文字統一処理を実行してから検索を実行します。

文字統一機能の種別と設定値，および意味について次に示します。

表2-23　文字統一種別と定義方法

文字統一種別 | 設定値 | 意味
大小文字統一機能 | SAMECASE=ON | 英大文字と英小文字の違いを区別しない
全角文字半角文字統一機能 | SAMEWIDE=ON | 全角文字と半角文字の英数字，かたかな，および記号を区別しない
拗音統一機能 | SAMEY=ON | 拗促音文字と通常のひらがな，かたかなの違いを区別しない

複数の文字統一機能が同時に指定された場合，次の優先順位で文字統一を実行します。
拗音統一機能，全角文字半角文字統一機能，大小文字統一機能

削除文字指定機能と同時に指定した場合は，削除文字指定機能を先に実行してから，文字統一機能を実行します。

＜この項の構成＞

(1)　大小文字統一機能

(2)　全角文字半角文字統一機能

(3)　拗音統一機能

(1)　大小文字統一機能

検索対象となる文書情報には，大文字と小文字のように，表記の異なる文字が含まれています。この表記の違いによって，期待する検索結果が得られない場合があります。例えば，「HIRDB」や「hirdb」と指定して検索すると，通常は「HiRDB」が検索されません。この大小文字の違いを吸収した検索結果を得るためには，大小文字統一機能を利用します。

(2)　全角文字半角文字統一機能

全角半角文字表記の違いを吸収した検索結果を得るための機能です。この機能を使用した場合，異表記展開の全角半角異表記展開，および半角アルファベット展開を指定しても無効となります。

(3)　拗音統一機能

「ゃ」と「や」，「ょ」と「よ」など，拗音による違いを吸収した検索結果を得るための機能です。この機能を使用した場合，異表記展開のひらがな拗音展開を指定しても無効となります。

2.8.5　削除文字指定機能

検索に使用しない文字を除いて検索を実行するには，削除文字指定機能を使用します。

削除文字指定機能を利用すると，次の文字が検索対象データ情報から削除されます。

全角文字の "。"（句点），"、"（読点），全角スペース（0x8140），

半角文字の "。"（句点），"、"（読点），半角スペース（0x20），

改行コード（0x0a），（0x0d），タブコード（0x09）

2.9　検索時の注意事項

この節では，Text Search Filter Libraryで作成したUAPを使用して検索を実行する場合の注意事項について説明します。

同義語辞書テキストファイル作成時の文字コードと，実際に作成される辞書情報の文字コードが異なる場合，検索結果が不正となる可能性がありますのでご注意ください。

Text Search Plug-inの検索結果を利用する場合は，UAPで使用する「同義語辞書」および「異表記展開ルール」をText Search Plug-inで運用している内容と同様になるよう，準備してください。

Text Search Filter Libraryを使用して作成したUAPでは，指定された検索タームに該当するヒット位置情報が取得できます。単語（日本語・英語）のつづりを認識したヒット位置情報の取得はできません。

検索時に指定する文字コードは，環境変数で指定した文字コード（シフトJISコード，日本語EUCコード，UTF-8コード）を使用してください。それ以外の文字コードを使用した場合，処理結果は保証できません。

一つの文字列（単語）内に，改行，スペース，タブなどの不可視のコードが含まれる場合，ヒット位置情報の取得対象となりませんのでご注意ください。

SGML，HTMLおよびXMLの文書の場合，各文書のタグ部分をヒット位置情報として取得することがありますのでご注意ください。

検索タームおよび該当する文字列内にタグなどの制御情報が含まれている場合，ヒット位置情報の取得対象になりません。

2.10　バージョンアップ時の注意事項

この節では，Text Search Filter Library Version 3へ移行する場合の注意事項について説明します。

英文異表記展開（英単語派生表記，英単語語尾表記）を実行する場合は，Text Search Enhancer for Englishが必要です。Text Search Enhancer for Englishがない場合は，エラーとなります。

Text Search Filter Library Version 2とText Search Filter Library Version 3では，英文異表記展開結果に差異があります。詳細はマニュアル「Text Search Enhancer for English」を参照してください。

Text Search Filter Library Version 2では，全角半角異表記オプションと他の展開オプションを組み合わせると全角と半角が混在したタームに展開する場合がありましたが，Text Search Filter Library Version 3では，全角と半角が混在したタームに展開しません。

2.11　その他の注意事項

Text Search Filter Library Version 3を使用してUAPを作成する場合は，"TS0"から始まる変数名を使用しないでください。使用した場合，正常に動作しなくなることがあります。

Text Search Filter Library Version 3が動作中に同じプロセス内で，Text Search Filter Library Version 3が使用する環境変数の値を変更しないでください。変更した場合，正常に動作しなくなることがあります。

3.　API関数

この章では，Text Search Filter Libraryで提供するAPI関数について，リファレンス形式で説明します。

＜この章の構成＞

TS0F_Compile（検索条件式のコンパイル）

TS0F_Compile_Ex（検索条件式のコンパイル（検索オプション指定機能対応））

TS0F_DicMake（同義語辞書の作成）

TS0F_DicMake_Ex（同義語辞書の作成（検索オプション指定機能対応））

TS0F_Free（実行結果の解放）

TS0F_GetTermNum（条件式別のヒット数の取得）

TS0F_GetTermPos（ヒット位置情報の取得）

TS0F_Mlook（同義語・異表記展開タームの取得）

TS0F_OptMake（検索オプションデータの作成）

TS0F_Search（検索結果の取得）

TS0F_Compile（検索条件式のコンパイル）

機能

検索条件式をコンパイルします。

形式

long TS0F_Compile( long lQueryNum,
                  TS0T_QUERY *ptQuery,
                  void *pvDicData,
                  long *plCplSize,
                  void **ppvCplData )

typedef struct {
 long           lQueryId;   /*  検索条件式ID      */
 unsigned char *strQuery;   /*  検索条件式        */
 long           lExpans;    /*  異表記オプション  */
} TS0T_QUERY;

引数

lQueryNum

コンパイルする検索条件式の数を指定します。

同時にコンパイルできる検索条件式は，最大500個です。

ptQuery

コンパイルする検索条件式を指定します。

pvDicData

同義語・異表記展開検索を実行する場合は，TS0F_DicMake関数（同義語辞書の作成）で取得した同義語辞書領域のポインタを指定します。同義語・異表記展開検索を実行しない場合は，TS0D_NULLを指定します。

plCplSize

コンパイル結果の領域サイズを設定するポインタを指定します。

ppvCplData

コンパイル結果の領域のポインタを設定するポインタを指定します。

lQueryId

検索条件式IDを0～999999の範囲で指定します。

strQuery

検索条件式を指定します。

検索条件式の記述形式については，「2.6.1　検索条件式の記述形式」を参照してください。

lExpans

異表記オプションを指定します。複数の異表記オプションを組み合わせて指定することもできます。異表記オプションの詳細については，「2.6.2　異表記展開検索」を参照してください。

指定できる異表記オプションの種類を次に示します。

異表記オプション | 種類
TS0D_EXPANS_DIC | 同義語辞書異表記
TS0D_EXPANS_KANA | かたかな異表記
TS0D_EXPANS_ALPHA | アルファベット異表記
TS0D_EXPANS_HALPHA | 半角アルファベット異表記
TS0D_EXPANS_EXCHG | 全角半角異表記
TS0D_EXPANS_YOUON | ひらがな拗音異表記
TS0D_EXPANS_STEM | 英単語派生異表記※
TS0D_EXPANS_INFLECTION | 英単語語尾異表記※
TS0D_EXPANS_KANA_CHOHYPN | かたかな長音ハイフン異表記
TS0D_EXPANS_KANA_BASIC | かたかなベーシック異表記
TS0D_EXPANS_KANA_YOUON | かたかな拗音異表記
TS0D_EXPANS_NONE | 異表記展開なし

注※　この異表記オプションを使用する場合は，Text Search Enhancer for Englishが必要です。

戻り値

0　正常終了

0未満の値　異常終了

0未満の戻り値に対応するエラーコードの詳細については，「4.　エラーコード」を参照してください。

注意事項

この関数は*ppvCplDataにコンパイル結果を保存します。コンパイル結果が不要となったらTS0F_Free関数（実行結果の解放）を発行して実行結果（*ppvCplData）を解放してください。

使用する同義語辞書データは，TS0F_DicMake関数（同義語辞書の作成）で作成したものを使用してください。TS0F_DicMake_Ex（同義語辞書の作成（検索オプション指定機能対応））関数で作成した同義語辞書データを使用すると，検索結果が不正になる場合があります。

TS0F_Compile_Ex（検索条件式のコンパイル（検索オプション指定機能対応））

機能

検索オプション指定機能を指定した検索条件式をコンパイルします。

形式

long TS0F_Compile_Ex( long lQueryNum,
                     TS0T_QUERY *ptQuery,
                     void *pvDicDataEx,
                     void *pvOptData,
                     long *plCplSize,
                     void **ppvCplDataEx )

typedef struct {
 long           lQueryId;   /*  検索条件式ID      */
 unsigned char *strQuery;   /*  検索条件式        */
 long           lExpans;    /*  異表記オプション  */
} TS0T_QUERY;

引数

lQueryNum

コンパイルする検索条件式の数を指定します。

同時にコンパイルできる検索条件式は，最大500個です。

ptQuery

コンパイルする検索条件式を指定します。

pvDicDataEx

同義語・異表記展開検索を実行する場合は，TS0F_DicMake_Ex関数（同義語辞書の作成（検索オプション指定機能対応））で取得した同義語辞書領域のポインタを指定します。本同義語辞書データを取得するときに，TS0F_DicMake_Ex関数で指定する検索オプションデータは，本関数でpvOptDataとして指定するものと同じデータを指定してください。同義語・異表記展開検索を実行しない場合は，TS0D_NULLを指定します。

pvOptData

検索オプションデータを指定します。

検索オプションの指定を実行する場合は，TS0F_OptMake関数（検索オプションデータの作成）で取得した検索オプションデータ領域のポインタを指定します。

検索オプションの指定を実行しない場合は，TS0D_NULLを指定します。

plCplSize

コンパイル結果の領域サイズを設定するポインタを指定します。

ppvCplDataEx

コンパイル結果の領域のポインタを設定するポインタを指定します。

lQueryId

検索条件式IDを0～999999の範囲で指定します。

strQuery

検索条件式を指定します。

検索条件式の記述形式については，「2.6.1　検索条件式の記述形式」を参照してください。

lExpans

異表記オプションを指定します。複数の異表記オプションを組み合わせて指定することもできます。異表記オプションの詳細については，「2.6.2　異表記展開検索」を参照してください。

指定できる異表記オプションの種類を次に示します。

異表記オプション | 種類
TS0D_EXPANS_DIC | 同義語辞書異表記
TS0D_EXPANS_KANA | かたかな異表記
TS0D_EXPANS_ALPHA | アルファベット異表記
TS0D_EXPANS_HALPHA | 半角アルファベット異表記
TS0D_EXPANS_EXCHG | 全角半角異表記
TS0D_EXPANS_YOUON | ひらがな拗音異表記
TS0D_EXPANS_STEM | 英単語派生異表記※
TS0D_EXPANS_INFLECTION | 英単語語尾異表記※
TS0D_EXPANS_KANA_CHOHYPN | かたかな長音ハイフン異表記
TS0D_EXPANS_KANA_BASIC | かたかなベーシック異表記
TS0D_EXPANS_KANA_YOUON | かたかな拗音異表記
TS0D_EXPANS_NONE | 異表記展開なし

注※　この異表記オプションを使用する場合は，Text Search Enhancer for Englishが必要です。

戻り値

0　正常終了

0未満の値　異常終了

0未満の戻り値に対応するエラーコードの詳細については，「4.　エラーコード」を参照してください。

注意事項

この関数は*ppvCplDataExにコンパイル結果を保存します。コンパイル結果が不要となったらTS0F_Free関数（実行結果の解放）を発行して実行結果（*ppvCplDataEx）を解放してください。

使用する同義語辞書データは，TS0F_DicMake_Ex関数（同義語辞書の作成（検索オプション指定機能対応））で作成したものを使用してください。TS0F_DicMake（同義語辞書の作成）関数で作成した同義語辞書データを使用すると，検索結果が不正になる場合があります。

TS0F_DicMake（同義語辞書の作成）

機能

同義語辞書を作成します。

同義語辞書テキストファイルの詳細については，「2.7　同義語辞書テキストファイル」を参照してください。

形式

long TS0F_DicMake( char *strFileName,
                  long *plDicSize,
                  void **ppvDicData )

引数

strFileName

同義語辞書テキストファイル名をフルパスで指定します。

plDicSize

作成する同義語辞書領域サイズを設定するポインタを指定します。

ppvDicData

作成する同義語辞書領域のポインタを設定するポインタを指定します。

戻り値

0　正常終了

0未満の値　異常終了

0未満の戻り値に対応するエラーコードの詳細については，「4.　エラーコード」を参照してください。

注意事項

この関数は*ppvDicDataに同義語辞書データを保存します。データが不要となったら，TS0F_Free関数（実行結果の解放）を発行して実行結果（*ppvDicData）を解放してください。

この関数で作成した同義語辞書データは，TS0F_Compile関数（検索条件式のコンパイル）で使用してください。TS0F_Compile_Ex関数（検索条件式のコンパイル（検索オプション指定機能対応））で使用すると，検索結果が不正になる場合があります。

TS0F_DicMake_Ex（同義語辞書の作成（検索オプション指定機能対応））

機能

検索オプション指定機能を指定した同義語辞書を作成します。

形式

long TS0F_DicMake_Ex( char *strFileName,
                     void *pvOptData
                     long *plDicSize,
                     void **ppvDicDataEx)

引数

strFileName

同義語辞書テキストファイル名をフルパスで指定します。

pvOptData

検索オプションデータを指定します。

オプション指定を行なわない場合は，TS0D_NULLを指定します。

plDicSize

作成する同義語辞書領域サイズを設定するポインタを指定します。

ppvDicDataEx

作成する同義語辞書領域のポインタを設定するポインタを指定します。

戻り値

0　正常終了

0未満の値　異常終了

0未満の戻り値に対応するエラーコードの詳細については，「4.　エラーコード」を参照してください。

注意事項

この関数は*ppvDicDataExに同義語辞書データを保存します。データが不要となったら，TS0F_Free関数（実行結果の解放）を発行して実行結果（*ppvDicDataEx）を解放してください。

この関数で作成した同義語辞書データは，TS0F_Compile_Ex関数（検索条件式のコンパイル（検索オプション指定機能対応））で使用してください。TS0F_Compile関数（検索条件式のコンパイル）で使用すると，検索結果が不正になる場合があります。

TS0F_Free（実行結果の解放）

機能

実行結果領域を解放します。

形式

long TS0F_Free( void *pvResult )

引数

pvResult

API関数を実行して取得した，実行結果領域のポインタを指定します。

戻り値

0　正常終了

0未満の値　異常終了

0未満の戻り値に対応するエラーコードの詳細については，「4.　エラーコード」を参照してください。

TS0F_GetTermNum（条件式別のヒット数の取得）

機能

ヒット位置情報を取得します。条件式別のヒット数の取得を行ないます。

形式

long TS0F_GetTermNum( long  ITextSize,
                     unsigned char *strTextData,
                     void *pvCplData,
                     TS0T_HITNUM **pptHitNum,long *plHitNumCnt)
typedef struct {
 long lQueryId;   /*  条件式ID  */
 long lHitNum;    /*  ヒット数   */
} TS0T_HITNUM;

引数

lTextSize

検索対象のテキストサイズを指定します。

strTextData

検索対象のテキストデータのポインタを指定します。

pvCplData

TS0F_Compile関数（検索条件式のコンパイル）,またはTS0F_Compile_Ex関数（検索条件式のコンパイル（検索オプション指定機能対応））で取得した，コンパイル結果を指定します。

pptHitNum

条件式別のヒット数情報を設定するテーブルのポインタを指定します。

plHitNumCnt

条件式別のヒット数情報を設定するテーブルのエントリ数を指定します。

戻り値

0　正常終了

0未満の値　異常終了

0未満の戻り値に対応するエラーコードの詳細については，「4.　エラーコード」を参照してください。

注意事項

この関数は*pptHitNumにヒット数情報を保存します。データが不要となったら，TS0F_Free関数（実行結果の解放）を発行して実行結果（*pptHitNum）を解放してください。

TS0F_GetTermPos（ヒット位置情報の取得）

機能

ヒット位置情報を取得します。

形式

long TS0F_GetTermPos( long  lTextSize,
                     unsigned char *strTextData,
                     void *pvCplData,
                     long lQueryId,
                     TS0T_HITPOS *ptHitPos,
                     long lHitPosEnt,
                     long *plHitPosCnt )
typedef struct {
 long lHitPos;   /*  ヒットした位置  */
 long lHitLL;    /*  ヒットした長さ  */
} TS0T_HITPOS;

引数

lTextSize

検索対象のテキストサイズを指定します。

strTextData

検索対象のテキストデータのポインタを指定します。

pvCplData

TS0F_Compile関数（検索条件式のコンパイル）で取得した，コンパイル結果を指定します。

lQueryId

ヒット位置情報を取得したい検索条件式IDを指定します。

コンパイルしたすべての検索条件式のヒット位置情報を取得したい場合は，TS0D_QUERYID_ALLを指定してください。

ptHitPos

ヒット位置情報を設定するテーブルのポインタを指定します。

lHitPosEnt

ヒット位置情報を設定するテーブルのエントリ数を指定します。

plHitPosCnt

ヒット位置情報件数を設定する領域のポインタを指定します。

戻り値

0　正常終了

0未満の値　異常終了

0未満の戻り値に対応するエラーコードの詳細については，「4.　エラーコード」を参照してください。

注意事項

ヒット位置情報件数が多いため，すべてのヒット位置情報をデータベースのテーブルに格納できない場合は，エラーコード-302600（エラーマクロ名称TS0E_HITPOS_FULL）が戻り値として返されます。このとき，ヒット位置情報は，引数lHitPosEntに指定したエントリ数だけが取得されます。

TS0F_Compile_Ex関数（検索条件式のコンパイル（検索オプション指定機能対応））で取得したコンパイル情報を使用するとエラーになります。

TS0F_Mlook（同義語・異表記展開タームの取得）

機能

同義語・異表記展開された検索タームを取得します。指定した検索タームも，同義語・異表記展開の結果に含めて取得できます。

同義語・異表記展開されたタームは，引数ppvMlookDataで示す領域に次の形式で格納されます。

図3-1　同義語・異表記展開された検索タームの格納形式

形式

long TS0F_Mlook( unsigned char *strTerm,
                long lExpans,
                void *pvDicData,
                long *plMlookSize,
                void **ppvMlookData )

引数

strTerm

同義語・異表記展開する検索タームを，'（アポストロフィ）で囲んで指定します。検索タームを複数指定する場合は，検索タームを,（コンマ）で区切って指定してください。

（例）

検索タームを「日本代表」とする場合
'日本代表'

検索タームを「日本」および「代表」とする場合
'日本','代表'

lExpans

異表記オプションを指定します。複数の異表記オプションを組み合わせて指定することもできます。異表記オプションの詳細については，「2.6.2　異表記展開検索」を参照してください。

指定できる異表記オプションの種類を次に示します。

異表記オプション | 種類
TS0D_EXPANS_DIC | 同義語辞書異表記
TS0D_EXPANS_KANA | かたかな異表記
TS0D_EXPANS_ALPHA | アルファベット異表記
TS0D_EXPANS_HALPHA | 半角アルファベット異表記
TS0D_EXPANS_EXCHG | 全角半角異表記
TS0D_EXPANS_YOUON | ひらがな拗音異表記
TS0D_EXPANS_STEM | 英単語派生異表記※
TS0D_EXPANS_INFLECTION | 英単語語尾異表記※
TS0D_EXPANS_KANA_BASIC | かたかなベーシック異表記
TS0D_EXPANS_KANA_CHOHYPN | かたかな長音ハイフン異表記
TS0D_EXPANS_KANA_YOUON | かたかな拗音異表記
TS0D_EXPANS_NONE | 異表記展開なし

注※　この異表記オプションを使用する場合は，Text Search Enhancer for Englishが必要です。

pvDicData

同義語展開検索を実行する場合は，TS0F_DicMake関数（同義語辞書の作成）,またはTS0F_DicMake_Ex関数（同義語辞書の作成（検索オプション指定機能対応））で取得した同義語辞書領域のポインタを指定します。同義語展開検索を実行しない場合は，TS0D_NULLを指定します。

plMlookSize

同義語・異表記展開結果の領域サイズを設定するポインタを指定します。

ppvMlookData

同義語・異表記展開結果の領域のポインタを設定するポインタを指定します。

戻り値

0　正常終了

0未満の値　異常終了

0未満の戻り値に対応するエラーコードの詳細については，「4.　エラーコード」を参照してください。

注意事項

この関数は*ppvMlookDataに実行結果を保存します。データが不要となったら，TS0F_Free関数（実行結果の解放）を発行して実行結果（*ppvMlookData）を解放してください。

この関数の発行後は，TS0F_Free関数（実行結果の解放）を発行して実行結果（*ppvMlookData）を解放してください。

指定した検索タームは，同義語辞書異表記展開の結果に含まれています。

TS0F_OptMake（検索オプションデータの作成）

機能

検索オプションデータを作成します。

形式

long TS0F_OptMake( char *strFilename,
                  long  *plOptSize,
                  void **ppvOptdata )

引数

strFilename

検索オプション設定ファイル名をフルパスで指定します。

plOptSize

作成された検索オプションデータの領域サイズを設定するポインタを指定します。

ppvOptData

作成された検索オプションデータのポインタを設定するポインタを指定します。

戻り値

0　正常終了

0未満の値　異常終了

0未満の戻り値に対応するエラーコードの詳細については，「4.　エラーコード」を参照してください。

注意事項

この関数は*ppvOptDataに検索オプションのデータを保存します。データが不要となったら，TS0F_Free関数（実行結果の解放）を発行して実行結果（*ppvOptData）を解放してください。

TS0F_Search（検索結果の取得）

機能

検索を行います。

形式

long TS0F_Search( long  lTextSize,
                 unsigned char *strTextData,
                 void *pvCplData,
                 long *plHitCnt,
                 long **pplQueryId )

引数

lTextSize

検索対象のテキストサイズを指定します。

strTextData

検索対象のテキストデータポインタを指定します。

pvCplData

TS0F_Compile関数（検索条件式のコンパイル），またはTS0F_Compile_Ex関数（検索条件式のコンパイル（検索オプション指定機能対応））で取得したコンパイル結果を指定します。

plHitCnt

ヒットした検索条件式数を設定するポインタを指定します。

pplQueryId

ヒットした検索条件式IDの領域のポインタを設定するポインタを指定します。

戻り値

0　正常終了

0未満の値　異常終了

0以外の戻り値に対応するエラーコードの詳細については，「4.　エラーコード」を参照してください。

注意事項

この関数は*ppIQueryIdに検索条件式IDのデータを保存します。データが不要となったら，TS0F_Free関数（実行結果の解放）を発行して実行結果（*ppvIQueryId）を解放してください。

4.　エラーコード

この章では，Text Search Filter Libraryで提供するAPI関数が異常終了したときに，戻り値として出力されるエラーコードの詳細について説明します。

＜この章の構成＞

4.1　エラーコードの見方

4.2　システムエラー

4.3　API関数の引数エラー

4.4　API関数実行中に発生したエラー

4.1　エラーコードの見方

この節では，API関数が異常終了したときに，戻り値として出力されるエラーコードの分類について説明します。また，このマニュアルで説明するエラーコードの記述形式について説明します。

＜この節の構成＞

4.1.1　エラーコードの分類

4.1.2　エラーコードの記述形式

4.1.1　エラーコードの分類

エラーコードは，次の表に示す範囲で分類されます。

表4-1　エラーコードの範囲と意味

エラーコード | 意味
-100001～-199999 | システムエラー
-200001～-209999 | API関数の引数エラー
-300001～-309999 | API関数の実行中に発生したエラー

4.1.2　エラーコードの記述形式

このマニュアルでは，エラーコードの意味を次の形式で説明します。

なお，エラーコードおよびマクロ名称は，インクルードファイル「TS0lib.h」で宣言されています。

エラーコード

マクロ名称

原因

エラーが発生した原因を説明しています。

対策

エラーを解除する対策を説明しています。

なお，対策の「保守員に連絡してください」とは，購入時の契約に基づいて，システム管理者が弊社問い合わせ窓口へ連絡することを示します。

以降の4.2節～4.4節で，分類ごとのエラーコードの詳細をエラーコード順に説明します。

4.2　システムエラー

この節では，システムエラーが発生した場合に出力されるエラーコードを示します。なお，［Windows］と表記されているエラーコードは，適用OSがWindows NTまたはWindows 2000の場合に出力されます。

-100100

TS0E_NOMEM

原因

メモリが不足しています。

対策

メモリを大量に消費しているアプリケーションプログラムを終了してから，再実行してください。

-100200

TS0E_CANT_OPEN_KANARULE

原因

かたかな異表記のルールファイルのオープンに失敗しました。

提供モジュールの内容に誤りがあります。

対策

Text Search Filter Libraryを再インストールしてください。

-100300

TS0E_LLIST_P2O_ERR

原因

論理リストポインタからオフセットへの変換時にエラーが発生しました。

対策

保守員に連絡してください。

-100400

TS0E_LLIST_TYPE_ERR

原因

論理リスト種別エラーが発生しました。

対策

保守員に連絡してください。

-100500

TS0E_INVALID_BITLIST

原因

ビットリストエラーが発生しました。

対策

保守員に連絡してください。

-100600

TS0E_INVALID_TID

原因

TIDエラーが発生しました。

対策

保守員に連絡してください。

-100700

TS0E_ILLEGAL_CODE

原因

誤りがあるコードを検出しました。

対策

保守員に連絡してください。

-100800

TS0E_PTR_NO_EXIST

原因

ポインタ管理テーブルエラーが発生しました。

対策

保守員に連絡してください。

-100900

TS0E_AG_STAT_OVERFLOW

原因

内部テーブルがオーバーフローしました。

対策

検索条件式または検索タームを減らしてから，再実行してください。

-101000［Windows］

TS0E_NO_REGKEY

原因

レジストリキーがありません。

対策

Text Search Filter Libraryを正しくインストールしてください。

-101100［Windows］

TS0E_REGOPENKEYEX_ERROR

原因

RegOpenKeyEx()に失敗しました。

対策

GetLastError()を実行してエラー情報を取得してください。

-101200［Windows］

TS0E_REGOPENVALUEEX_ERROR

原因

RegQueryValueEx()に失敗しました。

対策

GetLastError()を実行してエラー情報を取得してください。

-101300［Windows］

TS0E_DLL_NOT_EXIST

原因

DLLがありません。

対策

Text Search Filter Libraryを正しくインストールしてください。

-101400［Windows］

TS0E_CANNOT_LOADLIBRARY

原因

ライブラリのロードに失敗しました。

対策

GetLastError()を実行してエラー情報を取得してください。

-101500［Windows］

TS0E_NO_FUNC_ADDR

原因

関数アドレスが未解決です。

対策

Text Search Filter Libraryを正しくインストールしてください。

-101600

TS0E_NO_EXTTERMLIB

原因

拡張タームライブラリがありません。

対策

Text Search Filter Libraryを正しくインストールしてください。

-101700

TS0E_GETEXTERM

原因

拡張ターム取得でエラーが発生しました。

対策

保守員に連絡してください。

-101800

TS0E_ENGOPT_FILE_IOERR

原因

Text Search Enhancer for Englishの環境が不正です。

対策

提供モジュールの内容が正しくないためText Search Enhancer for Englishの再インストールを行ってください。

4.3　API関数の引数エラー

この節では，API関数の引数エラーが発生した場合に出力されるエラーコードを示します。

-200100

TS0E_INVALID_QNUM

原因

検索条件式数に誤りがあります。

対策

検索条件式数を正しく指定して再実行してください。

-200200

TS0E_INVALID_QTBLPTR

原因

検索条件式テーブルのポインタに誤りがあります。

対策

検索条件式テーブルのポインタを正しく指定して再実行してください。

-200300

TS0E_INVALID_RSIZPTR

原因

実行結果サイズ設定領域のポインタに誤りがあります。

対策

実行結果サイズ設定領域のポインタを正しく指定して再実行してください。

-200400

TS0E_INVALID_RDATPTR

原因

実行結果ポインタ設定領域のポインタに誤りがあります。

対策

実行結果ポインタ設定領域のポインタを正しく指定して再実行してください。

-200500

TS0E_INVALID_FNAMEPTR

原因

ファイル名称ポインタに誤りがあります。

対策

ファイル名称ポインタを正しく指定して再実行してください。

-200600

TS0E_INVALID_TSIZE

原因

テキストデータのサイズに誤りがあります。

対策

テキストデータのサイズを正しく指定して再実行してください。

-200700

TS0E_INVALID_TPTR

原因

テキストデータのポインタに誤りがあります。

対策

テキストデータのポインタを正しく指定して再実行してください。

-200800

TS0E_INVALID_CPLDAT

原因

コンパイルデータのポインタに誤りがあります。

対策

コンパイルデータのポインタを正しく指定して再実行してください。

-200900

TS0E_INVALID_QUERYID

原因

検索条件式IDに誤りがあります。

対策

検索条件式IDを正しく指定して再実行してください。

-201000

TS0E_DUPLICATE_QID

原因

検索条件式IDを重複して指定しています。

対策

検索条件式IDを正しく指定して再実行してください。

-201100

TS0E_INVALID_QUERYPTR

原因

検索条件式のポインタに誤りがあります。

対策

検索条件式のポインタを正しく指定して再実行してください。

-201200

TS0E_INVALID_EXPANS

原因

異表記オプションに誤りがあります。

対策

異表記オプションを正しく指定して再実行してください。

-201300

TS0E_INVALID_HITCNTPTR

原因

ヒット件数設定領域のポインタに誤りがあります。

対策

ヒット件数設定領域のポインタを正しく指定して再実行してください。

-201400

TS0E_INVALID_QIDPTR

原因

ヒット条件式ID設定領域のポインタに誤りがあります。

対策

ヒット条件式ID設定領域のポインタを正しく指定して再実行してください。

-201500

TS0E_INVALID_HITPOSPTR

原因

ヒット位置情報設定ポインタに誤りがあります。

対策

ヒット位置情報設定ポインタを正しく指定して再実行してください。

-201600

TS0E_INVALID_HITPOSENT

原因

ヒット位置情報設定エントリ数に誤りがあります。

対策

ヒット位置情報設定エントリ数を正しく指定して再実行してください。

-201700

TS0E_INVALID_POSCNTPTR

原因

ヒット位置情報件数設定領域のポインタに誤りがあります。

対策

ヒット位置情報件数設定領域のポインタを正しく指定して再実行してください。

-201800

TS0E_EYECHATCHER_ERRH

原因

実行結果ヘッダのアイキャッチャに誤りがあります。

対策

正しい実行結果を指定して再実行してください。

-201900

TS0E_EYECHATCHER_ERRF

原因

実行結果フッタのアイキャッチャに誤りがあります。

対策

正しい実行結果を指定して再実行してください。

-202000

TS0E_ENDIEN_NOMATCH

原因

異なるエンディアンのマシンで作成した実行結果を指定しています。

対策

同じエンディアンのマシンで作成した実行結果を指定して再実行してください。

-202100

TS0E_RSLT_HEAD_ERR

原因

実行結果ヘッダに誤りがあります。

対策

正しい実行結果を指定して再実行してください。

-202200

TS0E_NOTSUPPORT_CODERSLT

原因

サポートしていない文字コードの実行結果を指定しています。

対策

正しい実行結果を指定して再実行してください。

-202300

TS0E_RSLT_SIZE_ERR

原因

実行結果サイズに誤りがあります。

対策

正しい実行結果を指定して再実行してください。

-202400

TS0E_RSLT_ID_NOMATCH

原因

指定した実行結果に誤りがあります。

対策

正しい実行結果を指定して再実行してください。

-202500

TS0E_RSLT_ID_ERROR

原因

実行結果種別に誤りがあります。

対策

正しい実行結果を指定して再実行してください。

-202600

TS0E_INVALID_RSLTPTR

原因

実行結果ポインタに誤りがあります。

対策

実行結果ポインタを正しく指定して再実行してください。

-202700

TS0E_NO_CALLBACKFUNC

原因

コールバック関数ポインタに誤りがあります。

対策

コールバック関数ポインタを正しく指定して再実行してください。

-202800

TS0E_NOTSUPPORT_CODEMODE

原因

実行時のコード種別に誤りがあります。

対策

コード種別を見直して再実行してください。

-202900

TS0E_INVALID_TERMPTR

原因

検索タームのポインタに誤りがあります。

対策

検索タームのポインタを正しく指定して再実行してください。

-204300

TS0E_INVALID_OPTDAT

原因

検索オプションデータのポインタが不正です。

対策

検索オプションデータのポインタを正しく設定して再実行してください。

-204400

TS0E_INVALID_HITNUMPTR

原因

条件式別ヒット数設定領域のポインタが不正です。

対策

条件式別ヒット数設定領域のポインタを正しく設定して再実行してください。

-204500

TS0E_INVALID_HITNUMCNTPTR

原因

条件式別ヒット数のエントリ数設定領域のポインタが不正です。

対策

条件式別ヒット数のエントリ数設定領域のポインタを正しく設定して再実行してください。

4.4　API関数実行中に発生したエラー

この節では，API関数の実行中にエラーが発生した場合に出力されるエラーコードを示します。

-300100

TS0E_INVALID_OPE

原因

演算子に誤りがあります。

対策

検索条件式を見直して再実行してください。

-300200

TS0E_OPE_NESTERR

原因

演算子のネストに誤りがあります。

対策

検索条件式を見直して再実行してください。

-300300

TS0E_OPE_NO_LKK

原因

演算子の次に左括弧がありません。

対策

検索条件式を見直して再実行してください。

-300400

TS0E_OPE_NO_RKK

原因

演算子の終わりに右括弧がありません。

対策

検索条件式を見直して再実行してください。

-300500

TS0E_TOO_SHORT_ITEM

原因

演算子中の項の数が少なすぎます。

対策

検索条件式を見直して再実行してください。

-300600

TS0E_TOO_MUCH_ITEM

原因

演算子の中の項数が多過ぎます。

対策

検索条件式を見直して再実行してください。

-300700

TS0E_NOT_TERM_EQ

原因

eq演算子の中に検索タームがありません。

対策

検索条件式を見直して再実行してください。

-300800

TS0E_ITEM_DLMT

原因

項のデリミタに誤りがあります。

対策

検索条件式を見直して再実行してください。

-300900

TS0E_ILLEGAL_TERM1

原因

1バイト文字のコード，または2バイト文字の上位コード（1バイト目）に誤りがあります。

対策

検索条件式を見直して再実行してください。

-301000

TS0E_ILLEGAL_TERM2

原因

2バイト文字の下位コード（2バイト目）に誤りがあります。

対策

検索条件式を見直して再実行してください。

-301100

TS0E_ILLEGAL_TERMEND

原因

検索ターム中にNULLがあります。

対策

検索条件式を見直して再実行してください。

-301200

TS0E_NOT_EXIST_TERM

原因

検索タームがありません。

対策

検索条件式を見直して再実行してください。

-301300

TS0E_AFT_ESCAPE_TERM

原因

¥（エスケープ文字）の次の文字に誤りがあります。

対策

検索条件式を見直して再実行してください。

-301400

TS0E_NOT_ESCAPE_TERM

原因

直前に¥（エスケープ文字）が必要な文字に対して，エスケープ文字が指定されていません。

対策

検索条件式を見直して再実行してください。

-301500

TS0E_QUERY_NONULL

原因

検索条件式の最後がNULLになっていません。

対策

検索条件式を見直して，再実行してください。

-301600

TS0E_DICSRC_NOTEXIST

原因

同義語辞書テキストファイルがありません。

対策

同義語辞書テキストファイルを確認して再実行してください。

-301700

TS0E_DICSRC_CANNOTOPEN

原因

同義語辞書テキストファイルがオープンできません。

対策

同義語辞書テキストファイルの存在およびアクセス権を確認して再実行してください。

-301800

TS0E_DICSRC_HEAD_KONMA

原因

同義語辞書テキストファイルの行が ，（コンマ）で始まっています。

対策

同義語辞書テキストファイルを見直して再実行してください。

-301900

TS0E_DICSRC_CHAIN_KONMA

原因

同義語辞書テキストファイル中で ，（コンマ）が連続しています。

対策

同義語辞書テキストファイルを見直して再実行してください。

-302000

TS0E_DICSRC_LAST_KONMA

原因

同義語辞書テキストファイルの最後が ，（コンマ）になっています。

対策

同義語辞書テキストファイルを見直して再実行してください。

-302100

TS0E_DICSRC_EXIST_1BYTE

原因

同義語辞書テキストファイル中に半角文字があります。

対策

同義語辞書テキストファイルを見直して再実行してください。

-302200

TS0E_DICSRC_ILLEGAL_CODE1

原因

同義語辞書テキストファイルの1バイト文字のコード，または2バイト文字の上位コード（1バイト目）に誤りがあります。

対策

同義語辞書テキストファイルを見直して再実行してください。

-302300

TS0E_DICSRC_ILLEGAL_CODE2

原因

同義語辞書テキストファイルの2バイト文字の下位コード（2バイト目）に誤りがあります。

対策

同義語辞書テキストファイルを見直して再実行してください。

-302400

TS0E_DICSRC_EMPTY

原因

同義語辞書テキストファイル中に有効なデータがありません。

対策

同義語辞書テキストファイルを見直して再実行してください。

-302450

TS0E_DICSRC_BKSCHAR

原因

同義語辞書テキストファイル中の¥（エスケープ文字）の次に誤りがあります。

対策

同義語辞書テキストファイルを見直して再実行してください。

-302500

TS0E_QUERYID_NOTEXIST

原因

指定した検索条件式IDがコンパイル結果中にありません。

対策

検索条件式IDを見直して再実行してください。

-302600

TS0E_HITPOS_FULL

原因

位置情報設定テーブルがオーバーフローしました。

対策

位置情報設定テーブルのエントリ数を拡張して再実行してください。

ただし，指定されたエントリ数までは位置情報が設定されています。

-302700

TS0E_CALLBACKFUNCERR

原因

コールバック関数でエラーが発生しました。

対策

コールバック関数を見直してください。

-302800

TS0E_TEXTSIZE_OVER2G

原因

検索対象のテキストサイズが上限（2ギガバイト）を超えました。

対策

検索対象のテキストを見直してください。

-302900

TS0E_TERM_DLMT

原因

検索タームのデリミタに誤りがあります。

対策

検索条件式を見直して再実行してください。

-303100

TS0E_NOT_INSTALL_ENGOPT

原因

Text Search Enhancer for Englishがインストールされていません。

対策

Text Search Enhancer for Englishをインストールしてください。

-303200

TS0E_INVALID_LANGCODE

原因

環境変数で指定した文字コードが不正です。

対策

環境変数を見直して再実行してください。

-303500

TS0E_DICSRC_ILLEGAL_CODEN

原因

辞書ソースファイル文字コードエラー（マルチバイト文字の1～6byte目）。

対策

辞書ソースファイルを見直して再実行してください。

-303600

TS0E_ILLEGAL_TERMN

原因

文字コードが不正です（マルチバイト文字の1～6byte目）。

対策

検索条件式を見直して，再実行してください。

-303700

TS0E_OPTDEF_NOTEXIST

原因

検索オプション定義ファイルがありません。

対策

検索オプション定義ファイルを確認して再実行してください。

-303800

TS0E_OPTDEF_CANNOTOPEN

原因

検索オプション定義ファイルがオープンできません。

対策

検索オプション定義ファイルの存在または，アクセス権を確認して再実行してください。

-303900

TS0E_OPTDEF_SAMECASE_DOUBLE

原因

検索オプション定義ファイル中でSAMECASEが２度定義されています。

対策

検索オプション定義ファイルを見直して再実行してください。

-304000

TS0E_OPTDEF_SAMECASE_INVALID

原因

検索オプション定義ファイル中でSAMECASEの定義値が不正です。

対策

検索オプション定義ファイルを見直して再実行してください。

-304100

TS0E_OPTDEF_SAMECASE_NOVALUE

原因

検索オプション定義ファイル中でSAMECASEの定義値がありません。

対策

検索オプション定義ファイルを見直して再実行してください。

-304200

TS0E_OPTDEF_SAMEWIDE_DOUBLE

原因

検索オプション定義ファイル中でSAMEWIDEが２度定義されています。

対策

検索オプション定義ファイルを見直して再実行してください。

-304300

TS0E_OPTDEF_SAMEWIDE_INVALID

原因

検索オプション定義ファイル中でSAMEWIDEの定義値が不正です。

対策

検索オプション定義ファイルを見直して再実行してください。

-304400

TS0E_OPTDEF_SAMEWIDE_NOVALUE

原因

検索オプション定義ファイル中でSAMEWIDEの定義値がありません。

対策

検索オプション定義ファイルを見直して再実行してください。

-304500

TS0E_OPTDEF_SAMEY_DOUBLE

原因

検索オプション定義ファイル中でSAMEYが２度定義されています。

対策

検索オプション定義ファイルを見直して再実行してください。

-304600

TS0E_OPTDEF_SAMEY_INVALID

原因

検索オプション定義ファイル中でSAMEYの定義値が不正です。

対策

検索オプション定義ファイルを見直して再実行してください。

-304700

TS0E_OPTDEF_SAMEY_NOVALUE

原因

検索オプション定義ファイル中でSAMEYの定義値がありません。

対策

検索オプション定義ファイルを見直して再実行してください。

-305300

TS0E_OPTDEF_DELCODE_DOUBLE

原因

検索オプション定義ファイル中でDELCODEが２度定義されています。

対策

検索オプション定義ファイルを見直して再実行してください。

-305400

TS0E_OPTDEF_DELCODE_NOVALUE

原因

検索オプション定義ファイル中でDELCODEの定義値がありません。

対策

検索オプション定義ファイルを見直して再実行してください。

-305500

TS0E_OPTDEF_INVALIDDEF

原因

検索オプション定義ファイル中で不正な定義項目があります。

対策

検索オプション定義ファイルを見直して再実行してください。

索引

[Ａ][Ｅ][Ｆ][Ｔ][Ｕ]
[ア行][カ行][サ行][タ行][ハ行][マ行][ラ行]

(英字)

(Ａ)

API関数

API関数一覧

API関数実行中に発生したエラー

API関数の発行順序

API関数の引数エラー

(Ｅ)

eq

(Ｆ)

fand

fnot

for

(Ｔ)

TS0D_EXPANS_ALPHA

TS0D_EXPANS_DIC

TS0D_EXPANS_EXCHG

TS0D_EXPANS_HALPHA

TS0D_EXPANS_INFLECTION

TS0D_EXPANS_KANA

TS0D_EXPANS_KANA_BASIC

TS0D_EXPANS_KANA_CHOHYPN

TS0D_EXPANS_KANA_YOUON

TS0D_EXPANS_STEM

TS0D_EXPANS_YOUON

TS0F_Compile

TS0F_Compile_Ex

TS0F_DicMake

TS0F_DicMake_Ex

TS0F_Free

TS0F_GetTermNum

TS0F_GetTermPos

TS0F_Mlook

TS0F_OptMake

TS0F_Search

(Ｕ)

UAP作成時に必要なプログラム

UAP実行時に必要なプログラム

UAPの作成

(ア行)

(あ)

アルファベット異表記

(い)

異表記オプション

異表記オプションの種類

異表記展開検索

異表記の展開例

(え)

英単語語尾異表記

英単語派生異表記

エラーコード

エラーコードの記述形式

エラーコードの範囲と意味

エラーコードの分類

エラーコードの見方

演算子

(カ行)

(か)

かたかな異表記

かたかな長音ハイフン異表記

かたかなベーシック異表記

かたかな拗音異表記

(け)

検索オプション指定および検索結果取得時のAPI関数の発行順序

検索オプション指定機能

検索オプション指定機能

検索オプションデータの作成

検索結果の取得

検索結果の取得機能

検索結果の取得時のAPI関数の発行順序

検索時の注意事項

検索条件式

検索条件式に指定する演算子

検索条件式の記述形式

検索条件式のコンパイル

検索条件式のコンパイル

検索条件式別のヒット数取得機能

検索条件式別のヒット数取得時のAPI関数の発行順序

検索ターム

検索ターム

(こ)

コンパイル

コンパイル時に推奨するコンパイラ

コンパイル方法およびリンケージ方法（AIXの場合）

コンパイル方法およびリンケージ方法（HP-UXの場合）

コンパイル方法およびリンケージ方法（Windowsの場合）

(サ行)

(さ)

削除文字指定機能

削除文字指定機能

(し)

システムエラー

実行結果の解放

条件式別のヒット数の取得

使用できる文字

(せ)

全角半角異表記

前提プログラム

(そ)

その他の注意事項

(タ行)

(て)

提供するファイルおよびAPI関数一覧

提供するファイルの構成（AIXの場合）

提供するファイルの構成（HP-UXの場合）

提供するファイルの構成（Windowsの場合）

(と)

同義語・異表記展開結果の取得機能

同義語・異表記展開された検索タームの格納形式

同義語・異表記展開ターム取得時のAPI関数の発行順序

同義語・異表記展開タームの取得

同義語辞書

同義語辞書異表記

同義語辞書テキストファイル

同義語辞書テキストファイルの記述形式

同義語辞書テキストファイルの記述例

同義語辞書の作成

同義語辞書の作成

(ハ行)

(は)

バージョンアップ時の注意事項

半角アルファベット異表記

(ひ)

ヒット位置情報

ヒット位置情報取得時のAPI関数の発行順序

ヒット位置情報の取得

ヒット位置情報の取得機能

ひらがな拗音異表記

(ふ)

ファイル一覧

(マ行)

(ま)

マルチスレッド実行機能

(も)

文字統一機能

文字統一機能

(ラ行)

(り)

リンケージ

(ろ)

論理積

論理否定

論理和

■ 商標類

AIXは，米国における米国International Business Machines Corp.の登録商標です。
IBMは，米国における米国International Business Machines Corp.の登録商標です。
HP-UXは，米国Hewlett-Packard Companyのオペレーティングシステムの名称です。
Microsoftは，米国およびその他の国における米国Microsoft Corp.の登録商標です。
UNIXは，X/Open Company Limitedが独占的にライセンスしている米国ならびに他の国における登録商標です。
VisualAgeは，米国における米国International Business Machines Corp.の商標です。
Visual C++は，米国およびその他の国における米国Microsoft Corp.の登録商標です。
Visual Studioは，米国およびその他の国における米国Microsoft Corp.の登録商標です。
Win32は，米国およびその他の国における米国Microsoft Corp.の登録商標です。
Windowsは，米国およびその他の国における米国Microsoft Corp.の登録商標です。
Windows NTは，米国およびその他の国における米国Microsoft Corp.の登録商標です。
Windows Serverは，米国およびその他の国における米国Microsoft Corp.の商標です。
X/Openは，X/Open Company Limited の英国ならびに他の国における登録商標です。
すべてのSPARC商標は，米国SPARC International, Inc. のライセンスを受けて使用している同社の米国およびその他の国における商標または登録商標です。SPARC商標がついた製品は，米国Sun Microsystems, Inc. が開発したアーキテクチャに基づくものです。