BtrieveKeySegment クラス

Btrieve キー セグメント クラス。 [詳解]

#include <btrieveCpp.h>

公開メンバ関数
	BtrieveKeySegment ()
	~BtrieveKeySegment ()
Btrieve::ACSMode	GetACSMode ()
	代替照合順序モードを取得します。 [詳解]
int	GetACSNumber ()
	代替照合順序番号を取得します。 [詳解]
Btrieve::DataType	GetDataType ()
	データ型を取得します。 [詳解]
int	GetDescendingSortOrder ()
	降順ソートを取得します。 [詳解]
Btrieve::DuplicateMode	GetDuplicateMode ()
	重複モードを取得します。 [詳解]
Btrieve::Index	GetIndex ()
	インデックスを取得します。 [詳解]
int	GetKeyContinues ()
	キーの継続を取得します。 [詳解]
Btrieve::StatusCode	GetLastStatusCode ()
	最新のステータス コードを取得します。 [詳解]
int	GetLength ()
	長さを取得します。 [詳解]
int	GetModifiable ()
	変更可能を取得します。 [詳解]
Btrieve::NullKeyMode	GetNullKeyMode ()
	ヌル キー モードを取得します。 [詳解]
int	GetNullValue ()
	ヌル値を取得します。 [詳解]
int	GetOffset ()
	オフセットを取得します。 [詳解]
long long	GetUniqueValueCount ()
	ユニーク値の数を取得します。 [詳解]
Btrieve::StatusCode	SetDescendingSortOrder (bool setDescendingSortOrder)
	降順ソートを設定します。 [詳解]
Btrieve::StatusCode	SetField (int offset, int length, Btrieve::DataType dataType)
	フィールドを設定します。 [詳解]
Btrieve::StatusCode	SetNullKeyMode (Btrieve::NullKeyMode nullKeyMode)
	ヌル キー モードを設定します。 [詳解]
Btrieve::StatusCode	SetNullValue (int nullValue)
	ヌル値を設定します。 [詳解]

詳解

Btrieve キー セグメント クラス。

各種例:

bfileinformation.cpp, bfilter.cpp, bindexattributes.cpp, bkeyonly.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestvlr.cpp, Test_BTRV2.cpp.

構築子と解体子

BtrieveKeySegment()

BtrieveKeySegment::BtrieveKeySegment

(

)

スニペット

C++ btest.cpp

   BtrieveKeySegment btrieveKeySegment;

Python btest.py

btrieveKeySegment = btrievePython.BtrieveKeySegment()
assert(btrieveKeySegment != None)

~BtrieveKeySegment()

BtrieveKeySegment::~BtrieveKeySegment

(

)

関数詳解

GetACSMode()

Btrieve::ACSMode BtrieveKeySegment::GetACSMode

(

)

代替照合順序モードを取得します。

スニペット

      // If GetACSMode() fails.
      if ((btrieveACSMode = btrieveKeySegment.GetACSMode()) == Btrieve::ACS_MODE_UNKNOWN)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetACSMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tACSMode = %s\n", Btrieve::ACSModeToString(btrieveACSMode));

戻り値

!= Btrieve::ACS_MODE_UNKNOWN	代替照合順序モード。
= Btrieve::ACS_MODE_UNKNOWN	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

参照

Btrieve::ACSModeToString

各種例:

bfileinformation.cpp.

GetACSNumber()

int BtrieveKeySegment::GetACSNumber

(

)

代替照合順序番号を取得します。

スニペット

      // If GetACSNumber() fails.
      if ((i = btrieveKeySegment.GetACSNumber()) < 0)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetACSNumber():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tACSNumber = %d\n", i);

戻り値

>= 0	代替照合順序番号。
-1	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

各種例:

bfileinformation.cpp.

GetDataType()

Btrieve::DataType BtrieveKeySegment::GetDataType

(

)

データ型を取得します。

スニペット

      // If GetDataType() fails.
      if ((btrieveDataType = btrieveKeySegment.GetDataType()) == Btrieve::DATA_TYPE_UNKNOWN)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetDataType():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tDataType = %s\n", Btrieve::DataTypeToString(btrieveDataType));

戻り値

!= Btrieve::DATA_TYPE_UNKNOWN	データ型。
= Btrieve::DATA_TYPE_UNKNOWN	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

参照

Btrieve::DataTypeToString

各種例:

bfileinformation.cpp.

