BtrieveBulkRetrieveAttributes クラス

Btrieve 一括取得属性クラス。 [詳解]

#include <btrieveCpp.h>

公開メンバ関数
	BtrieveBulkRetrieveAttributes ()
	~BtrieveBulkRetrieveAttributes ()
Btrieve::StatusCode	AddAbsoluteValueField (Btrieve::DataType dataType, int offset, int length)
	絶対値（abs）フィールドを追加します。
Btrieve::StatusCode	AddCeilingField (Btrieve::DataType dataType, int offset, int length)
	ceiling フィールドを追加します。
Btrieve::StatusCode	AddField (int offset, int length)
	フィールドを追加します。
Btrieve::StatusCode	AddFilter (BtrieveFilter *btrieveFilter)
	フィルターを追加します。
Btrieve::StatusCode	AddFloorField (Btrieve::DataType dataType, int offset, int length)
	floor フィールドを追加します。
Btrieve::StatusCode	AddMaximumAggregate (Btrieve::DataType dataType, int offset, int length)
	最大値（max）の集計を追加します。
Btrieve::StatusCode	AddMinimumAggregate (Btrieve::DataType dataType, int offset, int length)
	最小値（min）の集計を追加します。
Btrieve::StatusCode	AddRoundField (Btrieve::DataType dataType, int offset, int length, int precision=0)
	round フィールドを追加します。
Btrieve::StatusCode	AddSystemField (Btrieve::SystemField systemField)
	システム フィールドを追加します。
Btrieve::StatusCode	AddTruncateField (Btrieve::DataType dataType, int offset, int length, int precision=0)
	truncate フィールドを追加します。
Btrieve::StatusCode	SetMaximumRecordCount (int maximumRecordCount)
	最大レコード数を設定します。
Btrieve::StatusCode	SetMaximumRejectCount (int maximumRejectCount)
	最大リジェクト カウントを設定します。
Btrieve::StatusCode	SetSkipCurrentRecord (bool skipCurrentRecord)
	現在のレコードのスキップを設定します。

詳解

Btrieve 一括取得属性クラス。

各種例

bfilter.cpp, btestbulk.cpp.

構築子と解体子

BtrieveBulkRetrieveAttributes()

BtrieveBulkRetrieveAttributes::BtrieveBulkRetrieveAttributes

(

)

スニペット

C++ btestbulk.cpp

   BtrieveBulkRetrieveAttributes btrieveBulkRetrieveAttributes;

Python btestbulk.py

btrieveBulkRetrieveAttributes = btrievePython.BtrieveBulkRetrieveAttributes()
assert(btrieveBulkRetrieveAttributes != None)

~BtrieveBulkRetrieveAttributes()

BtrieveBulkRetrieveAttributes::~BtrieveBulkRetrieveAttributes

(

)

関数詳解

AddAbsoluteValueField()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::AddAbsoluteValueField	(	Btrieve::DataType	dataType,
		int	offset,
		int	length )

絶対値（abs）フィールドを追加します。

引数

[in]	dataType	データ型。 Btrieve::DATA_TYPE_INTEGER と Btrieve::DATA_TYPE_FLOAT のみがサポートされます。
[in]	offset	オフセット。オフセットは Btrieve::MAXIMUM_RECORD_LENGTH より小さくなければなりません。
[in]	length	長さ。長さは Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。

説明

初期の状態では、一括取得属性にフィールドは含まれていません。 （オフセット＋長さ）は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 追加したすべてのフィールドの長さの合計は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 オフセットと長さで指定されるフィールドは、リトル エンディアン形式である必要があります。 フィールドを含む一括取得属性に集計を追加することはできません。

戻り値

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

参照

Btrieve::StatusCodeToString

AddCeilingField()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::AddCeilingField	(	Btrieve::DataType	dataType,
		int	offset,
		int	length )

ceiling フィールドを追加します。

引数

[in]	dataType	データ型。 Btrieve::DATA_TYPE_INTEGER と Btrieve::DATA_TYPE_FLOAT のみがサポートされます。
[in]	offset	オフセット。オフセットは Btrieve::MAXIMUM_RECORD_LENGTH より小さくなければなりません。
[in]	length	長さ。長さは Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。

説明

初期の状態では、一括取得属性にフィールドは含まれていません。 （オフセット＋長さ）は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 追加したすべてのフィールドの長さの合計は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 オフセットと長さで指定されるフィールドは、リトル エンディアン形式である必要があります。 フィールドを含む一括取得属性に集計を追加することはできません。

戻り値

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

参照

Btrieve::StatusCodeToString

AddField()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::AddField	(	int	offset,
		int	length )

フィールドを追加します。

引数

[in]	offset	オフセット。オフセットは Btrieve::MAXIMUM_RECORD_LENGTH より小さくなければなりません。
[in]	length	長さ。長さは Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。

説明

