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

Btrieve インデックス属性クラス。 [詳解]

#include <btrieveCpp.h>

公開メンバ関数

 BtrieveIndexAttributes ()
 
 ~BtrieveIndexAttributes ()
 
Btrieve::StatusCode AddKeySegment (BtrieveKeySegment *btrieveKeySegment)
 キー セグメントを追加します。 [詳解]
 
Btrieve::StatusCode SetACSMode (Btrieve::ACSMode ACSMode)
 代替照合順序モードを設定します。 [詳解]
 
Btrieve::StatusCode SetACSName (const char *ACSName)
 代替照合順序名を設定します。 [詳解]
 
Btrieve::StatusCode SetACSNumber (int ACSNumber)
 代替照合順序番号を設定します。 [詳解]
 
Btrieve::StatusCode SetACSUserDefined (const char *ACSName, const char *ACSMap, int ACSMapLength)
 ユーザー定義の代替照合順序を設定します。 [詳解]
 
Btrieve::StatusCode SetDuplicateMode (Btrieve::DuplicateMode duplicateMode)
 重複モードを設定します。 [詳解]
 
Btrieve::StatusCode SetIndex (Btrieve::Index index)
 インデックスを設定します。 [詳解]
 
Btrieve::StatusCode SetModifiable (bool enableModifiable)
 変更可能を設定します。 [詳解]
 

詳解

Btrieve インデックス属性クラス。

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

構築子と解体子

◆ BtrieveIndexAttributes()

BtrieveIndexAttributes::BtrieveIndexAttributes ( )
スニペット
C++ btest.cpp
BtrieveIndexAttributes btrieveIndexAttributes;
Python btest.py
btrieveIndexAttributes = btrievePython.BtrieveIndexAttributes()
assert(btrieveIndexAttributes != None)

◆ ~BtrieveIndexAttributes()

BtrieveIndexAttributes::~BtrieveIndexAttributes ( )

関数詳解

◆ AddKeySegment()

Btrieve::StatusCode BtrieveIndexAttributes::AddKeySegment ( BtrieveKeySegment btrieveKeySegment)

キー セグメントを追加します。

引数
[in]btrieveKeySegmentキー セグメント。
説明
初期の状態では、インデックス属性にキー セグメントは含まれていません。
スニペット
C++ btest.cpp
// If AddKeySegment() fails.
if ((status = btrieveIndexAttributes.AddKeySegment(&btrieveKeySegment)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveIndexAttributes::AddKeySegment():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Python btest.py
rc = btrieveIndexAttributes.AddKeySegment(btrieveKeySegment)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveIndexAttributes::AddKeySegment():%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.

◆ SetACSMode()

Btrieve::StatusCode BtrieveIndexAttributes::SetACSMode ( Btrieve::ACSMode  ACSMode)

代替照合順序モードを設定します。

引数
[in]ACSMode代替照合順序モード。
説明
代替照合順序モードは、デフォルトで Btrieve::ACS_MODE_NONE に設定されます。代替照合順序モードを Btrieve::ACS_MODE_NAMED に設定するには BtrieveIndexAttributes::SetACSName または BtrieveIndexAttributes::SetACSUserDefined を使用します。代替照合順序モードを Btrieve::ACS_MODE_NUMBERED に設定するには BtrieveIndexAttributes::SetACSNumber を使用します。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ SetACSName()

Btrieve::StatusCode BtrieveIndexAttributes::SetACSName ( const char *  ACSName)

代替照合順序名を設定します。

覚え書き
このメソッドは、インターナショナル ソート規則と Unicode 代替照合順序名のみを受け付けます。ユーザー定義の代替照合順序を指定するには BtrieveIndexAttributes::SetACSUserDefined を使用します。
引数
[in]ACSName代替照合順序名。
説明
デフォルトでは、代替照合順序名はありません。代替照合順序名を設定するには、代替照合順序モードも Btrieve::ACS_MODE_NAMED に設定します。
スニペット
// If SetACSName() fails.
if ((status = btrieveIndexAttributes.SetACSName("u54-msft_enus_0")) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveIndexAttributes::SetACSName():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bfilter.cpp, bindexattributes.cpp.

◆ SetACSNumber()

Btrieve::StatusCode BtrieveIndexAttributes::SetACSNumber ( int  ACSNumber)

代替照合順序番号を設定します。

引数
[in]ACSNumber代替照合順序番号。
説明
デフォルトでは、代替照合順序番号はありません。代替照合順序番号を設定するには、代替照合順序モードも Btrieve::ACS_MODE_NUMBERED に設定します。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ SetACSUserDefined()

Btrieve::StatusCode BtrieveIndexAttributes::SetACSUserDefined ( const char *  ACSName,
const char *  ACSMap,
int  ACSMapLength 
)

ユーザー定義の代替照合順序を設定します。

引数
[in]ACSName代替照合順序名。
[in]ACSMap代替照合順序マップ。
[in]ACSMapLength代替照合順序マップの長さ。
説明
デフォルトでは、ユーザー定義の代替照合順序はありません。ユーザー定義の代替照合順序を設定するには、代替照合順序モードも Btrieve::ACS_MODE_NAMED に設定します。
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString

◆ SetDuplicateMode()

Btrieve::StatusCode BtrieveIndexAttributes::SetDuplicateMode ( Btrieve::DuplicateMode  duplicateMode)

重複モードを設定します。

引数
[in]duplicateMode重複モード。
説明
重複モードのデフォルト値は Btrieve::DUPLICATE_MODE_NOT_ALLOWED です。
スニペット
// If SetDuplicateMode() fails.
{
printf("Error: BtrieveIndexAttributes::SetDuplicateMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bindexattributes.cpp.

◆ SetIndex()

Btrieve::StatusCode BtrieveIndexAttributes::SetIndex ( Btrieve::Index  index)

インデックスを設定します。

引数
[in]indexインデックス。
説明
インデックスのデフォルト値は、 Btrieve::INDEX_1 から始まる使用可能な最初のインデックスです。
スニペット
// If SetIndex() fails.
if ((status = btrieveIndexAttributes.SetIndex(Btrieve::INDEX_119)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveIndexAttributes::SetIndex():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bindexattributes.cpp.

◆ SetModifiable()

Btrieve::StatusCode BtrieveIndexAttributes::SetModifiable ( bool  enableModifiable)

変更可能を設定します。

引数
[in]enableModifiable変更可能を有効にするかどうか。
説明
デフォルトで、変更可能は有効になっています。
スニペット
// If SetModifiable() fails.
if ((status = btrieveIndexAttributes.SetModifiable(false)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveIndexAttributes::SetModifiable():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
戻り値
= Btrieve::STATUS_CODE_NO_ERROR成功。
!= Btrieve::STATUS_CODE_NO_ERRORエラーが発生しました。
参照
Btrieve::StatusCodeToString
各種例:
bindexattributes.cpp, Test_BTRV2.cpp.