The Btrieve class. More...

#include <btrieveCpp.h>

Public Types
enum	ACSMode
	The Btrieve alternate collation sequence modes. More...

enum	Comparison
	The Btrieve comparisons. More...

enum	Connector
	The Btrieve connectors. More...

enum	CreateMode
	The Btrieve create modes. More...

enum	DataType
	The Btrieve data types. More...

enum	DiskDrive
	The Btrieve disk drives. More...

enum	DuplicateMode
	The Btrieve duplicate modes. More...

enum	EncryptType
	The Btrieve file encryption types. More...

enum	FileVersion
	The Btrieve file versions. More...

enum	FreeSpaceThreshold
	The Btrieve free space thresholds. More...

enum	Index
	The Btrieve indexes. More...

enum	LocationMode
	The Btrieve location modes. More...

enum	LockMode
	The Btrieve lock modes. More...

enum	NullKeyMode
	The Btrieve null key modes. More...

enum	OpenMode
	The Btrieve open modes. More...

enum	OwnerMode
	The Btrieve file owner modes. More...

enum	PageLockType
	The Btrieve page lock type. More...

enum	PageSize
	The Btrieve page sizes. More...

enum	RecordCompressionMode
	The Btrieve record compression modes. More...

enum	StatusCode
	The Btrieve status codes. More...

enum	SystemDataMode
	The Btrieve system data modes. More...

enum	SystemField
	The Btrieve system fields. More...

enum	TransactionMode
	The Btrieve transaction modes. More...

enum	UnlockMode
	The Btrieve unlock modes. More...

enum	VariableLengthRecordsMode
	The Btrieve variable length records modes. More...

enum	VersionType
	The Btrieve version types. More...

Static Public Member Functions
static const char *	ACSModeToString (ACSMode ACSMode)
	Return an alternate collation sequence mode as a string. More...

static const char *	DataTypeToString (DataType dataType)
	Return a data type as a string. More...

static const char *	DuplicateModeToString (DuplicateMode duplicateMode)
	Return a duplicate mode as a string. More...

static const char *	EncryptTypeToString (EncryptType encryptType)
	Return the encryption type as a string. More...

static const char *	FileVersionToString (FileVersion fileVersion)
	Return a file version as a string. More...

static const char *	FreeSpaceThresholdToString (FreeSpaceThreshold freeSpaceThreshold)
	Return a free space threshold as a string. More...

static const char *	IndexToString (Index index)
	Return an index as a string. More...

static const char *	LockModeToString (LockMode lockMode)
	Return a lock mode as a string. More...

static const char *	NullKeyModeToString (NullKeyMode nullKeyMode)
	Return a null key mode as a string. More...

static const char *	OwnerModeToString (OwnerMode ownerMode)
	Return an owner mode as a string. More...

static const char *	PageLockTypeToString (PageLockType pageLockType)
	Return a page lock type as a string. More...

static const char *	PageSizeToString (PageSize pageSize)
	Return a page size as a string. More...

static const char *	RecordCompressionModeToString (RecordCompressionMode recordCompressionMode)
	Return an record compression mode as a string. More...

static const char *	StatusCodeToString (StatusCode statusCode)
	Return a status code as a string. More...

static const char *	SystemDataModeToString (SystemDataMode systemDataMode)
	Return a system data mode as a string. More...

static const char *	SystemFieldToString (SystemField systemField)
	Return a system field as a string. More...

static long long	TimestampToUnixEpochMicroseconds (long long timestamp)
	Convert a Btrieve TIMESTAMP to a Unix Epoch timestamp in microseconds. More...

static long long	UnixEpochMicrosecondsToTimestamp (long long microseconds)
	Convert a Unix Epoch based timestamp in microseconds to a TIMESTAMP. More...

static const char *	VariableLengthRecordsModeToString (VariableLengthRecordsMode variableLengthRecordsMode)
	Return a variable length records mode as a string. More...

static const char *	VersionTypeToString (VersionType versionType)
	Return a version type as a string. More...

Static Public Attributes
static const int	MAXIMUM_BULK_RECORD_COUNT = BTRIEVE_MAXIMUM_BULK_RECORD_COUNT
	The Btrieve maximum bulk record count. More...

static const int	MAXIMUM_KEY_LENGTH = BTRIEVE_MAXIMUM_KEY_LENGTH
	The Btrieve maximum key segment length. More...

static const int	MAXIMUM_RECORD_LENGTH = BTRIEVE_MAXIMUM_RECORD_LENGTH
	The Btrieve maximum record length. More...

Detailed Description

The Btrieve class.

Member Enumeration Documentation

◆ ACSMode

enum Btrieve::ACSMode

The Btrieve alternate collation sequence modes.

See also: Btrieve::ACSModeToString

Enumerator
ACS_MODE_NONE	None.
ACS_MODE_NAMED	Named.
ACS_MODE_NUMBERED	Numbered.
ACS_MODE_CASE_INSENSITIVE	Case insensitive.
ACS_MODE_DEFAULT	Default.
ACS_MODE_UNKNOWN	Unknown.

◆ Comparison

enum Btrieve::Comparison

The Btrieve comparisons.