初期の状態では、一括取得属性にフィールドは含まれていません。 （オフセット＋長さ）は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 追加したすべてのフィールドの長さの合計は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 フィールドを含む一括取得属性に集計を追加することはできません。

スニペット

C++ btestbulk.cpp

   // If AddField() fails.
   if ((status = btrieveBulkRetrieveAttributes.AddField(0, sizeof(record))) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveBulkRetrieveAttributes::AddField():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

Python btestbulk.py

rc = btrieveBulkRetrieveAttributes.AddField(0, recordLength)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: btrieveBulkRetrieveAttributes::AddField():%d:%s.\n"  % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

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

参照

Btrieve::StatusCodeToString

各種例

bfilter.cpp, btestbulk.cpp.

AddFilter()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::AddFilter

(

BtrieveFilter *

btrieveFilter

)

フィルターを追加します。

引数

[in]

btrieveFilter

フィルター。

説明

初期の状態では、一括取得属性にフィルターは含まれていません。

スニペット

C++ btestbulk.cpp

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

Python btestbulk.py

rc = btrieveBulkRetrieveAttributes.AddFilter(btrieveFilter)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveBulkRetrieveAttributes::AddFilter():%d:%s.\n"  % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

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

参照

Btrieve::StatusCodeToString

各種例

bfilter.cpp, btestbulk.cpp.

AddFloorField()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::AddFloorField	(	Btrieve::DataType	dataType,
		int	offset,
		int	length )

floor フィールドを追加します。

引数

[in]	dataType	データ型。 Btrieve::DATA_TYPE_INTEGER と Btrieve::DATA_TYPE_FLOAT のみがサポートされます。
[in]	offset	オフセット。オフセットは Btrieve::MAXIMUM_RECORD_LENGTH より小さくなければなりません。
[in]	length	長さ。長さは Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。

説明

初期の状態では、一括取得属性にフィールドは含まれていません。 （オフセット＋長さ）は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 追加したすべてのフィールドの長さの合計は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 オフセットと長さで指定されるフィールドは、リトル エンディアン形式である必要があります。 フィールドを含む一括取得属性に集計を追加することはできません。

戻り値

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

参照

Btrieve::StatusCodeToString

AddMaximumAggregate()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::AddMaximumAggregate	(	Btrieve::DataType	dataType,
		int	offset,
		int	length )

最大値（max）の集計を追加します。

引数

[in]	dataType	データ型。 Btrieve::DATA_TYPE_INTEGER と Btrieve::DATA_TYPE_FLOAT のみがサポートされます。
[in]	offset	オフセット。オフセットは Btrieve::MAXIMUM_RECORD_LENGTH より小さくなければなりません。
[in]	length	長さ。長さは Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。

説明

初期の状態では、一括取得属性に集計は含まれていません。 （オフセット＋長さ）は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 追加したすべてのフィールドの長さの合計は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 オフセットと長さで指定されるフィールドは、リトル エンディアン形式である必要があります。 集計を含む一括取得属性にフィールドを追加することはできません。

戻り値

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

参照

Btrieve::StatusCodeToString

AddMinimumAggregate()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::AddMinimumAggregate	(	Btrieve::DataType	dataType,
		int	offset,
		int	length )

最小値（min）の集計を追加します。

引数

[in]	dataType	データ型。 Btrieve::DATA_TYPE_INTEGER と Btrieve::DATA_TYPE_FLOAT のみがサポートされます。
[in]	offset	オフセット。オフセットは Btrieve::MAXIMUM_RECORD_LENGTH より小さくなければなりません。
[in]	length	長さ。長さは Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。

説明

初期の状態では、一括取得属性に集計は含まれていません。 （オフセット＋長さ）は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 追加したすべてのフィールドの長さの合計は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 オフセットと長さで指定されるフィールドは、リトル エンディアン形式である必要があります。 集計を含む一括取得属性にフィールドを追加することはできません。

戻り値

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

参照

Btrieve::StatusCodeToString

AddRoundField()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::AddRoundField	(	Btrieve::DataType	dataType,
		int	offset,
		int	length,
		int	precision = 0 )

round フィールドを追加します。

引数

[in]	dataType	データ型。 Btrieve::DATA_TYPE_INTEGER と Btrieve::DATA_TYPE_FLOAT のみがサポートされます。
[in]	offset	オフセット。オフセットは Btrieve::MAXIMUM_RECORD_LENGTH より小さくなければなりません。
[in]	length	長さ。長さは Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。
[in]	precision	桁数。桁数は INT16_MIN ～ INT16_MAX の範囲内で指定する必要があります。

説明

初期の状態では、一括取得属性にフィールドは含まれていません。 （オフセット＋長さ）は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 追加したすべてのフィールドの長さの合計は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 オフセットと長さで指定されるフィールドは、リトル エンディアン形式である必要があります。 フィールドを含む一括取得属性に集計を追加することはできません。

戻り値

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

参照

Btrieve::StatusCodeToString

AddSystemField()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::AddSystemField

(

Btrieve::SystemField

systemField

)

システム フィールドを追加します。

引数

[in]

systemField

システム フィールド。

説明

初期の状態では、一括取得属性にシステム フィールドは含まれていません。 追加したすべてのフィールドの長さの合計は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 フィールドを含む一括取得属性に集計を追加することはできません。

戻り値

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

参照

Btrieve::StatusCodeToString

AddTruncateField()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::AddTruncateField	(	Btrieve::DataType	dataType,
		int	offset,
		int	length,
		int	precision = 0 )

truncate フィールドを追加します。

引数

[in]	dataType	データ型。 Btrieve::DATA_TYPE_INTEGER と Btrieve::DATA_TYPE_FLOAT のみがサポートされます。
[in]	offset	オフセット。オフセットは Btrieve::MAXIMUM_RECORD_LENGTH より小さくなければなりません。
[in]	length	長さ。長さは Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。
[in]	precision	桁数。桁数は INT16_MIN ～ INT16_MAX の範囲内で指定する必要があります。

説明

初期の状態では、一括取得属性にフィールドは含まれていません。 （オフセット＋長さ）は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 追加したすべてのフィールドの長さの合計は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 オフセットと長さで指定されるフィールドは、リトル エンディアン形式である必要があります。 フィールドを含む一括取得属性に集計を追加することはできません。

戻り値

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

参照

Btrieve::StatusCodeToString

SetMaximumRecordCount()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::SetMaximumRecordCount

(

int

maximumRecordCount

)

最大レコード数を設定します。

引数

[in]

maximumRecordCount

最大レコード数。最大レコード数は、0 より大きく Btrieve::MAXIMUM_BULK_RECORD_COUNT 以下でなければなりません。

説明

最大レコード数のデフォルト値は Btrieve::MAXIMUM_BULK_RECORD_COUNT です。 集計は最大レコード数を考慮しません。

覚え書き

Zen v16 R1 で、最大レコード数のデフォルト値を 0 から Btrieve::MAXIMUM_BULK_RECORD_COUNT に変更しました。

スニペット

C++ btestbulk.cpp

   // If SetMaximumRecordCount() fails.
   if ((status = btrieveBulkRetrieveAttributes.SetMaximumRecordCount(1)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveBulkRetrieveAttributes::SetMaximumRecordCount():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

Python btestbulk.py

rc = btrieveBulkRetrieveAttributes.SetMaximumRecordCount(1)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveBulkRetrieveAttributes::SetMaximumRecordCount():%d:%s.\n"  % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

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

参照

Btrieve::StatusCodeToString

各種例

bfilter.cpp, btestbulk.cpp.

SetMaximumRejectCount()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::SetMaximumRejectCount

(

int

maximumRejectCount

)

最大リジェクト カウントを設定します。

引数

[in]

maximumRejectCount

最大リジェクト カウント。最大リジェクト カウントは、0 以上で 65536 より小さくなければなりません。値 0 は、最大リジェクト カウントを Zen 定義の値に設定します。

説明

最大リジェクト カウントのデフォルト値は Zen 定義値です。 集計は最大リジェクト カウントを考慮しません。

スニペット

C++ btestbulk.cpp

   // If SetMaximumRejectCount() fails.
   if ((status = btrieveBulkRetrieveAttributes.SetMaximumRejectCount(MAX_X - MIN_X + 1)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveBulkRetrieveAttributes::SetMaximumRejectCount():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

Python btestbulk.py

rc = btrieveBulkRetrieveAttributes.SetMaximumRejectCount(max_x - min_x + 1)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveBulkRetrieveAttributes::SetMaximumRejectCount():%d:%s.\n"  % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

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

参照

Btrieve::StatusCodeToString

各種例

bfilter.cpp, btestbulk.cpp.

SetSkipCurrentRecord()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::SetSkipCurrentRecord

(

bool

skipCurrentRecord

)

現在のレコードのスキップを設定します。

引数

[in]

skipCurrentRecord

現在のレコードをスキップするかどうか。

説明

デフォルトでは、現在のレコードのスキップは無効になっています。

スニペット

C++ btestbulk.cpp

   // If SetSkipCurrentRecord() fails.
   if ((status = btrieveBulkRetrieveAttributes.SetSkipCurrentRecord(false)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveBulkRetrieveAttributes::SetSkipCurrentRecord():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

Python btestbulk.py

rc = btrieveBulkRetrieveAttributes.SetSkipCurrentRecord(False)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveBulkRetrieveAttributes::SetSkipCurrentRecord():%d:%s.\n"  % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

戻り値

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

参照

Btrieve::StatusCodeToString

各種例

bfilter.cpp, btestbulk.cpp.