Btrieve ファイルクラス。 [詳解]

#include <btrieveCpp.h>

公開メンバ関数
	BtrieveFile ()

	~BtrieveFile ()

Btrieve::StatusCode	BulkCreate (BtrieveBulkCreatePayload btrieveBulkCreatePayload, BtrieveBulkCreateResult btrieveBulkCreateResult)
	一括作成。

Btrieve::StatusCode	BulkDeleteNext (BtrieveBulkDeleteAttributes bulkDeleteAttributes, BtrieveBulkDeleteResult bulkDeleteResult)
	次の一括削除。

Btrieve::StatusCode	BulkDeletePrevious (BtrieveBulkDeleteAttributes bulkDeleteAttributes, BtrieveBulkDeleteResult bulkDeleteResult)
	前の一括削除。

Btrieve::StatusCode	BulkRetrieveNext (BtrieveBulkRetrieveAttributes bulkRetrieveAttributes, BtrieveBulkRetrieveResult bulkRetrieveResult, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	次の一括取得。

Btrieve::StatusCode	BulkRetrievePrevious (BtrieveBulkRetrieveAttributes bulkRetrieveAttributes, BtrieveBulkRetrieveResult bulkRetrieveResult, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	前の一括取得。

long long	GetCursorPosition ()
	カーソル位置を取得します。

Btrieve::StatusCode	GetInformation (BtrieveFileInformation *btrieveFileInformation)
	ファイル情報を取得します。

Btrieve::StatusCode	GetLastStatusCode ()
	最新のステータスコードを取得します。

int	GetNumerator (Btrieve::Index index, const char *key, int keyLength, int denominator)
	分母に対して、インデックス内のキーがある場所に最も近似する分子を取得します。

int	GetNumerator (long long cursorPosition, int denominator)
	分母に対して、ファイル内のカーソル位置がある場所に最も近似する分子を取得します。

int	GetPercentage (Btrieve::Index index, const char *key, int keyLength)
	指定されたインデックス内のキーがある場所に最も近似するパーセンテージを取得します。

int	GetPercentage (long long cursorPosition)
	ファイル内のカーソル位置がある場所に最も近似するパーセンテージを取得します。

long long	GetRecordCreateTime ()
	レコードの作成時刻を取得します。

long long	GetRecordUpdateTime ()
	レコードの更新時刻を取得します。

Btrieve::StatusCode	IndexCreate (BtrieveIndexAttributes *btrieveIndexAttributes)
	インデックスを作成します。

Btrieve::StatusCode	IndexDrop (Btrieve::Index index)
	インデックスを削除します。

Btrieve::StatusCode	KeyRetrieve (Btrieve::Comparison comparison, Btrieve::Index index, char *key, int keyLength)
	指定された比較、インデックス、およびキーを使用して、キーを取得します。

Btrieve::StatusCode	KeyRetrieveFirst (Btrieve::Index index, char *key, int keySize)
	先頭のキーを取得します。

Btrieve::StatusCode	KeyRetrieveLast (Btrieve::Index index, char *key, int keySize)
	末尾のキーを取得します。

Btrieve::StatusCode	KeyRetrieveNext (char *key, int keySize)
	次にあるキーを取得します。

Btrieve::StatusCode	KeyRetrievePrevious (char *key, int keySize)
	前にあるキーを取得します。

Btrieve::StatusCode	RecordAppendChunk (const char *chunk, int chunkLength)
	レコードチャンクを追加します。

Btrieve::StatusCode	RecordCreate (char *record, int recordLength)
	レコードを作成します。

Btrieve::StatusCode	RecordDelete ()
	レコードを削除します。

Btrieve::StatusCode	RecordDeleteChunk (int chunkLength)
	現在のオフセットでレコードチャンクを削除します。

Btrieve::StatusCode	RecordDeleteChunk (int offset, int chunkLength)
	レコードチャンクを削除します。

Btrieve::StatusCode	RecordInsertChunk (const char *chunk, int chunkLength)
	現在のオフセットでレコードチャンクを挿入します。

Btrieve::StatusCode	RecordInsertChunk (int offset, const char *chunk, int chunkLength)
	レコードチャンクを挿入します。

int	RecordRetrieve (Btrieve::Comparison comparison, Btrieve::Index index, char key, int keyLength, char record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	指定された比較、インデックス、およびキーを使用して、レコードを取得します。

int	RecordRetrieveByCursorPosition (Btrieve::Index index, long long cursorPosition, char key, int keySize, char record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	カーソル位置によってレコードを取得します。

int	RecordRetrieveByCursorPosition (Btrieve::Index index, long long cursorPosition, char *record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	カーソル位置によってレコードを取得します。

int	RecordRetrieveByFraction (Btrieve::Index index, int numerator, int denominator, char key, int keySize, char record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	分数によってレコードを取得します。

int	RecordRetrieveByFraction (Btrieve::Index index, int numerator, int denominator, char *record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	分数によってレコードを取得します。

int	RecordRetrieveByPercentage (Btrieve::Index index, int percentage, char key, int keySize, char record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	パーセンテージによってレコードを取得します。

int	RecordRetrieveByPercentage (Btrieve::Index index, int percentage, char *record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	パーセンテージによってレコードを取得します。

int	RecordRetrieveChunk (int length, char *chunk, int chunkSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	現在のオフセットからレコードチャンクを取得します。

int	RecordRetrieveChunk (int offset, int length, char *chunk, int chunkSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	レコードチャンクを取得します。

int	RecordRetrieveFirst (Btrieve::Index index, char key, int keySize, char record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	先頭のレコードを取得します。

int	RecordRetrieveFirst (Btrieve::Index index, char *record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	先頭のレコードを取得します。

int	RecordRetrieveLast (Btrieve::Index index, char key, int keySize, char record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	末尾のレコードを取得します。

int	RecordRetrieveLast (Btrieve::Index index, char *record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	末尾のレコードを取得します。

int	RecordRetrieveNext (char key, int keySize, char record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	次にあるレコードを取得します。

int	RecordRetrieveNext (char *record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	次にあるレコードを取得します。

int	RecordRetrievePrevious (char key, int keySize, char record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	前にあるレコードを取得します。

int	RecordRetrievePrevious (char *record, int recordSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
	前にあるレコードを取得します。

Btrieve::StatusCode	RecordTruncate ()
	現在のオフセットでレコードを切り詰めます。

Btrieve::StatusCode	RecordTruncate (int offset)
	レコードを切り詰めます。

Btrieve::StatusCode	RecordUnlock (Btrieve::UnlockMode unlockMode)
	レコード（複数可）のロックを解除します。

Btrieve::StatusCode	RecordUpdate (const char *record, int recordLength)
	レコードを更新します。

Btrieve::StatusCode	RecordUpdateChunk (const char *chunk, int chunkLength)
	現在のオフセットでレコードチャンクを更新します。

Btrieve::StatusCode	RecordUpdateChunk (int offset, const char *chunk, int chunkLength)
	レコードチャンクを更新します。

Btrieve::StatusCode	SetOwner (Btrieve::OwnerMode ownerMode, const char ownerName=NULL, const char ownerNameAgain=NULL, bool useLongOwnerName=true)
	オーナーを設定します。

Btrieve::StatusCode	UnlockCursorPosition (long long cursorPosition)
	カーソル位置のロックを解除します。

詳解

Btrieve ファイルクラス。

Btrieve ファイル内のレコードを取得、更新、および削除するためには、カーソルが確立されている必要があります。カーソルを確立するために使用されるメソッドの中には、次のものがあります。

BtrieveFile::RecordRetrieve
BtrieveFile::RecordRetrieveFirst
BtrieveFile::RecordRetrieveLast

確立されると、カーソルはファイル内のレコードをスキャンできるようになります。ファイル中をスキャンするために使用されるメソッドの中には、次のものがあります。

BtrieveFile::RecordRetrieveNext
BtrieveFile::RecordRetrievePrevious

カーソルを繰り返し再確立することができます。

各種例: Test_BTRV2.cpp, bfileattributes.cpp, bfileinformation.cpp, bfilter.cpp, bindexattributes.cpp, bkeyonly.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp, btestvlr.cpp.

構築子と解体子

◆ BtrieveFile()

BtrieveFile::BtrieveFile ( )

スニペット: C++ btest.cpp
BtrieveFile btrieveFile;

Python btest.py
btrieveFile = btrievePython.BtrieveFile()

assert(btrieveFile != None)

参照: BtrieveClient::FileOpen

◆ ~BtrieveFile()

BtrieveFile::~BtrieveFile ( )

参照: BtrieveClient::FileClose

関数詳解

◆ BulkCreate()

Btrieve::StatusCode BtrieveFile::BulkCreate	(	BtrieveBulkCreatePayload *	btrieveBulkCreatePayload,
		BtrieveBulkCreateResult *	btrieveBulkCreateResult )

一括作成。

引数

[in]	btrieveBulkCreatePayload	一括作成ペイロード。
[out]	btrieveBulkCreateResult	一括作成結果。

スニペット: C++ btestbulk.cpp
// If BulkCreate() fails.

if ((status = btrieveFile->BulkCreate(&btrieveBulkCreatePayload, &btrieveBulkCreateResult)) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveFile::BulkCreate():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btestbulk.py
rc = btrieveFile.BulkCreate(btrieveBulkCreatePayload, btrieveBulkCreateResult)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveBulkCreatePayload::BulkCreate():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

カーソル: カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

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

参照: Btrieve::StatusCodeToString

各種例: btestbulk.cpp.

◆ BulkDeleteNext()

Btrieve::StatusCode BtrieveFile::BulkDeleteNext	(	BtrieveBulkDeleteAttributes *	bulkDeleteAttributes,
		BtrieveBulkDeleteResult *	bulkDeleteResult )

次の一括削除。

引数

[in]	bulkDeleteAttributes	一括削除属性。
[out]	bulkDeleteResult	一括削除結果。

カーソル: カーソルが確立されている必要があります。カーソルは、最後に調べたレコードから前方へ移動されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

= Btrieve::STATUS_CODE_END_OF_FILE	成功。 0 件以上のレコードが削除されました。指定された一括削除属性に一致するレコードはこれ以上ありません。
= Btrieve::STATUS_CODE_NO_ERROR	成功。 1 件以上のレコードが削除されました。指定された一括削除属性に一致するレコードがさらに存在する可能性があります。
それ以外	エラーが発生しました。

参照: Btrieve::StatusCodeToString

◆ BulkDeletePrevious()

Btrieve::StatusCode BtrieveFile::BulkDeletePrevious	(	BtrieveBulkDeleteAttributes *	bulkDeleteAttributes,
		BtrieveBulkDeleteResult *	bulkDeleteResult )

前の一括削除。

引数

[in]	bulkDeleteAttributes	一括削除属性。
[out]	bulkDeleteResult	一括削除結果。

カーソル: カーソルが確立されている必要があります。カーソルは、最後に調べたレコードから後方へ移動されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

= Btrieve::STATUS_CODE_END_OF_FILE	成功。 0 件以上のレコードが削除されました。指定された一括削除属性に一致するレコードはこれ以上ありません。
= Btrieve::STATUS_CODE_NO_ERROR	成功。 1 件以上のレコードが削除されました。指定された一括削除属性に一致するレコードがさらに存在する可能性があります。
それ以外	エラーが発生しました。

参照: Btrieve::StatusCodeToString

◆ BulkRetrieveNext()

Btrieve::StatusCode BtrieveFile::BulkRetrieveNext	(	BtrieveBulkRetrieveAttributes *	bulkRetrieveAttributes,
		BtrieveBulkRetrieveResult *	bulkRetrieveResult,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

次の一括取得。

引数

[in]	bulkRetrieveAttributes	一括取得属性。
[out]	bulkRetrieveResult	一括取得結果。
[in]	lockMode	ロックモード。

スニペット: C++ btestbulk.cpp
// If BulkRetrieveNext() fails.

if ((status = btrieveFile->BulkRetrieveNext(&btrieveBulkRetrieveAttributes, &btrieveBulkRetrieveResult)) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveFile::BulkRetrieveNext():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btestbulk.py
rc = btrieveFile.BulkRetrieveNext(btrieveBulkRetrieveAttributes, btrieveBulkRetrieveResult)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveFile::BulkRetrieveNext():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

カーソル: カーソルが確立されている必要があります。カーソルは、最後に調べたレコードから前方へ移動されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

= Btrieve::STATUS_CODE_END_OF_FILE	成功。 0 件以上のレコードが取得されました。指定された一括取得属性に一致するレコードはこれ以上ありません。
= Btrieve::STATUS_CODE_NO_ERROR	成功。 1 件以上のレコードが取得されました。指定された一括取得属性に一致するレコードがさらに存在する可能性があります。
それ以外	エラーが発生しました。

参照: Btrieve::StatusCodeToString

各種例: bfilter.cpp, btestbulk.cpp.

◆ BulkRetrievePrevious()

Btrieve::StatusCode BtrieveFile::BulkRetrievePrevious	(	BtrieveBulkRetrieveAttributes *	bulkRetrieveAttributes,
		BtrieveBulkRetrieveResult *	bulkRetrieveResult,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

前の一括取得。

引数

[in]	bulkRetrieveAttributes	一括取得属性。
[out]	bulkRetrieveResult	一括取得結果。
[in]	lockMode	ロックモード。

カーソル: カーソルが確立されている必要があります。カーソルは、最後に調べたレコードから後方へ移動されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

= Btrieve::STATUS_CODE_END_OF_FILE	成功。 0 件以上のレコードが取得されました。指定された一括取得属性に一致するレコードはこれ以上ありません。
= Btrieve::STATUS_CODE_NO_ERROR	成功。 1 件以上のレコードが取得されました。指定された一括取得属性に一致するレコードがさらに存在する可能性があります。
それ以外	エラーが発生しました。

参照: Btrieve::StatusCodeToString

◆ GetCursorPosition()

long long BtrieveFile::GetCursorPosition ( )

カーソル位置を取得します。

覚え書き: このメソッドの署名は PSQL v13 R2 で変更されました。

スニペット: C++ bpercentage.cpp
// If GetCursorPosition() fails.

if ((cursorPosition = btrieveFile->GetCursorPosition()) == -1)

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::GetCursorPosition():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bpercentage.py
cursorPosition = btrieveFile.GetCursorPosition()

assert(cursorPosition != -1), "Error: BtrieveFile::GetCursorPosition():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

>= 0	カーソル位置。
-1	エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

各種例: bpercentage.cpp.

◆ GetInformation()

Btrieve::StatusCode BtrieveFile::GetInformation ( BtrieveFileInformation * btrieveFileInformation )

ファイル情報を取得します。

引数

[out] btrieveFileInformation ファイル情報。

スニペット: C++ bfileinformation.cpp
// If GetInformation() fails.

if ((status = btrieveFile->GetInformation(&btrieveFileInformation)) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveFile::GetInformation():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bfileinformation.py
rc = btrieveFile.GetInformation(btrieveFileInformation)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveFile::GetInformation():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

カーソル: カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

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

参照: Btrieve::StatusCodeToString

各種例: bfileattributes.cpp, bfileinformation.cpp.

◆ GetLastStatusCode()

Btrieve::StatusCode BtrieveFile::GetLastStatusCode ( )

最新のステータスコードを取得します。

覚え書き: このメソッドは、ステータスコードを返さない以下のメソッドでの使用を目的としています。

スニペット: C++ btest.cpp
// If RecordRetrieve() fails.

if (btrieveFile->RecordRetrieve(Btrieve::COMPARISON_EQUAL, Btrieve::INDEX_1, (char *)key, sizeof(*key), (char *)&record, sizeof(record)) != sizeof(record))

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::RecordRetrieve():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btest.py
rc = btrieveFile.RecordRetrieve(btrievePython.Btrieve.COMPARISON_EQUAL, btrievePython.Btrieve.INDEX_1, key, record)

assert(rc == recordLength), "Error: BtrieveFile::RecordRetrieve():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

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

参照: Btrieve::StatusCodeToString

各種例: Test_BTRV2.cpp, bfilter.cpp, bindexattributes.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp, btestvlr.cpp.

◆ GetNumerator() [1/2]

int BtrieveFile::GetNumerator	(	Btrieve::Index	index,
		const char *	key,
		int	keyLength,
		int	denominator )

分母に対して、インデックス内のキーがある場所に最も近似する分子を取得します。

引数

[in]	index	インデックス。
[in]	key	キー。
[in]	keyLength	キーの長さ。
[in]	denominator	分母。

スニペット: C++ bpercentage.cpp
// If GetNumerator() fails.

if ((numerator = btrieveFile->GetNumerator(Btrieve::INDEX_1, (char *)&key, sizeof(key), NUMBER_OF_RECORDS)) == -1)

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::GetNumerator():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bpercentage.py
numerator = btrieveFile.GetNumerator(btrievePython.Btrieve.INDEX_1, key, numberOfRecords)

assert(numerator != -1), "Error: BtrieveFile::GetNumerator():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

>= 0	分子。0 から分母までで返されます。
-1	エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ GetNumerator() [2/2]

int BtrieveFile::GetNumerator	(	long long	cursorPosition,
		int	denominator )

分母に対して、ファイル内のカーソル位置がある場所に最も近似する分子を取得します。

覚え書き: このメソッドの署名は PSQL v13 R2 で変更されました。

引数

[in]	cursorPosition	カーソル位置。
[in]	denominator	分母。

スニペット: C++ bpercentage.cpp
// If GetNumerator() fails.

if ((numerator = btrieveFile->GetNumerator(cursorPosition, NUMBER_OF_RECORDS)) == -1)

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::GetNumerator():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bpercentage.py
numerator = btrieveFile.GetNumerator(cursorPosition, numberOfRecords)

assert(numerator != -1), "Error: BtrieveFile::GetNumerator():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

>= 0	分子。0 から分母までで返されます。
-1	エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

各種例: bpercentage.cpp.

◆ GetPercentage() [1/2]

int BtrieveFile::GetPercentage	(	Btrieve::Index	index,
		const char *	key,
		int	keyLength )

指定されたインデックス内のキーがある場所に最も近似するパーセンテージを取得します。

引数

[in]	index	インデックス。
[in]	key	キー。
[in]	keyLength	キーの長さ。

スニペット: C++ bpercentage.cpp
// If GetPercentage() fails.

if ((percentage = btrieveFile->GetPercentage(Btrieve::INDEX_1, (char *)&key, sizeof(key))) == -1)

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::GetPercentage():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bpercentage.py
percentage = btrieveFile.GetPercentage(btrievePython.Btrieve.INDEX_1, key)

assert(percentage != -1), "Error: BtrieveFile::GetPercentage():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

>= 0	パーセンテージ。0 から 10,000（0% から 100.00% に相当）で返されます。
-1	エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ GetPercentage() [2/2]

int BtrieveFile::GetPercentage ( long long cursorPosition )

ファイル内のカーソル位置がある場所に最も近似するパーセンテージを取得します。

覚え書き: このメソッドの署名は PSQL v13 R2 で変更されました。

引数

[in] cursorPosition カーソル位置。

スニペット: C++ bpercentage.cpp
// If GetPercentage() fails.

if ((percentage = btrieveFile->GetPercentage(cursorPosition)) == -1)

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::GetPercentage():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bpercentage.py
percentage = btrieveFile.GetPercentage(cursorPosition)

assert(percentage != -1), "Error: BtrieveFile::GetPercentage():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

>= 0	パーセンテージ。0 から 10,000（0% から 100.00% に相当）で返されます。
-1	エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

各種例: bpercentage.cpp.

◆ GetRecordCreateTime()

long long BtrieveFile::GetRecordCreateTime ( )

レコードの作成時刻を取得します。

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

> 0	レコードの作成時刻（Btrieve TIMESTAMP）。
= 0	レコードの作成時刻を入手できません。ファイルがシステムデータを使って作成されたかを確認してください。 BtrieveFileAttributes::SetSystemDataMode を参照してください。
-1	エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

参照: Btrieve::TimestampToUnixEpochMicroseconds

◆ GetRecordUpdateTime()

long long BtrieveFile::GetRecordUpdateTime ( )

レコードの更新時刻を取得します。

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

> 0	レコードの更新時刻（Btrieve TIMESTAMP）。
= 0	レコードの更新時刻を入手できません。ファイルがシステムデータバージョン 2 を使って作成されたかを確認してください。 BtrieveFileAttributes::SetSystemDataMode を参照してください。
-1	エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

参照: Btrieve::TimestampToUnixEpochMicroseconds

◆ IndexCreate()

Btrieve::StatusCode BtrieveFile::IndexCreate ( BtrieveIndexAttributes * btrieveIndexAttributes )

インデックスを作成します。

引数

[in] btrieveIndexAttributes インデックス属性。

スニペット: C++ btest.cpp
// If IndexCreate() fails.

if ((status = btrieveFile->IndexCreate(&btrieveIndexAttributes)) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveFile::IndexCreate():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btest.py
rc = btrieveFile.IndexCreate(btrieveIndexAttributes)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveFile::IndexCreate():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

カーソル: カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

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

参照: Btrieve::StatusCodeToString

各種例: Test_BTRV2.cpp, bfilter.cpp, bindexattributes.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestvlr.cpp.

◆ IndexDrop()

Btrieve::StatusCode BtrieveFile::IndexDrop ( Btrieve::Index index )

インデックスを削除します。

引数

[in] index インデックス。

カーソル: カーソルインデックスが削除された場合、カーソルは破棄されます。そうでない場合、カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

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

参照: Btrieve::StatusCodeToString

◆ KeyRetrieve()

Btrieve::StatusCode BtrieveFile::KeyRetrieve	(	Btrieve::Comparison	comparison,
		Btrieve::Index	index,
		char *	key,
		int	keyLength )

指定された比較、インデックス、およびキーを使用して、キーを取得します。

覚え書き: このメソッドの署名は PSQL v15 R0 で変更されました。

引数

[in]	comparison	比較。 Btrieve::COMPARISON_NOT_EQUAL はサポートされていません。
[in]	index	インデックス。
[in,out]	key	キー。
[in]	keyLength	キーの長さ。

スニペット: C++ bkeyonly.cpp
// If KeyRetrieve() fails.

if ((status = btrieveFile->KeyRetrieve(Btrieve::COMPARISON_EQUAL, Btrieve::INDEX_1, (char *)key, sizeof(*key))) == Btrieve::STATUS_CODE_NO_ERROR)

{

printf("%u is prime.\n", *key);

goto leave;

}

if (status == Btrieve::STATUS_CODE_KEY_VALUE_NOT_FOUND)

{

printf("%u is not prime.\n", *key);

status = Btrieve::STATUS_CODE_NO_ERROR;

goto leave;

}

printf("Error: BtrieveClient::KeyRetrieve():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

Python bkeyonly.py
rc = btrieveFile.KeyRetrieve(btrievePython.Btrieve.COMPARISON_EQUAL, btrievePython.Btrieve.INDEX_1, key)

if (rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR):

print(integerValue, "is prime.")

elif (rc == btrievePython.Btrieve.STATUS_CODE_KEY_VALUE_NOT_FOUND):

print(integerValue, "is not prime.")

else:

assert(False), "Error: BtrieveFile::KeyRetrieve():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

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

参照: Btrieve::StatusCodeToString

各種例: bkeyonly.cpp.

◆ KeyRetrieveFirst()

Btrieve::StatusCode BtrieveFile::KeyRetrieveFirst	(	Btrieve::Index	index,
		char *	key,
		int	keySize )

先頭のキーを取得します。

引数

[in]	index	インデックス。
[out]	key	キー。
[in]	keySize	キーサイズ。

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

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

参照: Btrieve::StatusCodeToString

◆ KeyRetrieveLast()

Btrieve::StatusCode BtrieveFile::KeyRetrieveLast	(	Btrieve::Index	index,
		char *	key,
		int	keySize )

末尾のキーを取得します。

引数

[in]	index	インデックス。
[out]	key	キー。
[in]	keySize	キーサイズ。

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

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

参照: Btrieve::StatusCodeToString

◆ KeyRetrieveNext()

Btrieve::StatusCode BtrieveFile::KeyRetrieveNext	(	char *	key,
		int	keySize )

次にあるキーを取得します。

引数

[out]	key	キー。
[in]	keySize	キーサイズ。

カーソル: カーソルが確立されている必要があります。カーソルは 1 つ前方のキーに移動されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

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

参照: Btrieve::StatusCodeToString

◆ KeyRetrievePrevious()

Btrieve::StatusCode BtrieveFile::KeyRetrievePrevious	(	char *	key,
		int	keySize )

前にあるキーを取得します。

引数

[out]	key	キー。
[in]	keySize	キーサイズ。

カーソル: カーソルが確立されている必要があります。カーソルは 1 つ後方のキーに移動されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

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

参照: Btrieve::StatusCodeToString

◆ RecordAppendChunk()

Btrieve::StatusCode BtrieveFile::RecordAppendChunk	(	const char *	chunk,
		int	chunkLength )

レコードチャンクを追加します。

引数

[in]	chunk	チャンク。
[in]	chunkLength	チャンクの長さ。

説明: ファイルに可変長レコードがある必要があります。 BtrieveFileAttributes::SetVariableLengthRecordsMode を参照してください。

スニペット: C++ btestappend.cpp
// If RecordAppendChunk() fails.

if ((status = btrieveFile->RecordAppendChunk((char *)&chunk, sizeof(chunk))) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveFile::RecordAppendChunk():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btestappend.py
rc = btrieveFile.RecordAppendChunk(chunk)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveFile::RecordAppendChunk():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは、追加されたチャンクの末尾に確立されます。

戻り値

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

参照: Btrieve::StatusCodeToString

各種例: btestappend.cpp.

◆ RecordCreate()

Btrieve::StatusCode BtrieveFile::RecordCreate	(	char *	record,
		int	recordLength )

レコードを作成します。

覚え書き: このメソッドの署名は PSQL v13 R2 で変更されました。

引数

[in,out]	record	レコード。現在のレコードに Btrieve::DATA_TYPE_AUTOINCREMENT キーまたは Btrieve::DATA_TYPE_AUTOTIMESTAMP キーのセグメントが含まれている場合、渡されるレコードは変更される可能性があります。
[in]	recordLength	レコード長。レコード長は Btrieve::MAXIMUM_RECORD_LENGTH バイトに制限されています。 Btrieve::MAXIMUM_RECORD_LENGTH よりも長いレコードを作成する方法については BtrieveFile::RecordAppendChunk を参照してください。

スニペット: C++ btest.cpp
// If RecordCreate() fails.

if ((status = btrieveFile->RecordCreate((char *)&record, sizeof(record))) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveFile::RecordCreate():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btest.py
rc = btrieveFile.RecordCreate(record)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveFile::RecordCreate():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

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

参照: Btrieve::StatusCodeToString

各種例: Test_BTRV2.cpp, bfilter.cpp, bindexattributes.cpp, bkeyonly.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestchunk.cpp, btestvlr.cpp.

◆ RecordDelete()

Btrieve::StatusCode BtrieveFile::RecordDelete ( )

レコードを削除します。

スニペット: C++ bkeyonly.cpp
// If RecordDelete() fails.

if ((status = btrieveFile->RecordDelete()) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveFile::RecordDelete():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bkeyonly.py
rc = btrieveFile.RecordDelete()

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveFile::RecordDelete():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

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

参照: Btrieve::StatusCodeToString

各種例: bkeyonly.cpp.

◆ RecordDeleteChunk() [1/2]

Btrieve::StatusCode BtrieveFile::RecordDeleteChunk ( int chunkLength )

現在のオフセットでレコードチャンクを削除します。

引数

[in] chunkLength チャンクの長さ。

説明: ファイルに可変長レコードがある必要があります。 BtrieveFileAttributes::SetVariableLengthRecordsMode を参照してください。

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは確立されている必要があり、削除されたチャンクの末尾へ移動されます。

戻り値

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

◆ RecordDeleteChunk() [2/2]

Btrieve::StatusCode BtrieveFile::RecordDeleteChunk	(	int	offset,
		int	chunkLength )

レコードチャンクを削除します。

引数

[in]	offset	オフセット。offset が -1 の場合は、現在のオフセットが使用されます。offset は、レコードの可変長部分内にある必要があります。
[in]	chunkLength	チャンクの長さ。

説明: ファイルに可変長レコードがある必要があります。 BtrieveFileAttributes::SetVariableLengthRecordsMode を参照してください。

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは、削除されたチャンクの末尾に確立されます。

戻り値

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

◆ RecordInsertChunk() [1/2]

Btrieve::StatusCode BtrieveFile::RecordInsertChunk	(	const char *	chunk,
		int	chunkLength )

現在のオフセットでレコードチャンクを挿入します。

引数

[in]	chunk	チャンク。
[in]	chunkLength	チャンクの長さ。

説明: ファイルに可変長レコードがある必要があります。 BtrieveFileAttributes::SetVariableLengthRecordsMode を参照してください。

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは確立されている必要があり、挿入されたチャンクの末尾へ移動されます。

戻り値

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

◆ RecordInsertChunk() [2/2]

Btrieve::StatusCode BtrieveFile::RecordInsertChunk	(	int	offset,
		const char *	chunk,
		int	chunkLength )

レコードチャンクを挿入します。

引数

[in]	offset	オフセット。offset が -1 の場合は、現在のオフセットが使用されます。offset は、レコードの可変長部分内にある必要があります。
[in]	chunk	チャンク。
[in]	chunkLength	チャンクの長さ。

説明: ファイルに可変長レコードがある必要があります。 BtrieveFileAttributes::SetVariableLengthRecordsMode を参照してください。

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは、挿入されたチャンクの末尾に確立されます。

戻り値

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

◆ RecordRetrieve()

int BtrieveFile::RecordRetrieve	(	Btrieve::Comparison	comparison,
		Btrieve::Index	index,
		char *	key,
		int	keyLength,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

指定された比較、インデックス、およびキーを使用して、レコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。; このメソッドの署名は PSQL v15 R0 で変更されました。

引数

[in]	comparison	比較。 Btrieve::COMPARISON_NOT_EQUAL はサポートされていません。
[in]	index	インデックス。
[in,out]	key	キー。
[in]	keyLength	キーの長さ。
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

スニペット: C++ btest.cpp
// If RecordRetrieve() fails.

if (btrieveFile->RecordRetrieve(Btrieve::COMPARISON_EQUAL, Btrieve::INDEX_1, (char *)key, sizeof(*key), (char *)&record, sizeof(record)) != sizeof(record))

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::RecordRetrieve():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btest.py
rc = btrieveFile.RecordRetrieve(btrievePython.Btrieve.COMPARISON_EQUAL, btrievePython.Btrieve.INDEX_1, key, record)

assert(rc == recordLength), "Error: BtrieveFile::RecordRetrieve():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

各種例: bkeyonly.cpp, btest.cpp, btestvlr.cpp.

◆ RecordRetrieveByCursorPosition() [1/2]

int BtrieveFile::RecordRetrieveByCursorPosition	(	Btrieve::Index	index,
		long long	cursorPosition,
		char *	key,
		int	keySize,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

カーソル位置によってレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[in]	index	インデックスまたは Btrieve::INDEX_NONE
[in]	cursorPosition	カーソル位置。
[out]	key	キー。
[in]	keySize	キーサイズ。
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveByCursorPosition() [2/2]

int BtrieveFile::RecordRetrieveByCursorPosition	(	Btrieve::Index	index,
		long long	cursorPosition,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

カーソル位置によってレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。; このメソッドの署名は PSQL v13 R2 で変更されました。

引数

[in]	index	インデックスまたは Btrieve::INDEX_NONE
[in]	cursorPosition	カーソル位置。
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

スニペット: C++ bpercentage.cpp
// If RecordRetrieveByCursorPosition() fails.

if (btrieveFile->RecordRetrieveByCursorPosition(Btrieve::INDEX_1, cursorPosition, (char *)&record, sizeof(record)) != sizeof(record))

{

printf("Error: BtrieveFileAttributes::RecordRetrieveByCursorPosition():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bpercentage.py
rc = btrieveFile.RecordRetrieveByCursorPosition(btrievePython.Btrieve.INDEX_1, cursorPosition, record)

assert(rc == recordLength), "Error: BtrieveFile::RecordRetrieveByCursorPosition():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

各種例: bpercentage.cpp.

◆ RecordRetrieveByFraction() [1/2]

int BtrieveFile::RecordRetrieveByFraction	(	Btrieve::Index	index,
		int	numerator,
		int	denominator,
		char *	key,
		int	keySize,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

分数によってレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[in]	index	インデックスまたは Btrieve::INDEX_NONE
[in]	numerator	分子。0 から分母までで指定します。
[in]	denominator	分母。
[out]	key	キー。
[in]	keySize	キーサイズ。
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveByFraction() [2/2]

int BtrieveFile::RecordRetrieveByFraction	(	Btrieve::Index	index,
		int	numerator,
		int	denominator,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

分数によってレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[in]	index	インデックスまたは Btrieve::INDEX_NONE
[in]	numerator	分子。0 から分母までで指定します。
[in]	denominator	分母。
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

スニペット: C++ bpercentage.cpp
// If RecordRetrieveByFraction() fails.

if (btrieveFile->RecordRetrieveByFraction(Btrieve::INDEX_1, NUMBER_OF_RECORDS / 2, NUMBER_OF_RECORDS, (char *)&record, sizeof(record)) != sizeof(record))

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::RecordRetrieveByFraction():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bpercentage.py
rc = btrieveFile.RecordRetrieveByFraction(btrievePython.Btrieve.INDEX_1, int(numberOfRecords / 2), numberOfRecords, record)

assert(rc == recordLength), "Error: BtrieveFile::RecordRetrieveByFraction():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

各種例: bpercentage.cpp.

◆ RecordRetrieveByPercentage() [1/2]

int BtrieveFile::RecordRetrieveByPercentage	(	Btrieve::Index	index,
		int	percentage,
		char *	key,
		int	keySize,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

パーセンテージによってレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[in]	index	インデックスまたは Btrieve::INDEX_NONE
[in]	percentage	パーセンテージ。0 から 10,000（0% から 100.00% に相当）で指定します。
[out]	key	キー。
[in]	keySize	キーサイズ。
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveByPercentage() [2/2]

int BtrieveFile::RecordRetrieveByPercentage	(	Btrieve::Index	index,
		int	percentage,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

パーセンテージによってレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[in]	index	インデックスまたは Btrieve::INDEX_NONE
[in]	percentage	パーセンテージ。0 から 10,000（0% から 100.00% に相当）で指定します。
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

スニペット: C++ bpercentage.cpp
// If RecordRetrieveByPercentage() fails.

if (btrieveFile->RecordRetrieveByPercentage(Btrieve::INDEX_1, 5000, (char *)&record, sizeof(record)) != sizeof(record))

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::RecordRetrieveByPercentage():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bpercentage.py
rc = btrieveFile.RecordRetrieveByPercentage(btrievePython.Btrieve.INDEX_1, 5000, record)

assert(rc == recordLength), "Error: BtrieveFile::RecordRetrieveByPercentage():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

各種例: bpercentage.cpp.

◆ RecordRetrieveChunk() [1/2]

int BtrieveFile::RecordRetrieveChunk	(	int	length,
		char *	chunk,
		int	chunkSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

現在のオフセットからレコードチャンクを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[in]	length	長さ。
[out]	chunk	チャンク。
[in]	chunkSize	チャンクサイズ。
[in]	lockMode	ロックモード。

スニペット: C++ btestchunk.cpp
// If RecordRetrieveChunk() fails.

if (btrieveFile->RecordRetrieveChunk(sizeof(chunk), (char *)&chunk, sizeof(chunk)) != sizeof(chunk))

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::RecordRetrieveChunk():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btestchunk.py
rc = btrieveFile.RecordRetrieveChunk(chunkLength, chunk)

assert(rc == chunkLength), "Error: BtrieveFile::RecordRetrieveChunk():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは確立されている必要があり、取得されたチャンクの末尾へ移動されます。

戻り値

>= 0	読み取られるバイト数。複数のチャンクを取得できます。
-1	エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveChunk() [2/2]

int BtrieveFile::RecordRetrieveChunk	(	int	offset,
		int	length,
		char *	chunk,
		int	chunkSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

レコードチャンクを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[in]	offset	オフセット。offset が -1 の場合は、現在のオフセットが使用されます。
[in]	length	長さ。
[out]	chunk	チャンク。
[in]	chunkSize	チャンクサイズ。
[in]	lockMode	ロックモード。

スニペット: C++ btestchunk.cpp
// If RecordRetrieveChunk() fails.

if (btrieveFile->RecordRetrieveChunk(0, sizeof(chunk), (char *)&chunk, sizeof(chunk)) != sizeof(chunk))

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::RecordRetrieveChunk():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btestchunk.py
rc = btrieveFile.RecordRetrieveChunk(0, chunkLength, chunk)

assert(rc == chunkLength), "Error: BtrieveFile::RecordRetrieveChunk():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは、取得されたチャンクの末尾に確立されます。

戻り値

>= 0	読み取られるバイト数。複数のチャンクを取得できます。
-1	エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

各種例: btestappend.cpp, btestchunk.cpp.

◆ RecordRetrieveFirst() [1/2]

int BtrieveFile::RecordRetrieveFirst	(	Btrieve::Index	index,
		char *	key,
		int	keySize,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

先頭のレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[in]	index	インデックスまたは Btrieve::INDEX_NONE
[out]	key	キー。
[in]	keySize	キーサイズ。
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveFirst() [2/2]

int BtrieveFile::RecordRetrieveFirst	(	Btrieve::Index	index,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

先頭のレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[in]	index	インデックスまたは Btrieve::INDEX_NONE
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

スニペット: C++ btestbulk.cpp
// If RecordRetrieveFirst() fails.

if (btrieveFile->RecordRetrieveFirst(Btrieve::INDEX_NONE, (char *)&record, sizeof(record)) != sizeof(record))

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::RecordRetrieveFirst():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btestbulk.py
rc = btrieveFile.RecordRetrieveFirst(btrievePython.Btrieve.INDEX_NONE, record)

assert(rc == recordLength), "Error: BtrieveFile::RecordRetrieveFirst():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

各種例: bfilter.cpp, bindexattributes.cpp, block.cpp, bpercentage.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp.

◆ RecordRetrieveLast() [1/2]

int BtrieveFile::RecordRetrieveLast	(	Btrieve::Index	index,
		char *	key,
		int	keySize,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

末尾のレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[in]	index	インデックスまたは Btrieve::INDEX_NONE
[out]	key	キー。
[in]	keySize	キーサイズ。
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveLast() [2/2]

int BtrieveFile::RecordRetrieveLast	(	Btrieve::Index	index,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

末尾のレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[in]	index	インデックスまたは Btrieve::INDEX_NONE
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

スニペット: C++ bpercentage.cpp
// If RecordRetrieveLast() fails.

if (btrieveFile->RecordRetrieveLast(Btrieve::INDEX_1, (char *)&record, sizeof(record)) != sizeof(record))

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::RecordRetrieveLast():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python bpercentage.py
rc = btrieveFile.RecordRetrieveLast(btrievePython.Btrieve.INDEX_1, record)

assert(rc == recordLength), "Error: BtrieveFile::RecordRetrieveLast():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルが確立されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

各種例: Test_BTRV2.cpp, bpercentage.cpp.

◆ RecordRetrieveNext() [1/2]

int BtrieveFile::RecordRetrieveNext	(	char *	key,
		int	keySize,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

次にあるレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[out]	key	キー。
[in]	keySize	キーサイズ。
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

カーソル: カーソルが確立されている必要があります。カーソルは 1 つ前方のレコードに移動されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveNext() [2/2]

int BtrieveFile::RecordRetrieveNext	(	char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

次にあるレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

スニペット: C++ bindexattributes.cpp
// If RecordRetrieveNext() fails.

if (btrieveFile->RecordRetrieveNext((char *)&record, sizeof(record)) != sizeof(record))

{

status = btrieveFile->GetLastStatusCode();

printf("Error: BtrieveFile::RecordRetrieveNext():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

}

Python bindexattributes.py
rc = btrieveFile.RecordRetrieveNext(record)

assert(rc == recordLength), "Error: BtrieveFile::RecordRetrieveNext():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

カーソル: カーソルが確立されている必要があります。カーソルは 1 つ前方のレコードに移動されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

各種例: bindexattributes.cpp.

◆ RecordRetrievePrevious() [1/2]

int BtrieveFile::RecordRetrievePrevious	(	char *	key,
		int	keySize,
		char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

前にあるレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[out]	key	キー。
[in]	keySize	キーサイズ。
[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

カーソル: カーソルが確立されている必要があります。カーソルは 1 つ後方のレコードに移動されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrievePrevious() [2/2]

int BtrieveFile::RecordRetrievePrevious	(	char *	record,
		int	recordSize,
		Btrieve::LockMode	lockMode = Btrieve::LOCK_MODE_NONE )

前にあるレコードを取得します。

覚え書き: このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。

引数

[out]	record	レコード。
[in]	recordSize	レコードサイズ。
[in]	lockMode	ロックモード。

カーソル: カーソルが確立されている必要があります。カーソルは 1 つ後方のレコードに移動されます。

現在のオフセット: 現在のオフセットは破棄されます。

戻り値

>= 0 読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。要求されたレコードサイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCode は Btrieve::STATUS_CODE_DATALENGTH_ERROR を返します。

-1 エラーが発生しました。エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordTruncate() [1/2]

Btrieve::StatusCode BtrieveFile::RecordTruncate ( )

現在のオフセットでレコードを切り詰めます。

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは確立されている必要があり、変更されません。

戻り値

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

◆ RecordTruncate() [2/2]

Btrieve::StatusCode BtrieveFile::RecordTruncate ( int offset )

レコードを切り詰めます。

引数

[in] offset オフセット。offset が -1 の場合は、現在のオフセットが使用されます。

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは、レコードの末尾に確立されます。

戻り値

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

◆ RecordUnlock()

Btrieve::StatusCode BtrieveFile::RecordUnlock ( Btrieve::UnlockMode unlockMode )

レコード（複数可）のロックを解除します。

引数

[in] unlockMode ロック解除モード。

スニペット: C++ block.cpp
// If RecordUnlock() fails.

if ((status = btrieveFile->RecordUnlock(Btrieve::UNLOCK_MODE_SINGLE)) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveFile::RecordUnlock():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python block.py
rc = btrieveFile.RecordUnlock(btrievePython.Btrieve.UNLOCK_MODE_SINGLE)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveFile::RecordUnlock():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

カーソル: カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

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

参照: Btrieve::StatusCodeToString

各種例: block.cpp.

◆ RecordUpdate()

Btrieve::StatusCode BtrieveFile::RecordUpdate	(	const char *	record,
		int	recordLength )

レコードを更新します。

引数

[in]	record	レコード。
[in]	recordLength	レコード長。レコード長は Btrieve::MAXIMUM_RECORD_LENGTH バイトに制限されています。 Btrieve::MAXIMUM_RECORD_LENGTH より長いレコードを更新する方法については BtrieveFile::RecordUpdateChunk を参照してください。

スニペット: C++ block.cpp
status = btrieveFile.RecordUpdate((char *)&record, sizeof(record));

Python block.py
rc = btrieveFile.RecordUpdate(record)

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

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

参照: Btrieve::StatusCodeToString

各種例: block.cpp.

◆ RecordUpdateChunk() [1/2]

Btrieve::StatusCode BtrieveFile::RecordUpdateChunk	(	const char *	chunk,
		int	chunkLength )

現在のオフセットでレコードチャンクを更新します。

引数

[in]	chunk	チャンク。
[in]	chunkLength	チャンクの長さ。

スニペット: C++ btestchunk.cpp
// If RecordUpdateChunk() fails.

if ((status = btrieveFile->RecordUpdateChunk((char *)&chunk, sizeof(chunk))) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveFile::RecordUpdateChunk():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btestchunk.py
rc = btrieveFile.RecordUpdateChunk(chunk)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveFile::RecordUpdateChunk():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは確立されている必要があり、更新されたチャンクの末尾へ移動されます。

戻り値

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

◆ RecordUpdateChunk() [2/2]

Btrieve::StatusCode BtrieveFile::RecordUpdateChunk	(	int	offset,
		const char *	chunk,
		int	chunkLength )

レコードチャンクを更新します。

引数

[in]	offset	オフセット。offset が -1 の場合は、現在のオフセットが使用されます。
[in]	chunk	チャンク。
[in]	chunkLength	チャンクの長さ。

スニペット: C++ btestchunk.cpp
// If RecordUpdateChunk() fails.

if ((status = btrieveFile->RecordUpdateChunk(0, (char *)&chunk, sizeof(chunk))) != Btrieve::STATUS_CODE_NO_ERROR)

{

printf("Error: BtrieveFile::RecordUpdateChunk():%d:%s.\n", status, Btrieve::StatusCodeToString(status));

goto leave;

}

Python btestchunk.py
rc = btrieveFile.RecordUpdateChunk(0, chunk)

assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveFile::RecordUpdateChunk():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

カーソル: カーソルは影響を受けませんが、確立されている必要があります。

現在のオフセット: 現在のオフセットは、更新されたチャンクの末尾に確立されます。

戻り値

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

各種例: btestchunk.cpp.

◆ SetOwner()

Btrieve::StatusCode BtrieveFile::SetOwner	(	Btrieve::OwnerMode	ownerMode,
		const char *	ownerName = NULL,
		const char *	ownerNameAgain = NULL,
		bool	useLongOwnerName = true )

オーナーを設定します。

引数

[in]	ownerMode	オーナーモード。
[in]	ownerName	オーナーネーム。
[in]	ownerNameAgain	オーナーネーム（確認）。
[in]	useLongOwnerName	長いオーナーネームを使用するかどうか。

説明: オーナーモードのデフォルト値は Btrieve::OWNER_MODE_NONE です。

カーソル: カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

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

参照: Btrieve::StatusCodeToString

◆ UnlockCursorPosition()

Btrieve::StatusCode BtrieveFile::UnlockCursorPosition ( long long cursorPosition )

カーソル位置のロックを解除します。

覚え書き: このメソッドの署名は PSQL v13 R2 で変更されました。

引数

[in] cursorPosition カーソル位置。

カーソル: カーソルは影響を受けません。

現在のオフセット: 現在のオフセットは影響を受けません。

戻り値

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

参照: Btrieve::StatusCodeToString

公開メンバ関数

詳解

構築子と解体子

◆ BtrieveFile()

◆ ~BtrieveFile()

関数詳解

◆ BulkCreate()

◆ BulkDeleteNext()

◆ BulkDeletePrevious()

◆ BulkRetrieveNext()

◆ BulkRetrievePrevious()

◆ GetCursorPosition()

◆ GetInformation()

◆ GetLastStatusCode()

◆ GetNumerator() [1/2]

◆ GetNumerator() [2/2]

◆ GetPercentage() [1/2]

◆ GetPercentage() [2/2]

◆ GetRecordCreateTime()

◆ GetRecordUpdateTime()

◆ IndexCreate()

◆ IndexDrop()

◆ KeyRetrieve()

◆ KeyRetrieveFirst()

◆ KeyRetrieveLast()

◆ KeyRetrieveNext()

◆ KeyRetrievePrevious()

◆ RecordAppendChunk()

◆ RecordCreate()

◆ RecordDelete()

◆ RecordDeleteChunk() [1/2]

◆ RecordDeleteChunk() [2/2]

◆ RecordInsertChunk() [1/2]

◆ RecordInsertChunk() [2/2]

◆ RecordRetrieve()

◆ RecordRetrieveByCursorPosition() [1/2]

◆ RecordRetrieveByCursorPosition() [2/2]

◆ RecordRetrieveByFraction() [1/2]

◆ RecordRetrieveByFraction() [2/2]

◆ RecordRetrieveByPercentage() [1/2]

◆ RecordRetrieveByPercentage() [2/2]

◆ RecordRetrieveChunk() [1/2]

◆ RecordRetrieveChunk() [2/2]

◆ RecordRetrieveFirst() [1/2]

◆ RecordRetrieveFirst() [2/2]

◆ RecordRetrieveLast() [1/2]

◆ RecordRetrieveLast() [2/2]

◆ RecordRetrieveNext() [1/2]

◆ RecordRetrieveNext() [2/2]

◆ RecordRetrievePrevious() [1/2]

◆ RecordRetrievePrevious() [2/2]

◆ RecordTruncate() [1/2]

◆ RecordTruncate() [2/2]

◆ RecordUnlock()

◆ RecordUpdate()

◆ RecordUpdateChunk() [1/2]

◆ RecordUpdateChunk() [2/2]

◆ SetOwner()

◆ UnlockCursorPosition()