GetDescendingSortOrder()

int BtrieveKeySegment::GetDescendingSortOrder

(

)

降順ソートを取得します。

スニペット

      // If GetDescendingSortOrder() fails.
      if ((i = btrieveKeySegment.GetDescendingSortOrder()) < 0)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetDescendingSortOrder():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tDescendingSortOrder = %s\n", i > 0 ? "Yes" : "No");

戻り値

> 0	降順ソートが設定されています。
0	降順ソートは設定されていません。
-1	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

各種例:

bfileinformation.cpp.

GetDuplicateMode()

Btrieve::DuplicateMode BtrieveKeySegment::GetDuplicateMode

(

)

重複モードを取得します。

スニペット

      // If GetDuplicateMode() fails.
      if ((btrieveDuplicateMode = btrieveKeySegment.GetDuplicateMode()) == Btrieve::DUPLICATE_MODE_UNKNOWN)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetDuplicateMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tDuplicateMode = %s\n", Btrieve::DuplicateModeToString(btrieveDuplicateMode));

戻り値

!= Btrieve::DUPLICATE_MODE_UNKNOWN	重複モード。
= Btrieve::DUPLICATE_MODE_UNKNOWN	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

参照

Btrieve::DuplicateModeToString

各種例:

bfileinformation.cpp.

GetIndex()

Btrieve::Index BtrieveKeySegment::GetIndex

(

)

インデックスを取得します。

スニペット

      // If GetIndex() fails.
      if ((btrieveIndex = btrieveKeySegment.GetIndex()) == Btrieve::INDEX_UNKNOWN)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetIndex():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tIndex = %s\n", Btrieve::IndexToString(btrieveIndex));

戻り値

!= Btrieve::INDEX_UNKNOWN	インデックス。
= Btrieve::INDEX_UNKNOWN	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

参照

Btrieve::IndexToString

各種例:

bfileinformation.cpp.

GetKeyContinues()

int BtrieveKeySegment::GetKeyContinues

(

)

キーの継続を取得します。

スニペット

      // If GetKeyContinues() fails.
      if ((i = btrieveKeySegment.GetKeyContinues()) < 0)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetKeyContinues():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tKeyContinues = %s\n", i > 0 ? "Yes" : "No");

戻り値

> 0	キーの継続が設定されています。
0	キーの継続は設定されていません。
-1	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

各種例:

bfileinformation.cpp.

GetLastStatusCode()

Btrieve::StatusCode BtrieveKeySegment::GetLastStatusCode

(

)

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

覚え書き

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

スニペット

      // If GetACSMode() fails.
      if ((btrieveACSMode = btrieveKeySegment.GetACSMode()) == Btrieve::ACS_MODE_UNKNOWN)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetACSMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tACSMode = %s\n", Btrieve::ACSModeToString(btrieveACSMode));

戻り値

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

参照

Btrieve::StatusCodeToString

各種例:

bfileinformation.cpp.

GetLength()

int BtrieveKeySegment::GetLength

(

)

長さを取得します。

スニペット

      // If GetLength() fails.
      if ((i = btrieveKeySegment.GetLength()) < 0)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetLength():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tLength = %d\n", i);

戻り値

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

各種例:

bfileinformation.cpp.

GetModifiable()

int BtrieveKeySegment::GetModifiable

(

)

変更可能を取得します。

スニペット

      // If GetModifiable() fails.
      if ((i = btrieveKeySegment.GetModifiable()) < 0)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetModifiable():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tModifiable = %s\n", i > 0 ? "Yes" : "No");

戻り値

> 0	変更可能は許可されています。
0	変更可能は許可されていません。
-1	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

各種例:

bfileinformation.cpp.

GetNullKeyMode()

Btrieve::NullKeyMode BtrieveKeySegment::GetNullKeyMode

(

)

ヌル キー モードを取得します。

スニペット

      // If GetNullKeyMode() fails.
      if ((btrieveNullKeyMode = btrieveKeySegment.GetNullKeyMode()) == Btrieve::NULL_KEY_MODE_UNKNOWN)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetNullKeyMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tNullKeyMode = %s\n", Btrieve::NullKeyModeToString(btrieveNullKeyMode));

戻り値

!= Btrieve::NULL_KEY_MODE_UNKNOWN	ヌル キー モード。
= Btrieve::NULL_KEY_MODE_UNKNOWN	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

参照

