BtrieveFilter クラス

Btrieve フィルター クラス。 [詳解]

#include <btrieveCpp.h>

公開メンバ関数
	BtrieveFilter ()
	~BtrieveFilter ()
Btrieve::StatusCode	SetACSMode (Btrieve::ACSMode ACSMode)
	代替照合順序モードを設定します。 [詳解]
Btrieve::StatusCode	SetACSName (const char *name)
	代替照合順序名を設定します。 [詳解]
Btrieve::StatusCode	SetACSUserDefined (const char *name)
	ユーザー定義の代替照合順序名を設定します。 [詳解]
Btrieve::StatusCode	SetComparison (Btrieve::Comparison comparison)
	比較を設定します。 [詳解]
Btrieve::StatusCode	SetComparisonConstant (const char *constant, int constantLength)
	比較定数を設定します。 [詳解]
Btrieve::StatusCode	SetComparisonField (int offset)
	比較フィールドを設定します。 [詳解]
Btrieve::StatusCode	SetConnector (Btrieve::Connector connector)
	フィールド コネクタを設定します。 [詳解]
Btrieve::StatusCode	SetField (int offset, int length, Btrieve::DataType dataType)
	フィールドを設定します。 [詳解]
Btrieve::StatusCode	SetLikeCodePageName (const char *name)
	比較の種類 Like（類似）や Not Like（類似しない）で使用するコード ページ名を設定します。 [詳解]

詳解

Btrieve フィルター クラス。

各種例:

bfilter.cpp, btestbulk.cpp.

構築子と解体子

BtrieveFilter()

BtrieveFilter::BtrieveFilter

(

)

スニペット

   BtrieveFilter btrieveFilter;

~BtrieveFilter()

BtrieveFilter::~BtrieveFilter

(

)

関数詳解

SetACSMode()

Btrieve::StatusCode BtrieveFilter::SetACSMode

(

Btrieve::ACSMode

ACSMode

)

代替照合順序モードを設定します。

覚え書き

このメソッドは、PSQL v13 R2 で BtrieveFilter::SetCaseSensitivity に取って代わりました。

引数

[in]

ACSMode

代替照合順序モード。

説明

代替照合順序モードは、デフォルトで Btrieve::ACS_MODE_NONE に設定されます。代替照合順序モードを Btrieve::ACS_MODE_NAMED に設定するには、BtrieveFilter::SetACSName または BtrieveFilter::SetACSUserDefined を使用します。Btrieve::ACS_MODE_NUMBERED はサポートされていません。

