公開メンバ関数 | 全メンバ一覧
BtrieveFile クラス

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 (long long cursorPosition, int denominator)
 分母に対して、ファイル内のカーソル位置がある場所に最も近似する分子を取得します。 [詳解]
 
int GetNumerator (Btrieve::Index index, const char *key, int keyLength, int denominator)
 分母に対して、インデックス内のキーがある場所に最も近似する分子を取得します。 [詳解]
 
int GetPercentage (long long cursorPosition)
 ファイル内のカーソル位置がある場所に最も近似するパーセンテージを取得します。 [詳解]
 
int GetPercentage (Btrieve::Index index, const char *key, int keyLength)
 指定されたインデックス内のキーがある場所に最も近似するパーセンテージを取得します。 [詳解]
 
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 offset, int chunkLength)
 レコード チャンクを削除します。 [詳解]
 
Btrieve::StatusCode RecordDeleteChunk (int chunkLength)
 現在のオフセットでレコード チャンクを削除します。 [詳解]
 
Btrieve::StatusCode RecordInsertChunk (int offset, const char *chunk, int chunkLength)
 レコード チャンクを挿入します。 [詳解]
 
Btrieve::StatusCode RecordInsertChunk (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 *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 RecordRetrieveByFraction (Btrieve::Index index, int numerator, int denominator, 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 RecordRetrieveByPercentage (Btrieve::Index index, int percentage, 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 RecordRetrieveChunk (int offset, int length, char *chunk, int chunkSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
 レコード チャンクを取得します。 [詳解]
 
int RecordRetrieveChunk (int length, char *chunk, int chunkSize, Btrieve::LockMode lockMode=Btrieve::LOCK_MODE_NONE)
 現在のオフセットからレコード チャンクを取得します。 [詳解]
 
int RecordRetrieveFirst (Btrieve::Index index, char *record, int recordSize, 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 RecordRetrieveLast (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 RecordRetrieveNext (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 RecordRetrievePrevious (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)
 前にあるレコードを取得します。 [詳解]
 
Btrieve::StatusCode RecordTruncate (int offset)
 レコードを切り詰めます。 [詳解]
 
Btrieve::StatusCode RecordTruncate ()
 現在のオフセットでレコードを切り詰めます。 [詳解]
 
Btrieve::StatusCode RecordUnlock (Btrieve::UnlockMode unlockMode)
 レコード(複数可)のロックを解除します。 [詳解]
 
Btrieve::StatusCode RecordUpdate (const char *record, int recordLength)
 レコードを更新します。 [詳解]
 
Btrieve::StatusCode RecordUpdateChunk (int offset, const char *chunk, int chunkLength)
 レコード チャンクを更新します。 [詳解]
 
Btrieve::StatusCode RecordUpdateChunk (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 ファイル内のレコードを取得、更新、および削除するためには、カーソルが確立されている必要があります。カーソルを確立するために使用されるメソッドの中には、次のものがあります。

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

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

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

構築子と解体子

◆ BtrieveFile()

BtrieveFile::BtrieveFile ( )
スニペット
C++ btest.cpp
BtrieveFile btrieveFile;
Python btest.py
btrieveFile = btrievePython.BtrieveFile()
assert(btrieveFile != None)
参照
BtrieveClient::FileOpen

◆ ~BtrieveFile()

BtrieveFile::~BtrieveFile ( )

関数詳解

◆ BulkCreate()

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

一括作成。

引数
[in]btrieveBulkCreatePayload一括作成ペイロード。
[out]btrieveBulkCreateResult一括作成結果。
スニペット
// 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;
}
カーソル
カーソルは影響を受けません。
現在のオフセット
現在のオフセットは影響を受けません。
戻り値
= 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ロック モード。
スニペット
// 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;
}
カーソル
カーソルが確立されている必要があります。カーソルは、最後に調べたレコードから前方へ移動されます。
現在のオフセット
現在のオフセットは破棄されます。
戻り値
= 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 で変更されました。
スニペット
// If GetCursorPosition() fails.
if ((cursorPosition = btrieveFile->GetCursorPosition()) == -1)
{
status = btrieveFile->GetLastStatusCode();
printf("Error: BtrieveFile::GetCursorPosition():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
カーソル
カーソルは影響を受けませんが、確立されている必要があります。
現在のオフセット
現在のオフセットは影響を受けません。
戻り値
>= 0カーソル位置。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。
各種例:
bpercentage.cpp.

◆ GetInformation()

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

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

引数
[out]btrieveFileInformationファイル情報。
スニペット
// 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;
}
カーソル
カーソルは影響を受けません。
現在のオフセット
現在のオフセットは影響を受けません。
戻り値
= 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
各種例:
bfilter.cpp, bindexattributes.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp, btestvlr.cpp, Test_BTRV2.cpp.

◆ GetNumerator() [1/2]

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

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

覚え書き
このメソッドの署名は PSQL v13 R2 で変更されました。
引数
[in]cursorPositionカーソル位置。
[in]denominator分母。
スニペット
// 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;
}
カーソル
カーソルは影響を受けません。
現在のオフセット
現在のオフセットは影響を受けません。
戻り値
>= 0分子。0 から分母までで返されます。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。
各種例:
bpercentage.cpp.

◆ GetNumerator() [2/2]

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

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

引数
[in]indexインデックス。
[in]keyキー。
[in]keyLengthキーの長さ。
[in]denominator分母。
スニペット
// 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;
}
カーソル
カーソルは影響を受けません。
現在のオフセット
現在のオフセットは影響を受けません。
戻り値
>= 0分子。0 から分母までで返されます。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ GetPercentage() [1/2]

int BtrieveFile::GetPercentage ( long long  cursorPosition)

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

覚え書き
このメソッドの署名は PSQL v13 R2 で変更されました。
引数
[in]cursorPositionカーソル位置。
スニペット
// 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;
}
カーソル
カーソルは影響を受けません。
現在のオフセット
現在のオフセットは影響を受けません。
戻り値
>= 0パーセンテージ。0 から 10,000(0% から 100.00% に相当)で返されます。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。
各種例:
bpercentage.cpp.

◆ GetPercentage() [2/2]

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

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

引数
[in]indexインデックス。
[in]keyキー。
[in]keyLengthキーの長さ。
スニペット
// 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;
}
カーソル
カーソルは影響を受けません。
現在のオフセット
現在のオフセットは影響を受けません。
戻り値
>= 0パーセンテージ。0 から 10,000(0% から 100.00% に相当)で返されます。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ 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
各種例:
bfilter.cpp, bindexattributes.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestvlr.cpp, Test_BTRV2.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キーの長さ。
スニペット
// 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;
}
{
printf("%u is not prime.\n", *key);
goto leave;
}
printf("Error: BtrieveClient::KeyRetrieve():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
カーソル
カーソルが確立されます。
現在のオフセット
現在のオフセットは破棄されます。
戻り値
= 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 を参照してください。
スニペット
// 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;
}
カーソル
カーソルは影響を受けませんが、確立されている必要があります。
現在のオフセット
現在のオフセットは、追加されたチャンクの末尾に確立されます。
戻り値
= 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
各種例:
bfilter.cpp, bindexattributes.cpp, bkeyonly.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestchunk.cpp, btestvlr.cpp, Test_BTRV2.cpp.

◆ RecordDelete()

Btrieve::StatusCode BtrieveFile::RecordDelete ( )

レコードを削除します。

スニペット
// 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;
}
カーソル
カーソルは影響を受けませんが、確立されている必要があります。
現在のオフセット
現在のオフセットは破棄されます。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bkeyonly.cpp.

◆ RecordDeleteChunk() [1/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エラーが発生しました。

◆ RecordDeleteChunk() [2/2]

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

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

引数
[in]chunkLengthチャンクの長さ。
説明
ファイルに可変長レコードがある必要があります。 BtrieveFileAttributes::SetVariableLengthRecordsMode を参照してください。
カーソル
カーソルは影響を受けませんが、確立されている必要があります。
現在のオフセット
現在のオフセットは確立されている必要があり、削除されたチャンクの末尾へ移動されます。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。

◆ RecordInsertChunk() [1/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エラーが発生しました。

◆ RecordInsertChunk() [2/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エラーが発生しました。

◆ 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::GetLastStatusCodeBtrieve::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 *  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ロック モード。
スニペット
// 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;
}
カーソル
カーソルが確立されます。
現在のオフセット
現在のオフセットは破棄されます。
戻り値
>= 0読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。 要求されたレコード サイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。
各種例:
bpercentage.cpp.

◆ RecordRetrieveByCursorPosition() [2/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::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveByFraction() [1/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ロック モード。
スニペット
// 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;
}
カーソル
カーソルが確立されます。
現在のオフセット
現在のオフセットは破棄されます。
戻り値
>= 0読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。 要求されたレコード サイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。
各種例:
bpercentage.cpp.

◆ RecordRetrieveByFraction() [2/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::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveByPercentage() [1/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ロック モード。
スニペット
// 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;
}
カーソル
カーソルが確立されます。
現在のオフセット
現在のオフセットは破棄されます。
戻り値
>= 0読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。 要求されたレコード サイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。
各種例:
bpercentage.cpp.

◆ RecordRetrieveByPercentage() [2/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::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveChunk() [1/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ロック モード。
スニペット
// 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;
}
カーソル
カーソルは影響を受けませんが、確立されている必要があります。
現在のオフセット
現在のオフセットは、取得されたチャンクの末尾に確立されます。
戻り値
>= 0読み取られるバイト数。 複数のチャンクを取得できます。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。
各種例:
btestappend.cpp, btestchunk.cpp.

◆ RecordRetrieveChunk() [2/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ロック モード。
スニペット
// 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;
}
カーソル
カーソルは影響を受けませんが、確立されている必要があります。
現在のオフセット
現在のオフセットは確立されている必要があり、取得されたチャンクの末尾へ移動されます。
戻り値
>= 0読み取られるバイト数。 複数のチャンクを取得できます。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveFirst() [1/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ロック モード。
スニペット
// 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;
}
カーソル
カーソルが確立されます。
現在のオフセット
現在のオフセットは破棄されます。
戻り値
>= 0読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。 要求されたレコード サイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。
各種例:
bfilter.cpp, bindexattributes.cpp, block.cpp, bpercentage.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp.

◆ RecordRetrieveFirst() [2/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::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveLast() [1/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ロック モード。
スニペット
// 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;
}
カーソル
カーソルが確立されます。
現在のオフセット
現在のオフセットは破棄されます。
戻り値
>= 0読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。 要求されたレコード サイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。
各種例:
bpercentage.cpp, Test_BTRV2.cpp.

◆ RecordRetrieveLast() [2/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::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrieveNext() [1/2]

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

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

覚え書き
このメソッドは Btrieve::StatusCode を返しません。詳細については、以下を参照してください。
引数
[out]recordレコード。
[in]recordSizeレコード サイズ。
[in]lockModeロック モード。
スニペット
// 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;
}
}
カーソル
カーソルが確立されている必要があります。カーソルは 1 つ前方のレコードに移動されます。
現在のオフセット
現在のオフセットは破棄されます。
戻り値
>= 0読み取られるバイト数。読み取られるバイト数は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については BtrieveFile::RecordRetrieveChunk を参照してください。 要求されたレコード サイズが現在のレコードの長さより小さい場合、 BtrieveFile::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。
各種例:
bindexattributes.cpp.

◆ RecordRetrieveNext() [2/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::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrievePrevious() [1/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::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordRetrievePrevious() [2/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::GetLastStatusCodeBtrieve::STATUS_CODE_DATALENGTH_ERROR を返します。
-1エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveFile::GetLastStatusCode を使用します。

◆ RecordTruncate() [1/2]

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

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

引数
[in]offsetオフセット。offset が -1 の場合は、現在のオフセットが使用されます。
カーソル
カーソルは影響を受けませんが、確立されている必要があります。
現在のオフセット
現在のオフセットは、レコードの末尾に確立されます。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。

◆ RecordTruncate() [2/2]

Btrieve::StatusCode BtrieveFile::RecordTruncate ( )

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

カーソル
カーソルは影響を受けませんが、確立されている必要があります。
現在のオフセット
現在のオフセットは確立されている必要があり、変更されません。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。

◆ RecordUnlock()

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

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

引数
[in]unlockModeロック解除モード。
スニペット
// If RecordUnlock() fails.
{
printf("Error: BtrieveFile::RecordUnlock():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
カーソル
カーソルは影響を受けません。
現在のオフセット
現在のオフセットは影響を受けません。
戻り値
= 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 を参照してください。
スニペット
status = btrieveFile.RecordUpdate((char *)&record, sizeof(record));
カーソル
カーソルは影響を受けませんが、確立されている必要があります。
現在のオフセット
現在のオフセットは影響を受けません。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
block.cpp.

◆ RecordUpdateChunk() [1/2]

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

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

引数
[in]offsetオフセット。offset が -1 の場合は、現在のオフセットが使用されます。
[in]chunkチャンク。
[in]chunkLengthチャンクの長さ。
スニペット
// 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;
}
カーソル
カーソルは影響を受けませんが、確立されている必要があります。
現在のオフセット
現在のオフセットは、更新されたチャンクの末尾に確立されます。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
各種例:
btestchunk.cpp.

◆ RecordUpdateChunk() [2/2]

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

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

引数
[in]chunkチャンク。
[in]chunkLengthチャンクの長さ。
スニペット
// 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;
}
カーソル
カーソルは影響を受けませんが、確立されている必要があります。
現在のオフセット
現在のオフセットは確立されている必要があり、更新されたチャンクの末尾へ移動されます。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。

◆ 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