Btrieve::NullKeyModeToString

各種例:

bfileinformation.cpp.

GetNullValue()

int BtrieveKeySegment::GetNullValue

(

)

ヌル値を取得します。

スニペット

      // If GetNullValue() fails.
      if ((i = btrieveKeySegment.GetNullValue()) < 0)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetNullValue():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tNullValue = %d\n", i);

戻り値

>= 0	ヌル値。
-1	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

各種例:

bfileinformation.cpp.

GetOffset()

int BtrieveKeySegment::GetOffset

(

)

オフセットを取得します。

スニペット

      // If GetOffset() fails.
      if ((i = btrieveKeySegment.GetOffset()) < 0)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetOffset():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tOffset = %d\n", i);

戻り値

>= 0	オフセット。
-1	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

各種例:

bfileinformation.cpp.

GetUniqueValueCount()

long long BtrieveKeySegment::GetUniqueValueCount

(

)

ユニーク値の数を取得します。

覚え書き

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

スニペット

      // If GetUniqueValueCount() fails.
      if ((uniqueValueCount = btrieveKeySegment.GetUniqueValueCount()) < 0)
      {
         status = btrieveKeySegment.GetLastStatusCode();
         printf("Error: BtrieveKeySegment::GetUniqueValueCount():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
         goto leave;
      }

      printf("\tUniqueValueCount = %lld\n", uniqueValueCount);

戻り値

>= 0	ユニーク値の数。
-1	エラーが発生しました。 エラーに関連する Btrieve::StatusCode を特定するには BtrieveKeySegment::GetLastStatusCode を使用します。

各種例:

bfileinformation.cpp.

SetDescendingSortOrder()

Btrieve::StatusCode BtrieveKeySegment::SetDescendingSortOrder

(

bool

setDescendingSortOrder

)

降順ソートを設定します。

引数

[in]

setDescendingSortOrder

降順ソートを有効にするかどうか。

説明

デフォルトでは、降順ソートは無効になっています。

スニペット

   // If SetDescendingSortOrder() fails.
   if ((status = btrieveKeySegment.SetDescendingSortOrder(true)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveKeySegment::SetDescendingSortOrder():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

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

参照

Btrieve::StatusCodeToString

各種例:

bindexattributes.cpp.

SetField()

Btrieve::StatusCode BtrieveKeySegment::SetField	(	int	offset,
		int	length,
		Btrieve::DataType	dataType
	)

フィールドを設定します。

引数

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

説明

初期の状態では、キー セグメントにフィールドは含まれていません。 （オフセット＋長さ）は Btrieve::MAXIMUM_RECORD_LENGTH に制限されています。

スニペット

C++ btest.cpp

   // If SetField() fails.
   if ((status = btrieveKeySegment.SetField(0, 1, Btrieve::DATA_TYPE_UNSIGNED_BINARY)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveKeySegment::SetField():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

Python btest.py

rc = btrieveKeySegment.SetField(0, 1, btrievePython.Btrieve.DATA_TYPE_UNSIGNED_BINARY)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveKeySegment::SetField():%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, btestvlr.cpp, Test_BTRV2.cpp.

SetNullKeyMode()

Btrieve::StatusCode BtrieveKeySegment::SetNullKeyMode

(

Btrieve::NullKeyMode

nullKeyMode

)

ヌル キー モードを設定します。

引数

[in]

nullKeyMode

ヌル キー モード。

説明

ヌル キー モードのデフォルト値は Btrieve::NULL_KEY_MODE_NONE です。

スニペット

   // If SetNullKeyMode() fails.
   if ((status = btrieveKeySegment.SetNullKeyMode(Btrieve::NULL_KEY_MODE_ANY_SEGMENTS)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveKeySegment::SetNullKeyMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

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

参照

Btrieve::StatusCodeToString

各種例:

bindexattributes.cpp.

SetNullValue()

Btrieve::StatusCode BtrieveKeySegment::SetNullValue

(

int

nullValue

)

ヌル値を設定します。

引数

[in]

nullValue

ヌル値。

説明

ヌル値のデフォルト値は 0 です。

スニペット

   // If SetNullValue() fails.
   if ((status = btrieveKeySegment.SetNullValue(255)) != Btrieve::STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveKeySegment::SetNullValue():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
      goto leave;
   }

戻り値

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

参照

Btrieve::StatusCodeToString

各種例:

bindexattributes.cpp.