BtrieveBulkRetrieveResult クラス

Btrieve 一括取得結果クラス。 [詳解]

#include <btrieveCpp.h>

公開メンバ関数
	BtrieveBulkRetrieveResult ()
	~BtrieveBulkRetrieveResult ()
Btrieve::StatusCode	GetLastStatusCode ()
	最新のステータス コードを取得します。 [詳解]
int	GetRecord (int recordNumber, char *record, int recordSize)
	レコードを取得します。 [詳解]
int	GetRecordCount ()
	レコード数を取得します。 [詳解]
long long	GetRecordCursorPosition (int recordNumber)
	レコードのカーソル位置を取得します。 [詳解]
int	GetRecordLength (int recordNumber)
	レコード長を取得します。 [詳解]

詳解

Btrieve 一括取得結果クラス。

各種例:

bfilter.cpp, btestbulk.cpp.

構築子と解体子

BtrieveBulkRetrieveResult()

BtrieveBulkRetrieveResult::BtrieveBulkRetrieveResult

(

)

スニペット

   BtrieveBulkRetrieveResult btrieveBulkRetrieveResult;

~BtrieveBulkRetrieveResult()

BtrieveBulkRetrieveResult::~BtrieveBulkRetrieveResult

(

)

関数詳解

GetLastStatusCode()

Btrieve::StatusCode BtrieveBulkRetrieveResult::GetLastStatusCode

(

)

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

覚え書き

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

スニペット

   // If GetRecord() fails.
   if (btrieveBulkRetrieveResult.GetRecord(1, (char *)&record, sizeof(record)) != sizeof(record))
   {
      status = btrieveBulkRetrieveResult.GetLastStatusCode();
      printf("Error: BtrieveBulkRetrieveResult::GetRecord():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

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

参照

Btrieve::StatusCodeToString

各種例:

bfilter.cpp, btestbulk.cpp.

GetRecord()

int BtrieveBulkRetrieveResult::GetRecord	(	int	recordNumber,
		char *	record,
		int	recordSize
	)

レコードを取得します。

覚え書き

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

引数

[in]	recordNumber	レコード番号。
[out]	record	レコード。
[in]	recordSize	レコード サイズ。

スニペット

   // If GetRecord() fails.
   if (btrieveBulkRetrieveResult.GetRecord(1, (char *)&record, sizeof(record)) != sizeof(record))
   {
      status = btrieveBulkRetrieveResult.GetLastStatusCode();
      printf("Error: BtrieveBulkRetrieveResult::GetRecord():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

>= 0	読み取られるバイト数。読み取られるバイト数は、Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。 長さが Btrieve::MAXIMUM_RECORD_LENGTH より大きいレコードの取得については、BtrieveFile::RecordRetrieveChunk を参照してください。
-1	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには、BtrieveBulkRetrieveResult::GetLastStatusCode を使用します。

各種例:

bfilter.cpp, btestbulk.cpp.

GetRecordCount()

int BtrieveBulkRetrieveResult::GetRecordCount

(

)

レコード数を取得します。

スニペット

   // If GetRecordCount() fails.
   if ((i = btrieveBulkRetrieveResult.GetRecordCount()) != 1)
   {
      status = btrieveBulkRetrieveResult.GetLastStatusCode();
      printf("Error: BtrieveBulkRetrieveResult::GetRecordCount():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

>= 0	レコード数。
-1	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには、BtrieveBulkRetrieveResult::GetLastStatusCode を使用します。

各種例:

bfilter.cpp, btestbulk.cpp.

GetRecordCursorPosition()

long long BtrieveBulkRetrieveResult::GetRecordCursorPosition

(

int

recordNumber

)

レコードのカーソル位置を取得します。

覚え書き

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

引数

[in]

recordNumber

レコード番号。

スニペット

   // If GetRecordCursorPosition() fails.
   if ((cursorPosition = btrieveBulkRetrieveResult.GetRecordCursorPosition(1)) < 0)
   {
      status = btrieveBulkRetrieveResult.GetLastStatusCode();
      printf("Error: BtrieveBulkRetrieveResult::GetRecordCursorPosition():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

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

各種例:

bfilter.cpp, btestbulk.cpp.

GetRecordLength()

int BtrieveBulkRetrieveResult::GetRecordLength

(

int

recordNumber

)

レコード長を取得します。

引数

[in]

recordNumber

レコード番号。

スニペット

   // If GetRecordLength() fails.
   if ((i = btrieveBulkRetrieveResult.GetRecordLength(1)) != sizeof(record))
   {
      status = btrieveBulkRetrieveResult.GetLastStatusCode();
      printf("Error: BtrieveBulkRetrieveResult::GetRecordLength():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

>= 0	レコード長。
-1	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには、BtrieveBulkRetrieveResult::GetLastStatusCode を使用します。

各種例:

bfilter.cpp, btestbulk.cpp.