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

#include <btrieveCpp.h>

公開メンバ関数
	BtrieveBulkRetrieveAttributes ()

	~BtrieveBulkRetrieveAttributes ()

Btrieve::StatusCode	AddField (int offset, int length)
	フィールドを追加します。

Btrieve::StatusCode	AddFilter (BtrieveFilter *btrieveFilter)
	フィルターを追加します。

Btrieve::StatusCode	AddSystemField (Btrieve::SystemField systemField)
	システムフィールドを追加します。

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 ( )

関数詳解

◆ 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.

◆ 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

◆ SetMaximumRecordCount()

Btrieve::StatusCode BtrieveBulkRetrieveAttributes::SetMaximumRecordCount ( int maximumRecordCount )

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

引数

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

説明: 最大レコード数のデフォルト値は 0 です。

スニペット: 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.

公開メンバ関数

詳解

構築子と解体子

◆ BtrieveBulkRetrieveAttributes()

◆ ~BtrieveBulkRetrieveAttributes()

関数詳解

◆ AddField()

◆ AddFilter()

◆ AddSystemField()

◆ SetMaximumRecordCount()

◆ SetMaximumRejectCount()

◆ SetSkipCurrentRecord()