スニペット

   // If SetCaseSensitivity() fails.
   if ((status = btrieveFilter.SetACSMode(Btrieve::ACS_MODE_CASE_INSENSITIVE)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveFilter::SetACSMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照

Btrieve::StatusCodeToString

各種例:

bfilter.cpp.

SetACSName()

Btrieve::StatusCode BtrieveFilter::SetACSName

(

const char *

name

)

代替照合順序名を設定します。

引数

[in]

name

名前。

説明

初期の状態では、フィルターに代替照合順序名は含まれていません。代替照合順序名を参照するには、ファイル内にそれが存在している必要があります。代替照合順序名は、インデックスの作成時にファイルに追加することができます。BtrieveFile::IndexCreate を参照してください。

スニペット

   // If SetACSName() fails.
   if ((status = btrieveFilter.SetACSName("u54-msft_enus_0")) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveFilter::SetACSName():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照

Btrieve::StatusCodeToString

各種例:

bfilter.cpp.

SetACSUserDefined()

Btrieve::StatusCode BtrieveFilter::SetACSUserDefined

(

const char *

name

)

ユーザー定義の代替照合順序名を設定します。

引数

[in]

name

名前。

説明

初期の状態では、フィルターにユーザー定義の代替照合順序名は含まれていません。ユーザー定義の代替照合順序を参照するには、ファイル内にそれが存在している必要があります。ユーザー定義の代替照合順序は、インデックスの作成時にファイルに追加することができます。BtrieveFile::IndexCreate を参照してください。

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照

Btrieve::StatusCodeToString

SetComparison()

Btrieve::StatusCode BtrieveFilter::SetComparison

(

Btrieve::Comparison

comparison

)

比較を設定します。

引数

[in]

comparison

比較。

説明

比較のデフォルト値は Btrieve::COMPARISON_NONE です。

スニペット

   // If SetComparison() fails.
   if ((status = btrieveFilter.SetComparison(Btrieve::COMPARISON_EQUAL)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveFilter::SetComparison():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照

Btrieve::StatusCodeToString

各種例:

bfilter.cpp, btestbulk.cpp.

SetComparisonConstant()

Btrieve::StatusCode BtrieveFilter::SetComparisonConstant	(	const char *	constant,
		int	constantLength
	)

比較定数を設定します。

引数

[in]	constant	比較定数。
[in]	constantLength	比較定数の長さ。比較定数の長さは、Btrieve::MAXIMUM_KEY_LENGTH に制限されています。

説明

初期の状態では、フィルターに比較定数は含まれていません。

スニペット

   // If SetComparisonConstant() fails.
   if ((status = btrieveFilter.SetComparisonConstant((char *)key, 1)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveFilter::SetComparisonConstant():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照

Btrieve::StatusCodeToString

各種例:

bfilter.cpp, btestbulk.cpp.

SetComparisonField()

Btrieve::StatusCode BtrieveFilter::SetComparisonField

(

int

offset

)

比較フィールドを設定します。

引数

[in]

offset

比較フィールドのオフセット。オフセットは Btrieve::MAXIMUM_RECORD_LENGTH より小さくなければなりません。

説明

初期の状態では、フィルターに比較フィールドは含まれていません。

スニペット

   // If SetComparisonField() fails.
   if ((status = btrieveFilter.SetComparisonField(27)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveFilter::SetComparisonField():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照

Btrieve::StatusCodeToString

各種例:

bfilter.cpp.

SetConnector()

Btrieve::StatusCode BtrieveFilter::SetConnector

(

Btrieve::Connector

connector

)

フィールド コネクタを設定します。

引数

[in]

connector

コネクタ。

説明

フィールド コネクタのデフォルト値は Btrieve::CONNECTOR_LAST です。

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照

Btrieve::StatusCodeToString

各種例:

bfilter.cpp.

SetField()

Btrieve::StatusCode BtrieveFilter::SetField	(	int	offset,
		int	length,
		Btrieve::DataType	dataType
	)

フィールドを設定します。

引数

[in]	offset	オフセット。オフセットは Btrieve::MAXIMUM_RECORD_LENGTH より小さくなければなりません。
[in]	length	長さ。長さは、Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。
[in]	dataType	データ型。Btrieve::DATA_TYPE_LEGACY_BINARY および Btrieve::DATA_TYPE_LEGACY_STRING はサポートされていません。

説明

初期の状態では、フィルターにフィールドは含まれていません。 （オフセット＋長さ）は、Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。

スニペット

   // If SetField() fails.
   if ((status = btrieveFilter.SetField(0, 1, Btrieve::DATA_TYPE_UNSIGNED_BINARY)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveFilter::SetField():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照

Btrieve::StatusCodeToString

各種例:

bfilter.cpp, btestbulk.cpp.

SetLikeCodePageName()

Btrieve::StatusCode BtrieveFilter::SetLikeCodePageName

(

const char *

name

)

比較の種類 Like（類似）や Not Like（類似しない）で使用するコード ページ名を設定します。

引数

[in]

name

コード ページの名前。

説明

文字列比較の Like/Not Like 比較で使用するコード ページの名前を指定します。正確な比較を行うには、比較定数とデータは同じコード ページを使用している必要があります。

戻り値

= Btrieve::STATUS_CODE_NO_ERROR	成功。
!= Btrieve::STATUS_CODE_NO_ERROR	エラーが発生しました。

参照

Btrieve::StatusCodeToString