Snippet: // If SetComparison() fails.
if ((status = btrieveFilter.SetComparison(Btrieve::COMPARISON_EQUAL)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveFilter::SetComparison():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}

Enumerator
COMPARISON_NONE	None.
COMPARISON_EQUAL	Equal.
COMPARISON_GREATER_THAN	Greater than.
COMPARISON_LESS_THAN	Less than.
COMPARISON_NOT_EQUAL	Not equal.
COMPARISON_GREATER_THAN_OR_EQUAL	Greater than or equal.
COMPARISON_LESS_THAN_OR_EQUAL	Less than or equal.
COMPARISON_LIKE	Like.
COMPARISON_NOT_LIKE	Not like.
COMPARISON_JSON_QUERY_MATCH	JSON filter query match.
COMPARISON_UNKNOWN	Unknown.

◆ Connector

enum Btrieve::Connector

The Btrieve connectors.

Snippet: // If SetConnector() fails.
if ((status = btrieveFilter.SetConnector(Btrieve::CONNECTOR_AND)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveFilter::SetConnector():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}

Enumerator
CONNECTOR_LAST	Last.
CONNECTOR_AND	And.
CONNECTOR_OR	Or.
CONNECTOR_UNKNOWN	Unknown.

◆ CreateMode

enum Btrieve::CreateMode

The Btrieve create modes.

Snippet: C++ btest.cpp
// If FileCreate() fails.
if ((status = btrieveClient->FileCreate(&btrieveFileAttributes, btrieveFileName, Btrieve::CREATE_MODE_OVERWRITE)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveClient::FileCreate():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Python btest.py
rc = btrieveClient.FileCreate(btrieveFileAttributes, btrieveFileName, btrievePython.Btrieve.CREATE_MODE_OVERWRITE)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::FileCreate():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

Enumerator
CREATE_MODE_OVERWRITE	Overwrite.
CREATE_MODE_NO_OVERWRITE	No overwrite.
CREATE_MODE_UNKNOWN	Unknown.

◆ DataType

enum Btrieve::DataType

The Btrieve data types.

Snippet: C++ btest.cpp
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))

See also: Btrieve::DataTypeToString

Enumerator
DATA_TYPE_CHAR	Character.
DATA_TYPE_ZSTRING	Null terminated string.
DATA_TYPE_INTEGER	Integer.
DATA_TYPE_UNSIGNED_BINARY	Unsigned binary.
DATA_TYPE_FLOAT	Float.
DATA_TYPE_AUTOINCREMENT	Automatic increment.
DATA_TYPE_DATE	Date.
DATA_TYPE_NUMERICSTS	Numeric sign trailing separate.
DATA_TYPE_TIME	Time.
DATA_TYPE_NUMERICSA	Numeric signed ASCII.
DATA_TYPE_DECIMAL	Decimal.
DATA_TYPE_CURRENCY	Currency.
DATA_TYPE_MONEY	Money.
DATA_TYPE_TIMESTAMP	Timestamp.
DATA_TYPE_LOGICAL	Logical.
DATA_TYPE_WSTRING	Wide string.
DATA_TYPE_NUMERIC	Numeric.
DATA_TYPE_WZSTRING	Wide null terminated string.
DATA_TYPE_BFLOAT	BASIC float.
DATA_TYPE_GUID	Globally unique identifier.
DATA_TYPE_LSTRING	Length first string.
DATA_TYPE_NULL_INDICATOR_SEGMENT	Null indicator segment.
DATA_TYPE_LEGACY_STRING	Legacy string.
DATA_TYPE_LEGACY_BINARY	Legacy binary.
DATA_TYPE_AUTOTIMESTAMP	Automatic timestamp.
DATA_TYPE_CLOB	Character large object.
DATA_TYPE_TIMESTAMP2	Nanosecond resolution timestamp.
DATA_TYPE_BIT	Bit.
DATA_TYPE_NUMERICSLB	Numeric sign leading COBOL.
DATA_TYPE_NUMERICSLS	Numeric sign leading separate.
DATA_TYPE_NUMERICSTB	Numeric sign trailing COBOL.
DATA_TYPE_UNKNOWN	Unknown.

◆ DiskDrive

enum Btrieve::DiskDrive

The Btrieve disk drives.

Enumerator
DISK_DRIVE_A	Disk drive A.
DISK_DRIVE_B	Disk drive B.
DISK_DRIVE_C	Disk drive C.
DISK_DRIVE_D	Disk drive D.
DISK_DRIVE_E	Disk drive E.
DISK_DRIVE_F	Disk drive F.
DISK_DRIVE_G	Disk drive G.
DISK_DRIVE_H	Disk drive H.
DISK_DRIVE_I	Disk drive I.
DISK_DRIVE_J	Disk drive J.
DISK_DRIVE_K	Disk drive K.
DISK_DRIVE_L	Disk drive L.
DISK_DRIVE_M	Disk drive M.
DISK_DRIVE_N	Disk drive N.
DISK_DRIVE_O	Disk drive O.
DISK_DRIVE_P	Disk drive P.
DISK_DRIVE_Q	Disk drive Q.
DISK_DRIVE_R	Disk drive R.
DISK_DRIVE_S	Disk drive S.
DISK_DRIVE_T	Disk drive T.
DISK_DRIVE_U	Disk drive U.
DISK_DRIVE_V	Disk drive V.
DISK_DRIVE_W	Disk drive W.
DISK_DRIVE_X	Disk drive X.
DISK_DRIVE_Y	Disk drive Y.
DISK_DRIVE_Z	Disk drive Z.
DISK_DRIVE_DEFAULT	Default.
DISK_DRIVE_UNKNOWN	Unknown.

◆ DuplicateMode

enum Btrieve::DuplicateMode

The Btrieve duplicate modes.

Snippet: // If SetDuplicateMode() fails.
if ((status = btrieveIndexAttributes.SetDuplicateMode(Btrieve::DUPLICATE_MODE_ALLOWED_NONREPEATING)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveIndexAttributes::SetDuplicateMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}

See also: Btrieve::DuplicateModeToString

Enumerator
DUPLICATE_MODE_NOT_ALLOWED	Duplicates not allowed.
DUPLICATE_MODE_ALLOWED_NONREPEATING	Duplicates allowed, nonrepeating.
DUPLICATE_MODE_ALLOWED_REPEATING	Duplicates allowed, repeating.
DUPLICATE_MODE_UNKNOWN	Unknown.

◆ EncryptType

enum Btrieve::EncryptType

The Btrieve file encryption types.

See also: Btrieve::OwnerModeToString

Enumerator
ENCRYPT_TYPE_NONE	None.
ENCRYPT_TYPE_TRADITIONAL	Traditional encryption.
ENCRYPT_TYPE_128_BIT	128-bit encryption.
ENCRYPT_TYPE_AES_192	AES-192 encryption.
ENCRYPT_TYPE_AES_256	AES-256 encryption.
ENCRYPT_TYPE_UNKNOWN	Unknown.

◆ FileVersion

enum Btrieve::FileVersion

The Btrieve file versions.

Snippet: // If SetFileVersion() fails.
if ((status = btrieveFileAttributes.SetFileVersion(Btrieve::FILE_VERSION_9_5)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveFileAttributes::SetFileVersion():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}

See also: Btrieve::FileVersionToString

Enumerator
FILE_VERSION_6_0	File version 6.0.
FILE_VERSION_6_1	File version 6.1.
FILE_VERSION_7_0	File version 7.0.
FILE_VERSION_8_0	File version 8.0.
FILE_VERSION_9_0	File version 9.0.
FILE_VERSION_9_5	File version 9.5.
FILE_VERSION_13_0	File version 13.0.
FILE_VERSION_DEFAULT	Default.
FILE_VERSION_UNKNOWN	Unknown.

◆ FreeSpaceThreshold

enum Btrieve::FreeSpaceThreshold

The Btrieve free space thresholds.

Snippet: // If SetFreeSpaceThreshold() fails.
if ((status = btrieveFileAttributes.SetFreeSpaceThreshold(Btrieve::FREE_SPACE_THRESHOLD_10_PERCENT)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveFileAttributes::SetFreeSpaceThreshold():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}

See also: Btrieve::FreeSpaceThresholdToString

Enumerator
FREE_SPACE_THRESHOLD_10_PERCENT	Free space threshold 10%.
FREE_SPACE_THRESHOLD_20_PERCENT	Free space threshold 20%.
FREE_SPACE_THRESHOLD_30_PERCENT	Free space threshold 30%.
FREE_SPACE_THRESHOLD_DEFAULT	Default.
FREE_SPACE_THRESHOLD_UNKNOWN	Unknown.

◆ Index

enum Btrieve::Index

The Btrieve indexes.

Snippet: 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: BtrieveFileRecordRetrieveEqual():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

See also: Btrieve::IndexToString

Enumerator
INDEX_1	Index 1.
INDEX_2	Index 2.
INDEX_3	Index 3.
INDEX_4	Index 4.
INDEX_5	Index 5.
INDEX_6	Index 6.
INDEX_7	Index 7.
INDEX_8	Index 8.
INDEX_9	Index 9.
INDEX_10	Index 10.
INDEX_11	Index 11.
INDEX_12	Index 12.
INDEX_13	Index 13.
INDEX_14	Index 14.
INDEX_15	Index 15.
INDEX_16	Index 16.
INDEX_17	Index 17.
INDEX_18	Index 18.
INDEX_19	Index 19.
INDEX_20	Index 20.
INDEX_21	Index 21.
INDEX_22	Index 22.
INDEX_23	Index 23.
INDEX_24	Index 24.
INDEX_25	Index 25.
INDEX_26	Index 26.
INDEX_27	Index 27.
INDEX_28	Index 28.
INDEX_29	Index 29.
INDEX_30	Index 30.
INDEX_31	Index 31.
INDEX_32	Index 32.
INDEX_33	Index 33.
INDEX_34	Index 34.
INDEX_35	Index 35.
INDEX_36	Index 36.
INDEX_37	Index 37.
INDEX_38	Index 38.
INDEX_39	Index 39.
INDEX_40	Index 40.
INDEX_41	Index 41.
INDEX_42	Index 42.
INDEX_43	Index 43.
INDEX_44	Index 44.
INDEX_45	Index 45.
INDEX_46	Index 46.
INDEX_47	Index 47.
INDEX_48	Index 48.
INDEX_49	Index 49.
INDEX_50	Index 50.
INDEX_51	Index 51.
INDEX_52	Index 52.
INDEX_53	Index 53.
INDEX_54	Index 54.
INDEX_55	Index 55.
INDEX_56	Index 56.
INDEX_57	Index 57.
INDEX_58	Index 58.
INDEX_59	Index 59.
INDEX_60	Index 60.
INDEX_61	Index 61.
INDEX_62	Index 62.
INDEX_63	Index 63.
INDEX_64	Index 64.
INDEX_65	Index 65.
INDEX_66	Index 66.
INDEX_67	Index 67.
INDEX_68	Index 68.
INDEX_69	Index 69.
INDEX_70	Index 70.
INDEX_71	Index 71.
INDEX_72	Index 72.
INDEX_73	Index 73.
INDEX_74	Index 74.
INDEX_75	Index 75.
INDEX_76	Index 76.
INDEX_77	Index 77.
INDEX_78	Index 78.
INDEX_79	Index 79.
INDEX_80	Index 80.
INDEX_81	Index 81.
INDEX_82	Index 82.
INDEX_83	Index 83.
INDEX_84	Index 84.
INDEX_85	Index 85.
INDEX_86	Index 86.
INDEX_87	Index 87.
INDEX_88	Index 88.
INDEX_89	Index 89.
INDEX_90	Index 90.
INDEX_91	Index 91.
INDEX_92	Index 92.
INDEX_93	Index 93.
INDEX_94	Index 94.
INDEX_95	Index 95.
INDEX_96	Index 96.
INDEX_97	Index 97.
INDEX_98	Index 98.
INDEX_99	Index 99.
INDEX_100	Index 100.
INDEX_101	Index 101.
INDEX_102	Index 102.
INDEX_103	Index 103.
INDEX_104	Index 104.
INDEX_105	Index 105.
INDEX_106	Index 106.
INDEX_107	Index 107.
INDEX_108	Index 108.
INDEX_109	Index 109.
INDEX_110	Index 110.
INDEX_111	Index 111.
INDEX_112	Index 112.
INDEX_113	Index 113.
INDEX_114	Index 114.
INDEX_115	Index 115.
INDEX_116	Index 116.
INDEX_117	Index 117.
INDEX_118	Index 118.
INDEX_119	Index 119.
INDEX_SYSTEM_VERSION_2	System Version 2.
INDEX_SYSTEM	System.
INDEX_NONE	None.
INDEX_UNKNOWN	Unknown.

◆ LocationMode

enum Btrieve::LocationMode

The Btrieve location modes.

Enumerator
LOCATION_MODE_NO_PREFERENCE	No preference.
LOCATION_MODE_FORCE_LOCAL	Force local.
LOCATION_MODE_FORCE_REMOTE	Force remote.
LOCATION_MODE_UNKNOWN	Unknown.

◆ LockMode

enum Btrieve::LockMode

The Btrieve lock modes.

Snippet: // If RecordRetrieveFirst() fails.
if (btrieveFile->RecordRetrieveFirst(Btrieve::INDEX_1, (char *)&record, sizeof(record), Btrieve::LOCK_MODE_SINGLE_WAIT) != sizeof(record))
{
status = btrieveFile->GetLastStatusCode();
printf("Error: BtrieveFile::RecordRetrieveFirst():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}

See also: Btrieve::LockModeToString

Enumerator
LOCK_MODE_NONE	None.
LOCK_MODE_SINGLE_WAIT	Single with wait.
LOCK_MODE_SINGLE_NO_WAIT	Single with no wait.
LOCK_MODE_MULTIPLE_WAIT	Multiple with wait.
LOCK_MODE_MULTIPLE_NO_WAIT	Multiple with no wait.
LOCK_MODE_UNKNOWN	Unknown.

◆ NullKeyMode

enum Btrieve::NullKeyMode

The Btrieve null key modes.

See also: Btrieve::NullKeyModeToString

Enumerator
NULL_KEY_MODE_ALL_SEGMENTS	All segments.
NULL_KEY_MODE_ANY_SEGMENTS	Any segments.
NULL_KEY_MODE_NONE	None.
NULL_KEY_MODE_UNKNOWN	Unknown.

◆ OpenMode

enum Btrieve::OpenMode

The Btrieve open modes.

Snippet: C++ btest.cpp
// If FileOpen() fails.
if ((status = btrieveClient->FileOpen(btrieveFile, btrieveFileName, NULL, Btrieve::OPEN_MODE_NORMAL)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveClient::FileOpen():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Python btest.py
rc = btrieveClient.FileOpen(btrieveFile, btrieveFileName, None, btrievePython.Btrieve.OPEN_MODE_NORMAL)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveClient::FileOpen():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

Enumerator
OPEN_MODE_NORMAL	Normal.
OPEN_MODE_ACCELERATED	Accelerated.
OPEN_MODE_READ_ONLY	Read only.
OPEN_MODE_EXCLUSIVE	Exclusive.
OPEN_MODE_WRITABLE	Writable.
OPEN_MODE_UNKNOWN	Unknown.

◆ OwnerMode

enum Btrieve::OwnerMode

The Btrieve file owner modes.

See also: Btrieve::OwnerModeToString

Enumerator
OWNER_MODE_NONE	None.
OWNER_MODE_NO_ENCRYPTION_NO_READ_ALLOWED	No encryption with no read allowed.
OWNER_MODE_NO_ENCRYPTION_READ_ALLOWED	No encryption with read allowed.
OWNER_MODE_ENCRYPTION_NO_READ_ALLOWED	Encryption with no read allowed.
OWNER_MODE_ENCRYPTION_READ_ALLOWED	Encryption with read allowed.
OWNER_MODE_UNKNOWN	Unknown.

◆ PageLockType

enum Btrieve::PageLockType

The Btrieve page lock type.

See also: Btrieve::PageLockTypeToString

Enumerator
PAGE_LOCK_TYPE_NONE	None.
PAGE_LOCK_TYPE_DATA_PAGE	Data page.
PAGE_LOCK_TYPE_INDEX_PAGE	Index page.
PAGE_LOCK_TYPE_VARIABLE_PAGE	Variable page.
PAGE_LOCK_TYPE_UNKNOWN	Unknown.

◆ PageSize

enum Btrieve::PageSize

The Btrieve page sizes.

Snippet: // If SetPageSize() fails.
if ((status = btrieveFileAttributes.SetPageSize(Btrieve::PAGE_SIZE_16384, true)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveFileAttributes::SetPageSize():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}

See also: Btrieve::PageSizeToString

Enumerator
PAGE_SIZE_512	Page size 512.
PAGE_SIZE_1024	Page size 1024.
PAGE_SIZE_1536	Page size 1536.
PAGE_SIZE_2048	Page size 2048.
PAGE_SIZE_3072	Page size 3072.
PAGE_SIZE_3584	Page size 3584.
PAGE_SIZE_4096	Page size 4096.
PAGE_SIZE_8192	Page size 8192.
PAGE_SIZE_16384	Page size 16384.
PAGE_SIZE_DEFAULT	Default.
PAGE_SIZE_UNKNOWN	Unknown.

◆ RecordCompressionMode

enum Btrieve::RecordCompressionMode

The Btrieve record compression modes.

Snippet: // If SetRecordCompressionMode() fails.
if ((status = btrieveFileAttributes.SetRecordCompressionMode(Btrieve::RECORD_COMPRESSION_MODE_RUN_LENGTH_ENCODING)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveFileAttributes::SetRecordCompressionMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}

See also: Btrieve::RecordCompressionModeToString

Enumerator
RECORD_COMPRESSION_MODE_NONE	None.
RECORD_COMPRESSION_MODE_BLANK_TRUNCATION	Blank truncation.
RECORD_COMPRESSION_MODE_RUN_LENGTH_ENCODING	Run length encoding.
RECORD_COMPRESSION_MODE_UNKNOWN	Unknown.

◆ StatusCode

enum Btrieve::StatusCode

The Btrieve status codes.

Snippet: C++ btest.cpp
// If SetFixedRecordLength() fails.
if ((status = btrieveFileAttributes.SetFixedRecordLength(sizeof(record_t))) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveFileAttributes::SetFixedRecordLength():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}
Python btest.py
rc = btrieveFileAttributes.SetFixedRecordLength(recordLength)
assert(rc == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), "Error: BtrieveFileAttributes::SetLogicalFixedRecordLength():%d,%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(rc))

See also: Btrieve::StatusCodeToString

Enumerator
STATUS_CODE_NO_ERROR	0 - No error.
STATUS_CODE_INVALID_FUNCTION	1 - Invalid function.
STATUS_CODE_IO_ERROR	2 - Input/Output error.
STATUS_CODE_FILE_NOT_OPEN	3 - File not open.
STATUS_CODE_KEY_VALUE_NOT_FOUND	4 - Key value not found.
STATUS_CODE_DUPLICATE_KEY_VALUE	5 - Duplicate key value.
STATUS_CODE_INVALID_INDEX_NUMBER	6 - Invalid index number.
STATUS_CODE_DIFFERENT_INDEX_NUMBER	7 - Different index number.
STATUS_CODE_POSITION_NOT_SET	8 - Position not set.
STATUS_CODE_END_OF_FILE	9 - End of file.
STATUS_CODE_MODIFIABLE_KEYVALUE_ERROR	10 - Modifiable key value error.
STATUS_CODE_FILENAME_BAD	11 - File name bad.
STATUS_CODE_FILE_NOT_FOUND	12 - File not found.
STATUS_CODE_EXTENDED_FILE_ERROR	13 - Extended file error.
STATUS_CODE_PREIMAGE_OPEN_ERROR	14 - Preimage open error.
STATUS_CODE_PREIMAGE_IO_ERROR	15 - Preimage input/output error.
STATUS_CODE_EXPANSION_ERROR	16 - Expansion error.
STATUS_CODE_CLOSE_ERROR	17 - Close error.
STATUS_CODE_DISKFULL	18 - Disk full.
STATUS_CODE_UNRECOVERABLE_ERROR	19 - Unrecoverable error.
STATUS_CODE_RECORD_MANAGER_INACTIVE	20 - Record manager inactive.
STATUS_CODE_KEYBUFFER_TOO_SHORT	21 - Key buffer too short.
STATUS_CODE_DATALENGTH_ERROR	22 - Data length error.
STATUS_CODE_POSITIONBLOCK_LENGTH	23 - Position block length.
STATUS_CODE_PAGE_SIZE_ERROR	24 - Page size error.
STATUS_CODE_CREATE_IO_ERROR	25 - Create input/output error.
STATUS_CODE_NUMBER_OF_INDEXES	26 - Number of indexes.
STATUS_CODE_INVALID_KEY_POSITION	27 - Invalid key position.
STATUS_CODE_INVALID_RECORD_LENGTH	28 - Invalid record length.
STATUS_CODE_INVALID_KEYLENGTH	29 - Invalid keylength.
STATUS_CODE_NOT_A_BTRIEVE_FILE	30 - Not a Btrieve file.
STATUS_CODE_FILE_ALREADY_EXTENDED	31 - File already extended.
STATUS_CODE_EXTEND_IO_ERROR	32 - Extend input/output error.
STATUS_CODE_BTR_CANNOT_UNLOAD	33 - Btrieve cannot unload.
STATUS_CODE_INVALID_EXTENSION_NAME	34 - Invalid extension name.
STATUS_CODE_DIRECTORY_ERROR	35 - Directory error.
STATUS_CODE_TRANSACTION_ERROR	36 - Transaction error.
STATUS_CODE_TRANSACTION_IS_ACTIVE	37 - Transaction is active.
STATUS_CODE_TRANSACTION_FILE_IO_ERROR	38 - Transaction file input/output error.
STATUS_CODE_END_TRANSACTION_ERROR	39 - End transaction error.
STATUS_CODE_TRANSACTION_MAX_FILES	40 - Transaction maximum files.
STATUS_CODE_OPERATION_NOT_ALLOWED	41 - Operation not allowed.
STATUS_CODE_INCOMPLETE_ACCEL_ACCESS	42 - Incomplete accelerated access.
STATUS_CODE_INVALID_RECORD_ADDRESS	43 - Invalid record address.
STATUS_CODE_NULL_KEYPATH	44 - Null key path.
STATUS_CODE_INCONSISTENT_KEY_FLAGS	45 - Inconsistent key flags.
STATUS_CODE_ACCESS_TO_FILE_DENIED	46 - Access to file denied.
STATUS_CODE_MAXIMUM_OPEN_FILES	47 - Maximum open files.
STATUS_CODE_INVALID_ALT_SEQUENCE_DEF	48 - Invalid alternate collating sequence definition.
STATUS_CODE_KEY_TYPE_ERROR	49 - Key type error.
STATUS_CODE_OWNER_ALREADY_SET	50 - Owner already set.
STATUS_CODE_INVALID_OWNER	51 - Invalid owner.
STATUS_CODE_ERROR_WRITING_CACHE	52 - Error writing cache.
STATUS_CODE_INVALID_INTERFACE	53 - Invalid interface.
STATUS_CODE_VARIABLE_PAGE_ERROR	54 - Variable page error.
STATUS_CODE_AUTOINCREMENT_ERROR	55 - Autoincrement error.
STATUS_CODE_INCOMPLETE_INDEX	56 - Incomplete index.
STATUS_CODE_EXPANED_MEM_ERROR	57 - Expaned memory error.
STATUS_CODE_COMPRESS_BUFFER_TOO_SHORT	58 - Compress buffer too short.
STATUS_CODE_FILE_ALREADY_EXISTS	59 - File already exists.
STATUS_CODE_REJECT_COUNT_REACHED	60 - Reject count reached.
STATUS_CODE_SMALL_EX_GET_BUFFER_ERROR	61 - Small extended get buffer error.
STATUS_CODE_INVALID_GET_EXPRESSION	62 - Invalid get expression.
STATUS_CODE_INVALID_EXT_INSERT_BUFF	63 - Invalid extended insert buffer.
STATUS_CODE_OPTIMIZE_LIMIT_REACHED	64 - Optimize limit reached.
STATUS_CODE_INVALID_EXTRACTOR	65 - Invalid extractor.
STATUS_CODE_RI_TOO_MANY_DATABASES	66 - Referential integrity too many databases.
STATUS_CODE_RIDDF_CANNOT_OPEN	67 - Referential integrity SQL data dictionary files cannot open.
STATUS_CODE_RI_CASCADE_TOO_DEEP	68 - Referential integrity cascade too deep.
STATUS_CODE_RI_CASCADE_ERROR	69 - Referential integrity cascade error.
STATUS_CODE_RI_VIOLATION	71 - Referential integrity violation.
STATUS_CODE_RI_REFERENCED_FILE_CANNOT_OPEN	72 - Referential integrity referenced file cannot open.
STATUS_CODE_RI_OUT_OF_SYNC	73 - Referential integrity out of sync.
STATUS_CODE_END_CHANGED_TO_ABORT	74 - End changed to abort.
STATUS_CODE_RI_CONFLICT	76 - Referential integrity conflict.
STATUS_CODE_CANT_LOOP_IN_SERVER	77 - Can't loop in server.
STATUS_CODE_DEAD_LOCK	78 - Dead lock.
STATUS_CODE_PROGRAMMING_ERROR	79 - Programming error.
STATUS_CODE_CONFLICT	80 - Conflict.
STATUS_CODE_LOCKERROR	81 - Lock error.
STATUS_CODE_LOST_POSITION	82 - Lost position.
STATUS_CODE_READ_OUTSIDE_TRANSACTION	83 - Read outside transaction.
STATUS_CODE_RECORD_INUSE	84 - Record in use.
STATUS_CODE_FILE_INUSE	85 - File in use.
STATUS_CODE_FILE_TABLE_FULL	86 - File table full.
STATUS_CODE_NOHANDLES_AVAILABLE	87 - No handles available.
STATUS_CODE_INCOMPATIBLE_MODE_ERROR	88 - Incompatible mode error.
STATUS_CODE_DEVICE_TABLE_FULL	90 - Device table full.
STATUS_CODE_SERVER_ERROR	91 - Server error.
STATUS_CODE_TRANSACTION_TABLE_FULL	92 - Transaction table full.
STATUS_CODE_INCOMPATIBLE_LOCK_TYPE	93 - Incompatible lock type.
STATUS_CODE_PERMISSION_ERROR	94 - Permission error.
STATUS_CODE_SESSION_NO_LONGER_VALID	95 - Session no longer valid.
STATUS_CODE_COMMUNICATIONS_ERROR	96 - Communications error.
STATUS_CODE_DATA_MESSAGE_TOO_SMALL	97 - Data message too small.
STATUS_CODE_INTERNAL_TRANSACTION_ERROR	98 - Internal transaction error.
STATUS_CODE_REQUESTER_CANT_ACCESS_RUNTIME	99 - Requester can't access runtime.
STATUS_CODE_NO_CACHE_BUFFERS_AVAIL	100 - No cache buffers available.
STATUS_CODE_NO_OS_MEMORY_AVAIL	101 - No operating system memory available.
STATUS_CODE_NO_STACK_AVAIL	102 - No stack available.
STATUS_CODE_CHUNK_OFFSET_TOO_LONG	103 - Chunk offset too long.
STATUS_CODE_LOCALE_ERROR	104 - Locale error.
STATUS_CODE_CANNOT_CREATE_WITH_VAT	105 - Cannot create with variable tail allocation table.
STATUS_CODE_CHUNK_CANNOT_GET_NEXT	106 - Chunk cannot get next.
STATUS_CODE_CHUNK_INCOMPATIBLE_FILE	107 - Chunk incompatible file.
STATUS_CODE_TRANSACTION_TOO_COMPLEX	109 - Transaction too complex.
STATUS_CODE_ARCH_BLOG_OPEN_ERROR	110 - Archival BLOG open error.
STATUS_CODE_ARCH_FILE_NOT_LOGGED	111 - Archival file not logged.
STATUS_CODE_ARCH_FILE_IN_USE	112 - Archival file in use.
STATUS_CODE_ARCH_LOGFILE_NOT_FOUND	113 - Archival log file not found.
STATUS_CODE_ARCH_LOGFILE_INVALID	114 - Archival log file invalid.
STATUS_CODE_ARCH_DUMPFILE_ACCESS_ERROR	115 - Archival dump file access error.
STATUS_CODE_LOCATOR_FILE_INDICATOR	116 - Locator file indicator.
STATUS_CODE_NO_SYSTEM_LOCKS_AVAILABLE	130 - No system locks available.
STATUS_CODE_FILE_FULL	132 - File full.
STATUS_CODE_MORE_THAN_5_CONCURRENT_USERS	133 - More than 5 concurrent users.
STATUS_CODE_ISR_NOT_FOUND	134 - International sorting rule not found.
STATUS_CODE_ISR_INVALID	135 - International sorting rule invalid.
STATUS_CODE_ACS_NOT_FOUND	136 - Alternate collating sequence not found.
STATUS_CODE_CANNOT_CONVERT_RP	137 - Cannot convert RP.
STATUS_CODE_INVALID_NULL_INDICATOR	138 - Invalid null indicator.
STATUS_CODE_INVALID_KEY_OPTION	139 - Invalid key option.
STATUS_CODE_INCOMPATIBLE_CLOSE	140 - Incompatible close.
STATUS_CODE_INVALID_USERNAME	141 - Invalid user name.
STATUS_CODE_INVALID_DATABASE	142 - Invalid database.
STATUS_CODE_NO_SSQL_RIGHTS	143 - No SSQL rights.
STATUS_CODE_ALREADY_LOGGED_IN	144 - Already logged in.
STATUS_CODE_NO_DATABASE_SERVICES	145 - No database services.
STATUS_CODE_DUPLICATE_SYSTEM_KEY	146 - Duplicate system key.
STATUS_CODE_LOG_SEGMENT_MISSING	147 - Log segment missing.
STATUS_CODE_ROLL_FORWARD_ERROR	148 - Roll forward error.
STATUS_CODE_SYSTEM_KEY_INTERNAL	149 - System key internal.
STATUS_CODE_DBS_INTERNAL_ERROR	150 - DBS internal error.
STATUS_CODE_CHUNK_OFFSET_TOO_SMALL	151 - Chunk offset too small. Note Renamed from STATUS_CODE_NESTING_DEPTH_ERROR in Zen v15 R1.
STATUS_CODE_INVALID_PARAMETER_TO_MKDE	160 - Invalid parameter to MicroKernel.
STATUS_CODE_USER_COUNT_LIMIT_EXCEEDED	161 - User count limit exceeded.
STATUS_CODE_CLIENT_TABLE_FULL	162 - Client table full.
STATUS_CODE_LAST_SEGMENT_ERROR	163 - Last segment error.
STATUS_CODE_LOGIN_FAILED_BAD_USERNAME	170 - Login failed bad user name.
STATUS_CODE_LOGIN_FAILED_BAD_PASSWORD	171 - Login failed bad password.
STATUS_CODE_LOGIN_FAILED_BAD_DATABASE	172 - Login failed bad database.
STATUS_CODE_LOGIN_ALREADY_LOGGED_IN	173 - Login already logged in.
STATUS_CODE_LOGIN_LOGOUT_FAILED	174 - Login logout failed.
STATUS_CODE_LOGIN_WRONG_URI_FORMAT	175 - Login wrong uniform resource indicator format.
STATUS_CODE_LOGIN_FILE_AND_TABLE_NOT_FOUND	176 - Login file and table not found.
STATUS_CODE_LOGIN_TABLE_NOT_IN_DATABASE	177 - Login table not in database.
STATUS_CODE_LOGIN_DIRECTORY_NOT_IN_DATABASE	178 - Login directory not in database.
STATUS_CODE_LOCK_PARM_OUTOFRANGE	1001 - Lock parameter out of range.
STATUS_CODE_MEM_ALLOCATION_ERR	1002 - Memory allocation error.
STATUS_CODE_MEM_PARM_TOO_SMALL	1003 - Memory parameter too small.
STATUS_CODE_PAGE_SIZE_PARM_OUTOFRANGE	1004 - Page size parameter out of range.
STATUS_CODE_INVALID_PREIMAGE_PARM	1005 - Invalid preimage parameter.
STATUS_CODE_PREIMAGE_BUF_PARM_OUTOFRANGE	1006 - Preimage buffer parameter out of range.
STATUS_CODE_FILES_PARM_OUTOFRANGE	1007 - Files parameter out of range.
STATUS_CODE_INVALID_INIT_PARM	1008 - Invalid initialization parameter.
STATUS_CODE_INVALID_TRANS_PARM	1009 - Invalid transaction parameter.
STATUS_CODE_ERROR_ACC_TRANS_CONTROL_FILE	1010 - Error access transaction control file.
STATUS_CODE_COMPRESSION_BUF_PARM_OUTOFRANGE	1011 - Compression buffer parameter out of range.
STATUS_CODE_INV_N_OPTION	1012 - Invalid "Maximum Number Of Files In A Transaction" option.
STATUS_CODE_TASK_LIST_FULL	1013 - Task list full.
STATUS_CODE_STOP_WARNING	1014 - Stop warning.
STATUS_CODE_POINTER_PARM_INVALID	1015 - Pointer parameter invalid.
STATUS_CODE_ALREADY_INITIALIZED	1016 - Already initialized.
STATUS_CODE_REQ_CANT_FIND_RES_DLL	1017 - Btrieve Requester can't find resource DLL.
STATUS_CODE_ALREADY_INSIDE_BTR_FUNCTION	1018 - Already inside Btrieve function.
STATUS_CODE_CALLBACK_ABORT	1019 - Callback abort.
STATUS_CODE_INTF_COMM_ERROR	1020 - Interface communications error.
STATUS_CODE_FAILED_TO_INITIALIZE	1021 - Failed to initialize.
STATUS_CODE_MKDE_SHUTTING_DOWN	1022 - MicroKernel shutting down.
STATUS_CODE_INTERNAL_ERROR	2000 - Internal error.
STATUS_CODE_INSUFFICIENT_MEM_ALLOC	2001 - Insufficient memory allocation.
STATUS_CODE_INVALID_OPTION	2002 - Invalid option.
STATUS_CODE_NO_LOCAL_ACCESS_ALLOWED	2003 - No local access allowed.
STATUS_CODE_SPX_NOT_INSTALLED	2004 - SPX not installed.
STATUS_CODE_INCORRECT_SPX_VERSION	2005 - Incorrect SPX version.
STATUS_CODE_NO_AVAIL_SPX_CONNECTION	2006 - No available SPX connection.
STATUS_CODE_INVALID_PTR_PARM	2007 - Invalid pointer parameter.
STATUS_CODE_CANT_CONNECT_TO_615	2008 - Can't connect to 615.
STATUS_CODE_CANT_LOAD_MKDE_ROUTER	2009 - Can't load MicroKernel router.
STATUS_CODE_UT_THUNK_NOT_LOADED	2010 - UT thunk not loaded.
STATUS_CODE_NO_RESOURCE_DLL	2011 - No resource DLL.
STATUS_CODE_OS_ERROR	2012 - Operating system error.
STATUS_CODE_MK_ROUTER_MEM_ERROR	3000 - MicroKernel router memory error.
STATUS_CODE_MK_NO_LOCAL_ACCESS_ALLOWED	3001 - MicroKernel no local access allowed.
STATUS_CODE_MK_NO_RESOURCE_DLL	3002 - MicroKernel no resource DLL.
STATUS_CODE_MK_INCOMPAT_COMPONENT	3003 - MicroKernel incompatible component.
STATUS_CODE_MK_TIMEOUT_ERROR	3004 - MicroKernel timeout error.
STATUS_CODE_MK_OS_ERROR	3005 - MicroKernel operating system error.
STATUS_CODE_MK_INVALID_SESSION	3006 - MicroKernel invalid session.
STATUS_CODE_MK_SERVER_NOT_FOUND	3007 - MicroKernel server not found.
STATUS_CODE_MK_INVALID_CONFIG	3008 - MicroKernel invalid configuration.
STATUS_CODE_MK_NETAPI_NOT_LOADED	3009 - MicroKernel NETAPI not loaded.
STATUS_CODE_MK_NWAPI_NOT_LOADED	3010 - MicroKernel NWAPI not loaded.
STATUS_CODE_MK_THUNK_NOT_LOADED	3011 - MicroKernel thunk not loaded.
STATUS_CODE_MK_LOCAL_NOT_LOADED	3012 - MicroKernel local not loaded.
STATUS_CODE_MK_PNSL_NOT_LOADED	3013 - MicroKernel Network Services Layer not loaded.
STATUS_CODE_MK_CANT_FIND_ENGINE	3014 - MicroKernel can't find engine.
STATUS_CODE_MK_INIT_ERROR	3015 - MicroKernel initialization error.
STATUS_CODE_MK_INTERNAL_ERROR	3016 - MicroKernel internal error.
STATUS_CODE_MK_LOCAL_MKDE_DATABUF_TOO_SMALL	3017 - MicroKernel local MicroKernel data buffer too small.
STATUS_CODE_MK_CLOSED_ERROR	3018 - MicroKernel closed error.
STATUS_CODE_MK_SEMAPHORE_ERROR	3019 - MicroKernel semaphore error.
STATUS_CODE_MK_LOADING_ERROR	3020 - MicroKernel loading error.
STATUS_CODE_MK_BAD_SRB_FORMAT	3021 - MicroKernel bad SRB format.
STATUS_CODE_MK_DATABUF_LEN_TOO_LARGE	3022 - MicroKernel data buffer length too large.
STATUS_CODE_MK_TASK_TABLE_FULL	3023 - MicroKernel task table full.
STATUS_CODE_MK_INVALID_OP_ON_REMOTE	3024 - MicroKernel invalid operation on remote.
STATUS_CODE_MK_PIDS_NOT_LOADED	3025 - MicroKernel PIDs not loaded.
STATUS_CODE_MK_BAD_PIDS	3026 - MicroKernel bad PIDs.
STATUS_CODE_MK_IDS_CONNECT_FAILURE	3027 - MicroKernel IDS connect failure.
STATUS_CODE_MK_IDS_LOGIN_FAILURE	3028 - MicroKernel IDS login failure.
STATUS_CODE_NL_FAILURE	3101 - Network layer failure.
STATUS_CODE_NL_NOT_INITIALIZED	3102 - Network layer not initialized.
STATUS_CODE_NL_NAME_NOT_FOUND	3103 - Network layer name not found.
STATUS_CODE_NL_PERMISSION_ERROR	3104 - Network layer permission error.
STATUS_CODE_NL_NO_AVAILABLE_TRANSPORT	3105 - Network layer no available transport.
STATUS_CODE_NL_CONNECTION_FAILURE	3106 - Network layer connection failure.
STATUS_CODE_NL_OUT_OF_MEMORY	3107 - Network layer out of memory.
STATUS_CODE_NL_INVALID_SESSION	3108 - Network layer invalid session.
STATUS_CODE_NL_MORE_DATA	3109 - Network layer more data.
STATUS_CODE_NL_NOT_CONNECTED	3110 - Network layer not connected.
STATUS_CODE_NL_SEND_FAILURE	3111 - Network layer send failure.
STATUS_CODE_NL_RECEIVE_FAILURE	3112 - Network layer receive failure.
STATUS_CODE_NL_INVALID_SERVER_TYPE	3113 - Network layer invalid server type.
STATUS_CODE_NL_SRT_FULL	3114 - Network layer server routing table full.
STATUS_CODE_NL_TRANSPORT_FAILURE	3115 - Network layer transport failure.
STATUS_CODE_NL_RCV_DATA_OVERFLOW	3116 - Network layer receive data overflow.
STATUS_CODE_NL_CST_FULL	3117 - Network layer CST full.
STATUS_CODE_NL_INVALID_ADDRESS_FAMILY	3118 - Network layer invalid address family.
STATUS_CODE_NL_NO_AUTH_CONTEXT_AVAILABLE	3119 - Network layer no authentication context available.
STATUS_CODE_NL_INVALID_AUTH_TYPE	3120 - Network layer invalid authentication type.
STATUS_CODE_NL_INVALID_AUTH_OBJECT	3121 - Network layer invalid authentication object.
STATUS_CODE_NL_AUTH_LEN_TOO_SMALL	3122 - Network layer authentication length too small.
STATUS_CODE_NL_INVALID_SESSION_LEVEL_PARM	3123 - Network layer invalid session level parameter.
STATUS_CODE_NL_TASK_TABLE_FULL	3124 - Network layer task table full.
STATUS_CODE_NL_NDS_NAME_RESOLUTION_ERROR	3125 - Network layer NDS name resolution error.
STATUS_CODE_NL_FILE_NAME_RESOLUTION_ERROR	3126 - Network layer file name resolution error.
STATUS_CODE_NL_IDS_SEND_FAILURE	3127 - Network layer IDS send failure.
STATUS_CODE_NL_IDS_RCV_FAILURE	3128 - Network layer IDS receive failure.
STATUS_CODE_UNKNOWN	-7 - Unknown.

◆ SystemDataMode

enum Btrieve::SystemDataMode

The Btrieve system data modes.

Snippet: // If SetSystemDataMode() fails.
if ((status = btrieveFileAttributes.SetSystemDataMode(Btrieve::SYSTEM_DATA_MODE_NO)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveFileAttributes::SetSystemDataMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}

See also: Btrieve::SystemDataModeToString

Enumerator
SYSTEM_DATA_MODE_YES	Yes.
SYSTEM_DATA_MODE_NO	No.
SYSTEM_DATA_MODE_DEFAULT	Default.
SYSTEM_DATA_MODE_VERSION_2	Version 2.
SYSTEM_DATA_MODE_UNKNOWN	Unknown.

◆ SystemField

enum Btrieve::SystemField

The Btrieve system fields.

See also: Btrieve::SystemFieldToString

Enumerator
SYSTEM_FIELD_CREATE_TIME	Create time.
SYSTEM_FIELD_UPDATE_TIME	Update time.
SYSTEM_FIELD_UNKNOWN	Unknown.

◆ TransactionMode

enum Btrieve::TransactionMode

The Btrieve transaction modes.

Enumerator
TRANSACTION_MODE_EXCLUSIVE	Exclusive.
TRANSACTION_MODE_CONCURRENT_WRITE_WAIT	Concurrent with write wait.
TRANSACTION_MODE_CONCURRENT_NO_WRITE_WAIT	Concurrent with no write wait.
TRANSACTION_MODE_UNKNOWN	Unknown.

◆ UnlockMode

enum Btrieve::UnlockMode

The Btrieve unlock modes.

Snippet: // 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;
}

Enumerator
UNLOCK_MODE_SINGLE	Single.
UNLOCK_MODE_MULTIPLE	Multiple.
UNLOCK_MODE_UNKNOWN	Unknown.

◆ VariableLengthRecordsMode

enum Btrieve::VariableLengthRecordsMode

The Btrieve variable length records modes.

Snippet: // If SetVariableLengthRecordsMode() fails.
if ((status = btrieveFileAttributes.SetVariableLengthRecordsMode(Btrieve::VARIABLE_LENGTH_RECORDS_MODE_YES_VARIABLE_ALLOCATION_TAILS)) != Btrieve::STATUS_CODE_NO_ERROR)
{
printf("Error: BtrieveFileAttributes::SetVariableLengthRecordsMode():%d:%s.\n", status, Btrieve::StatusCodeToString(status));
goto leave;
}

See also: Btrieve::VariableLengthRecordsModeToString

Enumerator
VARIABLE_LENGTH_RECORDS_MODE_NO	No.
VARIABLE_LENGTH_RECORDS_MODE_YES	Yes.
VARIABLE_LENGTH_RECORDS_MODE_YES_VARIABLE_ALLOCATION_TAILS	Yes with variable allocation tails.
VARIABLE_LENGTH_RECORDS_MODE_UNKNOWN	Unknown.

◆ VersionType

enum Btrieve::VersionType

The Btrieve version types.

See also: Btrieve::VersionTypeToString

Enumerator
VERSION_TYPE_NONE	None.
VERSION_TYPE_BTRIEVE_ENGINE	Btrieve engine.
VERSION_TYPE_WORKGROUP_ENGINE	Workgroup engine.
VERSION_TYPE_DOS_WORKSTATION	DOS workstation.
VERSION_TYPE_CLIENT_REQUESTOR	Client.
VERSION_TYPE_WINDOWS_SERVER_ENGINE	Windows server engine.
VERSION_TYPE_UNIX	UNIX.
VERSION_TYPE_CLIENT_ENGINE	Client engine.
VERSION_TYPE_UNKNOWN	Unknown.

Member Function Documentation

◆ ACSModeToString()

static const char* Btrieve::ACSModeToString ( ACSMode ACSMode )

static

Return an alternate collation sequence mode as a string.

Parameters

[in] ACSMode The alternate collation sequence mode.

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

Returns: The string.

Examples:: bfileinformation.cpp.

◆ DataTypeToString()

static const char* Btrieve::DataTypeToString ( DataType dataType )

static

Return a data type as a string.

Parameters

[in] dataType The data type.

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

Returns: The string.

Examples:: bfileinformation.cpp.

◆ DuplicateModeToString()

static const char* Btrieve::DuplicateModeToString ( DuplicateMode duplicateMode )

static

Return a duplicate mode as a string.

Parameters

[in] duplicateMode The duplicate mode.

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

Returns: The string.

Examples:: bfileinformation.cpp.

◆ EncryptTypeToString()

static const char* Btrieve::EncryptTypeToString ( EncryptType encryptType )

static

Return the encryption type as a string.

Parameters

[in] encryptType The encryption type.

Returns: The string.

◆ FileVersionToString()

static const char* Btrieve::FileVersionToString ( FileVersion fileVersion )

static

Return a file version as a string.

Parameters

[in] fileVersion The file version.

Snippet: printf("FileVersion = %s\n", Btrieve::FileVersionToString(btrieveFileVersion));

Returns: The string.

Examples:: bfileattributes.cpp, and bfileinformation.cpp.

◆ FreeSpaceThresholdToString()

static const char* Btrieve::FreeSpaceThresholdToString ( FreeSpaceThreshold freeSpaceThreshold )

static

Return a free space threshold as a string.

Parameters

[in] freeSpaceThreshold The free space threshold.

Snippet: printf("FreeSpaceThreshold = %s\n", Btrieve::FreeSpaceThresholdToString(btrieveFreeSpaceThreshold));

Returns: The string.

Examples:: bfileattributes.cpp, and bfileinformation.cpp.

◆ IndexToString()

static const char* Btrieve::IndexToString ( Index index )

static

Return an index as a string.

Parameters

[in] index The index.

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

Returns: The string.

Examples:: bfileinformation.cpp.

◆ LockModeToString()

static const char* Btrieve::LockModeToString ( LockMode lockMode )

static

Return a lock mode as a string.

Parameters

[in] lockMode The lock mode.

Snippet: printf("LockOwnerExplicitLockMode = %s\n", Btrieve::LockModeToString(btrieveLockMode));

Returns: The string.

Examples:: bfileinformation.cpp.

◆ NullKeyModeToString()

static const char* Btrieve::NullKeyModeToString ( NullKeyMode nullKeyMode )

static

Return a null key mode as a string.

Parameters

[in] nullKeyMode The null key mode.

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

Returns: The string.

Examples:: bfileinformation.cpp.

◆ OwnerModeToString()

static const char* Btrieve::OwnerModeToString ( OwnerMode ownerMode )

static

Return an owner mode as a string.

Parameters

[in] ownerMode The owner mode.

Snippet: printf("OwnerMode = %s\n", Btrieve::OwnerModeToString(btrieveOwnerMode));

Returns: The string.

Examples:: bfileinformation.cpp.

◆ PageLockTypeToString()

static const char* Btrieve::PageLockTypeToString ( PageLockType pageLockType )

static

Return a page lock type as a string.

Parameters

[in] pageLockType The page lock type.

Snippet: printf("LockOwnerPageLockType = %s\n", Btrieve::PageLockTypeToString(btrievePageLockType));

Returns: The string.

Examples:: bfileinformation.cpp.

◆ PageSizeToString()

static const char* Btrieve::PageSizeToString ( PageSize pageSize )

static

Return a page size as a string.

Parameters

[in] pageSize The page size.

Snippet: printf("PageSize = %s\n", Btrieve::PageSizeToString(btrievePageSize));

Returns: The string.

Examples:: bfileattributes.cpp, and bfileinformation.cpp.

◆ RecordCompressionModeToString()

static const char* Btrieve::RecordCompressionModeToString ( RecordCompressionMode recordCompressionMode )

static

Return an record compression mode as a string.

Parameters

[in] recordCompressionMode The record compression mode.

Snippet: printf("RecordCompressionMode = %s\n", Btrieve::RecordCompressionModeToString(btrieveRecordCompressionMode));

Returns: The string.

Examples:: bfileattributes.cpp, and bfileinformation.cpp.

◆ StatusCodeToString()

static const char* Btrieve::StatusCodeToString ( StatusCode statusCode )

static

Return a status code as a string.

Parameters

[in] statusCode The status code.

Snippet: 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: BtrieveFileRecordRetrieveEqual():%d:%s.\n" % (rc, btrievePython.Btrieve_StatusCodeToString(btrieveFile.GetLastStatusCode()))

Returns: The string.

Examples:: bfileattributes.cpp, bfileinformation.cpp, bfilter.cpp, bindexattributes.cpp, bkeyonly.cpp, block.cpp, bpercentage.cpp, btest.cpp, btestappend.cpp, btestbulk.cpp, btestchunk.cpp, btestvlr.cpp, bversion.cpp, and Test_BTRV2.cpp.

◆ SystemDataModeToString()

static const char* Btrieve::SystemDataModeToString ( SystemDataMode systemDataMode )

static

Return a system data mode as a string.

Parameters

[in] systemDataMode The system data mode.

Snippet: printf("SystemDataMode = %s\n", Btrieve::SystemDataModeToString(btrieveSystemDataMode));

Returns: The string.

Examples:: bfileattributes.cpp, and bfileinformation.cpp.

◆ SystemFieldToString()

static const char* Btrieve::SystemFieldToString ( SystemField systemField )

static

Return a system field as a string.

Parameters

[in] systemField The system field.

Returns: The string.

◆ TimestampToUnixEpochMicroseconds()

static long long Btrieve::TimestampToUnixEpochMicroseconds ( long long timestamp )

static

Convert a Btrieve TIMESTAMP to a Unix Epoch timestamp in microseconds.

Parameters

[in] timestamp The Btrieve TIMESTAMP.

Returns: The Epoch based timestamp in microseconds.

◆ UnixEpochMicrosecondsToTimestamp()

static long long Btrieve::UnixEpochMicrosecondsToTimestamp ( long long microseconds )

static

Convert a Unix Epoch based timestamp in microseconds to a TIMESTAMP.

Parameters

[in] microseconds The Unix Epoch timestamp in microseconds granularity.

Returns: The Btrieve TIMESTAMP.

Examples:: Test_BTRV2.cpp.

◆ VariableLengthRecordsModeToString()

static const char* Btrieve::VariableLengthRecordsModeToString ( VariableLengthRecordsMode variableLengthRecordsMode )

static

Return a variable length records mode as a string.

Parameters

[in] variableLengthRecordsMode The variable length records mode.

Snippet: printf("VariableLengthRecordsMode = %s\n", Btrieve::VariableLengthRecordsModeToString(btrieveVariableLengthRecordsMode));

Returns: The string.

Examples:: bfileattributes.cpp, and bfileinformation.cpp.

◆ VersionTypeToString()

static const char* Btrieve::VersionTypeToString ( VersionType versionType )

static

Return a version type as a string.

Parameters

[in] versionType The version type.

Snippet: printf("ClientVersionType = %s\n", Btrieve::VersionTypeToString(btrieveVersionType));

Returns: The string.

Examples:: bversion.cpp.

Member Data Documentation

◆ MAXIMUM_BULK_RECORD_COUNT

const int Btrieve::MAXIMUM_BULK_RECORD_COUNT = BTRIEVE_MAXIMUM_BULK_RECORD_COUNT

static

The Btrieve maximum bulk record count.

◆ MAXIMUM_KEY_LENGTH

const int Btrieve::MAXIMUM_KEY_LENGTH = BTRIEVE_MAXIMUM_KEY_LENGTH

static

The Btrieve maximum key segment length.

Examples:: bindexattributes.cpp.

◆ MAXIMUM_RECORD_LENGTH

const int Btrieve::MAXIMUM_RECORD_LENGTH = BTRIEVE_MAXIMUM_RECORD_LENGTH

static

The Btrieve maximum record length.

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ ACSMode

◆ Comparison

◆ Connector

◆ CreateMode

◆ DataType

◆ DiskDrive

◆ DuplicateMode

◆ EncryptType

◆ FileVersion

◆ FreeSpaceThreshold

◆ Index

◆ LocationMode

◆ LockMode

◆ NullKeyMode

◆ OpenMode

◆ OwnerMode

◆ PageLockType

◆ PageSize

◆ RecordCompressionMode

◆ StatusCode

◆ SystemDataMode

◆ SystemField

◆ TransactionMode

◆ UnlockMode

◆ VariableLengthRecordsMode

◆ VersionType

Member Function Documentation

◆ ACSModeToString()

◆ DataTypeToString()

◆ DuplicateModeToString()

◆ EncryptTypeToString()

◆ FileVersionToString()

◆ FreeSpaceThresholdToString()

◆ IndexToString()

◆ LockModeToString()

◆ NullKeyModeToString()

◆ OwnerModeToString()

◆ PageLockTypeToString()

◆ PageSizeToString()

◆ RecordCompressionModeToString()

◆ StatusCodeToString()

◆ SystemDataModeToString()

◆ SystemFieldToString()

◆ TimestampToUnixEpochMicroseconds()

◆ UnixEpochMicrosecondsToTimestamp()

◆ VariableLengthRecordsModeToString()

◆ VersionTypeToString()

Member Data Documentation

◆ MAXIMUM_BULK_RECORD_COUNT

◆ MAXIMUM_KEY_LENGTH

◆ MAXIMUM_RECORD_LENGTH