btrieveC.h File Reference

Go to the source code of this file.

Macros
#define	BTRIEVE_MAXIMUM_BULK_RECORD_COUNT   25804
	The Btrieve maximum bulk record count.
#define	BTRIEVE_MAXIMUM_KEY_LENGTH   1024
	The Btrieve maximum key segment length.
#define	BTRIEVE_MAXIMUM_RECORD_LENGTH   (64 * 1024 - 1)
	The Btrieve maximum record length.

Typedefs
typedef struct btrieve_bulk_create_payload *	btrieve_bulk_create_payload_t
	A Btrieve bulk create payload.
typedef struct btrieve_bulk_create_result *	btrieve_bulk_create_result_t
	A Btrieve bulk create result.
typedef struct btrieve_bulk_delete_attributes *	btrieve_bulk_delete_attributes_t
	A Btrieve bulk delete attributes.
typedef struct btrieve_bulk_delete_result *	btrieve_bulk_delete_result_t
	A Btrieve bulk delete result.
typedef struct btrieve_bulk_retrieve_attributes *	btrieve_bulk_retrieve_attributes_t
	A Btrieve bulk retrieve attributes.
typedef struct btrieve_bulk_retrieve_result *	btrieve_bulk_retrieve_result_t
	A Btrieve bulk retrieve result.
typedef struct btrieve_client *	btrieve_client_t
	A Btrieve client.
typedef struct btrieve_file_attributes *	btrieve_file_attributes_t
	A Btrieve file attributes.
typedef struct btrieve_file_information *	btrieve_file_information_t
	A Btrieve file information.
typedef struct btrieve_file *	btrieve_file_t
	A Btrieve file.
typedef struct btrieve_filter *	btrieve_filter_t
	A Btrieve filter.
typedef struct btrieve_index_attributes *	btrieve_index_attributes_t
	A Btrieve index attributes.
typedef struct btrieve_key_segment *	btrieve_key_segment_t
	A Btrieve key segment.
typedef struct btrieve_version *	btrieve_version_t
	A Btrieve version.

Enumerations
enum	btrieve_acs_mode_t
	The Btrieve alternate collation sequence modes. More...
enum	btrieve_comparison_t
	The Btrieve comparisons. More...
enum	btrieve_connector_t
	The Btrieve connectors. More...
enum	btrieve_create_mode_t
	The Btrieve create modes. More...
enum	btrieve_data_type_t
	The Btrieve data types. More...
enum	btrieve_disk_drive_t
	The Btrieve disk drives. More...
enum	btrieve_duplicate_mode_t
	The Btrieve duplicate modes. More...
enum	btrieve_encrypt_type_t
	The Btrieve file encryption types. More...
enum	btrieve_file_version_t
	The Btrieve file versions. More...
enum	btrieve_free_space_threshold_t
	The Btrieve free space thresholds. More...
enum	btrieve_index_t
	The Btrieve indexes. More...
enum	btrieve_location_mode_t
	The Btrieve location modes. More...
enum	btrieve_lock_mode_t
	The Btrieve lock modes. More...
enum	btrieve_null_key_mode_t
	The Btrieve null key modes. More...
enum	btrieve_open_mode_t
	The Btrieve open modes. More...
enum	btrieve_owner_mode_t
	The Btrieve file owner modes. More...
enum	btrieve_page_lock_type_t
	The Btrieve page lock type. More...
enum	btrieve_page_size_t
	The Btrieve page sizes. More...
enum	btrieve_record_compression_mode_t
	The Btrieve record compression modes. More...
enum	btrieve_status_code_t
	The Btrieve status codes. More...
enum	btrieve_system_data_mode_t
	The Btrieve system data modes. More...
enum	btrieve_system_field_t
	The Btrieve system fields. More...
enum	btrieve_transaction_mode_t
	The Btrieve transaction modes. More...
enum	btrieve_unlock_mode_t
	The Btrieve unlock modes. More...
enum	btrieve_variable_length_records_mode_t
	The Btrieve variable length records modes. More...
enum	btrieve_version_type_t
	The Btrieve version types. More...

Functions
const char *	BtrieveACSModeToString (btrieve_acs_mode_t ACSMode)
	Return a Btrieve ACS mode as a string.
btrieve_status_code_t	BtrieveBulkCreatePayloadAddRecord (btrieve_bulk_create_payload_t bulkCreatePayload, const char *record, int recordLength)
	Add a record to a Btrieve bulk create payload.
btrieve_status_code_t	BtrieveBulkCreatePayloadAllocate (btrieve_bulk_create_payload_t *btrieveBulkCreatePayloadPtr)
	Allocate a Btrieve bulk create payload.
btrieve_status_code_t	BtrieveBulkCreatePayloadFree (btrieve_bulk_create_payload_t bulkCreatePayload)
	Free a Btrieve bulk create payload.
btrieve_status_code_t	BtrieveBulkCreateResultAllocate (btrieve_bulk_create_result_t *btrieveBulkCreateResultPtr)
	Allocate a Btrieve bulk create result.
btrieve_status_code_t	BtrieveBulkCreateResultFree (btrieve_bulk_create_result_t bulkCreateResult)
	Free a Btrieve bulk create result.
btrieve_status_code_t	BtrieveBulkCreateResultGetLastStatusCode (btrieve_bulk_create_result_t bulkCreateResult)
	Get last status code from a Btrieve bulk create result
int	BtrieveBulkCreateResultGetRecordCount (btrieve_bulk_create_result_t bulkCreateResult)
	Get record count from a Btrieve bulk create result
long long	BtrieveBulkCreateResultGetRecordCursorPosition (btrieve_bulk_create_result_t bulkCreateResult, int recordNumber)
	Get record cursor position from a Btrieve bulk create result
btrieve_status_code_t	BtrieveBulkDeleteAttributesAddFilter (btrieve_bulk_delete_attributes_t bulkDeleteAttributes, btrieve_filter_t filter)
	Add a filter to a Btrieve bulk delete attributes.
btrieve_status_code_t	BtrieveBulkDeleteAttributesAllocate (btrieve_bulk_delete_attributes_t *bulkDeleteAttributesPtr)
	Allocate a Btrieve bulk delete attributes.
btrieve_status_code_t	BtrieveBulkDeleteAttributesFree (btrieve_bulk_delete_attributes_t bulkDeleteAttributes)
	Free a Btrieve bulk delete attributes.
btrieve_status_code_t	BtrieveBulkDeleteAttributesSetMaximumRecordCount (btrieve_bulk_delete_attributes_t bulkDeleteAttributes, int maximumRecordCount)
	Set maximum record count for a Btrieve bulk delete attributes.
btrieve_status_code_t	BtrieveBulkDeleteAttributesSetMaximumRejectCount (btrieve_bulk_delete_attributes_t bulkDeleteAttributes, int maximumRejectCount)
	Set maximum reject count for a Btrieve bulk delete attributes.
btrieve_status_code_t	BtrieveBulkDeleteAttributesSetSkipCurrentRecord (btrieve_bulk_delete_attributes_t bulkDeleteAttributes, int skipCurrentRecord)
	Set skip current record for a Btrieve bulk delete attributes.
btrieve_status_code_t	BtrieveBulkDeleteResultAllocate (btrieve_bulk_delete_result_t *bulkDeleteResultPtr)
	Allocate a Btrieve bulk delete result.
btrieve_status_code_t	BtrieveBulkDeleteResultFree (btrieve_bulk_delete_result_t bulkDeleteResult)
	Free a Btrieve bulk delete result.
btrieve_status_code_t	BtrieveBulkDeleteResultGetLastStatusCode (btrieve_bulk_delete_result_t bulkDeleteResult)
	Get last status code from a Btrieve bulk delete result
int	BtrieveBulkDeleteResultGetRecordCount (btrieve_bulk_delete_result_t bulkDeleteResult)
	Get record count from a Btrieve bulk delete result
long long	BtrieveBulkDeleteResultGetRecordCursorPosition (btrieve_bulk_delete_result_t bulkDeleteResult, int recordNumber)
	Get record cursor position from a Btrieve bulk delete result
btrieve_status_code_t	BtrieveBulkRetrieveAttributesAddField (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int offset, int length)
	Add a field to a Btrieve bulk retrieve attributes.
btrieve_status_code_t	BtrieveBulkRetrieveAttributesAddFilter (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, btrieve_filter_t filter)
	Add a filter to a Btrieve bulk retrieve attributes.
btrieve_status_code_t	BtrieveBulkRetrieveAttributesAddSystemField (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, btrieve_system_field_t systemField)
	Add a system field to a Btrieve bulk retrieve attributes.
btrieve_status_code_t	BtrieveBulkRetrieveAttributesAllocate (btrieve_bulk_retrieve_attributes_t *bulkRetrieveAttributesPtr)
	Allocate a Btrieve bulk retrieve attributes.
btrieve_status_code_t	BtrieveBulkRetrieveAttributesFree (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes)
	Free a Btrieve bulk retrieve attributes.
btrieve_status_code_t	BtrieveBulkRetrieveAttributesSetMaximumRecordCount (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int maximumRecordCount)
	Set maximum record count for a Btrieve bulk retrieve attributes.
btrieve_status_code_t	BtrieveBulkRetrieveAttributesSetMaximumRejectCount (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int maximumRejectCount)
	Set maximum reject count for a Btrieve bulk retrieve attributes.
btrieve_status_code_t	BtrieveBulkRetrieveAttributesSetSkipCurrentRecord (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int skipCurrentRecord)
	Set skip current record for a Btrieve bulk retrieve attributes.
btrieve_status_code_t	BtrieveBulkRetrieveResultAllocate (btrieve_bulk_retrieve_result_t *bulkRetrieveResultPtr)
	Allocate a Btrieve bulk retrieve result.
btrieve_status_code_t	BtrieveBulkRetrieveResultFree (btrieve_bulk_retrieve_result_t bulkRetrieveResult)
	Free a Btrieve bulk retrieve result.
btrieve_status_code_t	BtrieveBulkRetrieveResultGetLastStatusCode (btrieve_bulk_retrieve_result_t bulkRetrieveResult)
	Get last status code from a Btrieve bulk retrieve result
int	BtrieveBulkRetrieveResultGetRecord (btrieve_bulk_retrieve_result_t bulkRetrieveResult, int recordNumber, char *record, int recordSize)
	Get record from a Btrieve bulk retrieve result
int	BtrieveBulkRetrieveResultGetRecordCount (btrieve_bulk_retrieve_result_t bulkRetrieveResult)
	Get record count from a Btrieve bulk retrieve result
long long	BtrieveBulkRetrieveResultGetRecordCursorPosition (btrieve_bulk_retrieve_result_t bulkRetrieveResult, int recordNumber)
	Get record cursor position from a Btrieve bulk retrieve result
int	BtrieveBulkRetrieveResultGetRecordLength (btrieve_bulk_retrieve_result_t bulkRetrieveResult, int recordNumber)
	Get record length from a Btrieve bulk retrieve result
btrieve_status_code_t	BtrieveClientAllocate (btrieve_client_t *btrieveClientPtr, int serviceAgentIdentifier, int clientIdentifier)
	Allocate a Btrieve client.
btrieve_status_code_t	BtrieveClientContinuousOperationBegin (btrieve_client_t client, const char *pathNames)
	Continuous operation begin for a Btrieve client.
btrieve_status_code_t	BtrieveClientContinuousOperationBeginW (btrieve_client_t client, const wchar_t *pathNames)
	Continuous operation begin for a Btrieve client.
btrieve_status_code_t	BtrieveClientContinuousOperationEnd (btrieve_client_t client, const char *pathNames)
	Continuous operation end for a Btrieve client.
btrieve_status_code_t	BtrieveClientContinuousOperationEndW (btrieve_client_t client, const wchar_t *pathNames)
	Continuous operation end for a Btrieve client.
btrieve_status_code_t	BtrieveClientFileClose (btrieve_client_t client, btrieve_file_t file)
	File close for a Btrieve client.
btrieve_status_code_t	BtrieveClientFileCreate (btrieve_client_t client, const btrieve_file_attributes_t fileAttributes, const btrieve_index_attributes_t indexAttributes, const char *fileName, btrieve_create_mode_t createMode, btrieve_location_mode_t locationMode)
	File create for a Btrieve client.
btrieve_status_code_t	BtrieveClientFileCreateW (btrieve_client_t client, const btrieve_file_attributes_t fileAttributes, const btrieve_index_attributes_t indexAttributes, const wchar_t *fileName, btrieve_create_mode_t createMode, btrieve_location_mode_t locationMode)
	File create for a Btrieve client.
btrieve_status_code_t	BtrieveClientFileDelete (btrieve_client_t client, const char *fileName)
	File delete for a Btrieve client.
btrieve_status_code_t	BtrieveClientFileDeleteW (btrieve_client_t client, const wchar_t *fileName)
	File delete for a Btrieve client.
btrieve_status_code_t	BtrieveClientFileOpen (btrieve_client_t client, btrieve_file_t *btrieveFilePtr, const char *fileName, const char *ownerName, btrieve_open_mode_t openMode, btrieve_location_mode_t locationMode)
	File open for a Btrieve client.
btrieve_status_code_t	BtrieveClientFileOpenW (btrieve_client_t client, btrieve_file_t *btrieveFilePtr, const wchar_t *fileName, const char *ownerName, btrieve_open_mode_t openMode, btrieve_location_mode_t locationMode)
	File open for a Btrieve client.
btrieve_status_code_t	BtrieveClientFileRename (btrieve_client_t client, const char *existingFileName, const char *newFileName)
	File rename for a Btrieve client.
btrieve_status_code_t	BtrieveClientFileRenameW (btrieve_client_t client, const wchar_t *existingFileName, const wchar_t *newFileName)
	File rename for a Btrieve client.
btrieve_status_code_t	BtrieveClientFree (btrieve_client_t client)
	Free a Btrieve client.
int	BtrieveClientGetClientIdentifier (btrieve_client_t client)
	Get client identifier from a Btrieve client
btrieve_status_code_t	BtrieveClientGetCurrentDirectory (btrieve_client_t client, btrieve_disk_drive_t diskDrive, char *currentDirectory, int currentDirectorySize)
	Get current directory from a Btrieve client
btrieve_status_code_t	BtrieveClientGetCurrentDirectoryW (btrieve_client_t client, btrieve_disk_drive_t diskDrive, wchar_t *currentDirectory, int currentDirectorySize)
	Get current directory from a Btrieve client
btrieve_status_code_t	BtrieveClientGetLastStatusCode (btrieve_client_t client)
	Get last status code from a Btrieve client
int	BtrieveClientGetServiceAgentIdentifier (btrieve_client_t client)
	Get service agent identifier from a Btrieve client
btrieve_status_code_t	BtrieveClientGetVersion (btrieve_client_t client, btrieve_version_t version, btrieve_file_t file)
	Get version from a Btrieve client
btrieve_status_code_t	BtrieveClientLogin (btrieve_client_t client, const char *databaseURI)
	Login for a Btrieve client.
btrieve_status_code_t	BtrieveClientLoginW (btrieve_client_t client, const wchar_t *databaseURI)
	Login for a Btrieve client.
btrieve_status_code_t	BtrieveClientLogout (btrieve_client_t client, const char *databaseURI)
	Logout for a Btrieve client.
btrieve_status_code_t	BtrieveClientLogoutW (btrieve_client_t client, const wchar_t *databaseURI)
	Logout for a Btrieve client.
btrieve_status_code_t	BtrieveClientReset (btrieve_client_t client)
	Reset for a Btrieve client.
btrieve_status_code_t	BtrieveClientSetCurrentDirectory (btrieve_client_t client, const char *currentDirectory)
	Set current directory for a Btrieve client.
btrieve_status_code_t	BtrieveClientSetCurrentDirectoryW (btrieve_client_t client, const wchar_t *currentDirectory)
	Set current directory for a Btrieve client.
btrieve_status_code_t	BtrieveClientStop (btrieve_client_t client)
	Stop for a Btrieve client.
btrieve_status_code_t	BtrieveClientTransactionAbort (btrieve_client_t client)
	Transaction abort for a Btrieve client.
btrieve_status_code_t	BtrieveClientTransactionBegin (btrieve_client_t client, btrieve_transaction_mode_t transactionMode, btrieve_lock_mode_t lockMode)
	Transaction begin for a Btrieve client.
btrieve_status_code_t	BtrieveClientTransactionEnd (btrieve_client_t client)
	Transaction end for a Btrieve client.
const char *	BtrieveDataTypeToString (btrieve_data_type_t dataType)
	Return a Btrieve data type as a string.
const char *	BtrieveDuplicateModeToString (btrieve_duplicate_mode_t duplicateMode)
	Return a Btrieve duplicate mode as a string.
const char *	BtrieveEncryptionTypeToString (btrieve_encrypt_type_t encryptType)
	Return a Btrieve encryption type as a string.
btrieve_status_code_t	BtrieveFileAttributesAllocate (btrieve_file_attributes_t *btrieveFileAttributesPtr)
	Allocate a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesFree (btrieve_file_attributes_t fileAttributes)
	Free a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesSetBalancedIndexes (btrieve_file_attributes_t fileAttributes, int enableBalancedIndexes)
	Set balanced indexes for a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesSetFileVersion (btrieve_file_attributes_t fileAttributes, btrieve_file_version_t fileVersion)
	Set file version for a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesSetFixedRecordLength (btrieve_file_attributes_t fileAttributes, int fixedRecordLength)
	Set fixed record length for a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesSetFreeSpaceThreshold (btrieve_file_attributes_t fileAttributes, btrieve_free_space_threshold_t freeSpaceThreshold)
	Set free space threshold for a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesSetKeyOnly (btrieve_file_attributes_t fileAttributes, int enableKeyOnly)
	Set key only for a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesSetPageSize (btrieve_file_attributes_t fileAttributes, btrieve_page_size_t pageSize, int enablePageCompression)
	Set page size for a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesSetPreallocatedPageCount (btrieve_file_attributes_t fileAttributes, int preallocatedPageCount)
	Set preallocated page count for a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesSetRecordCompressionMode (btrieve_file_attributes_t fileAttributes, btrieve_record_compression_mode_t recordCompressionMode)
	Set record compression mode for a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesSetReservedDuplicatePointerCount (btrieve_file_attributes_t fileAttributes, int reservedDuplicatePointerCount)
	Set reserved duplicate pointer count for a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesSetSystemDataMode (btrieve_file_attributes_t fileAttributes, btrieve_system_data_mode_t systemDataMode)
	Set system data mode for a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileAttributesSetVariableLengthRecordsMode (btrieve_file_attributes_t fileAttributes, btrieve_variable_length_records_mode_t variableLengthRecordsMode)
	Set variable length records mode for a Btrieve file attributes.
btrieve_status_code_t	BtrieveFileBulkCreate (btrieve_file_t file, const btrieve_bulk_create_payload_t bulkCreatePayload, btrieve_bulk_create_result_t bulkCreateResult)
	Bulk create for a Btrieve file.
btrieve_status_code_t	BtrieveFileBulkDeleteNext (btrieve_file_t file, const btrieve_bulk_delete_attributes_t bulkDeleteAttributes, btrieve_bulk_delete_result_t bulkDeleteResult)
	Bulk delete next for a Btrieve file.
btrieve_status_code_t	BtrieveFileBulkDeletePrevious (btrieve_file_t file, const btrieve_bulk_delete_attributes_t bulkDeleteAttributes, btrieve_bulk_delete_result_t bulkDeleteResult)
	Bulk delete previous for a Btrieve file.
btrieve_status_code_t	BtrieveFileBulkRetrieveNext (btrieve_file_t file, const btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, btrieve_bulk_retrieve_result_t bulkRetrieveResult, btrieve_lock_mode_t lockMode)
	Bulk retrieve next for a Btrieve file.
btrieve_status_code_t	BtrieveFileBulkRetrievePrevious (btrieve_file_t file, const btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, btrieve_bulk_retrieve_result_t bulkRetrieveResult, btrieve_lock_mode_t lockMode)
	Bulk retrieve previous for a Btrieve file.
long long	BtrieveFileGetCursorPosition (btrieve_file_t file)
	Get cursor position from a Btrieve file
btrieve_status_code_t	BtrieveFileGetInformation (btrieve_file_t file, btrieve_file_information_t fileInformation)
	Get information from a Btrieve file
btrieve_status_code_t	BtrieveFileGetLastStatusCode (btrieve_file_t file)
	Get last status code from a Btrieve file
int	BtrieveFileGetNumerator (btrieve_file_t file, btrieve_index_t index, const char *key, int keyLength, long long cursorPosition, int denominator)
	Get numerator from a Btrieve file
int	BtrieveFileGetPercentage (btrieve_file_t file, btrieve_index_t index, const char *key, int keyLength, long long cursorPosition)
	Get percentage from a Btrieve file
long long	BtrieveFileGetRecordCreateTime (btrieve_file_t file)
	Get record create time from a Btrieve file.
long long	BtrieveFileGetRecordUpdateTime (btrieve_file_t file)
	Get record update time from a Btrieve file.
btrieve_status_code_t	BtrieveFileIndexCreate (btrieve_file_t file, const btrieve_index_attributes_t indexAttributes)
	Index create for a Btrieve file.
btrieve_status_code_t	BtrieveFileIndexDrop (btrieve_file_t file, btrieve_index_t index)
	Index drop for a Btrieve file.
btrieve_status_code_t	BtrieveFileInformationAllocate (btrieve_file_information_t *btrieveFileInformationPtr)
	Allocate a Btrieve file information.
btrieve_status_code_t	BtrieveFileInformationFree (btrieve_file_information_t fileInformation)
	Free a Btrieve file information.
int	BtrieveFileInformationGetBalancedIndexes (btrieve_file_information_t fileInformation)
	Get balanced indexes from a Btrieve file information
int	BtrieveFileInformationGetClientTransactions (btrieve_file_information_t fileInformation)
	Get client transactions from a Btrieve file information.
int	BtrieveFileInformationGetContinuousOperation (btrieve_file_information_t fileInformation)
	Get continuous operation from a Btrieve file information.
long long	BtrieveFileInformationGetDuplicateRecordConflictCursorPosition (btrieve_file_information_t fileInformation)
	Get duplicate record conflict cursor position from a Btrieve file information.
btrieve_index_t	BtrieveFileInformationGetDuplicateRecordConflictIndex (btrieve_file_information_t fileInformation)
	Get duplicate record conflict index from a Btrieve file information.
btrieve_encrypt_type_t	BtrieveFileInformationGetEncryptionType (btrieve_file_information_t fileInformation)
	Get encryption type from a Btrieve file information.
int	BtrieveFileInformationGetExplicitLocks (btrieve_file_information_t fileInformation)
	Get explicit locks from a Btrieve file information.
btrieve_file_version_t	BtrieveFileInformationGetFileVersion (btrieve_file_information_t fileInformation)
	Get file version from a Btrieve file information.
int	BtrieveFileInformationGetFixedRecordLength (btrieve_file_information_t fileInformation)
	Get fixed record length from a Btrieve file information.
btrieve_free_space_threshold_t	BtrieveFileInformationGetFreeSpaceThreshold (btrieve_file_information_t fileInformation)
	Get free space threshold from a Btrieve file information.
int	BtrieveFileInformationGetGatewayMajorVersion (btrieve_file_information_t fileInformation)
	Get gateway major version from a Btrieve file information.
int	BtrieveFileInformationGetGatewayMinorVersion (btrieve_file_information_t fileInformation)
	Get gateway minor version from a Btrieve file information.
btrieve_status_code_t	BtrieveFileInformationGetGatewayName (btrieve_file_information_t fileInformation, char *name, int nameSize)
	Get gateway name from a Btrieve file information
int	BtrieveFileInformationGetGatewayPatchLevel (btrieve_file_information_t fileInformation)
	Get gateway patch level from a Btrieve file information.
int	BtrieveFileInformationGetGatewayPlatform (btrieve_file_information_t fileInformation)
	Get gateway platform from a Btrieve file information.
int	BtrieveFileInformationGetHandleCount (btrieve_file_information_t fileInformation)
	Get handle count from a Btrieve file information.
int	BtrieveFileInformationGetIdentifier (btrieve_file_information_t fileInformation)
	Get identifier from a Btrieve file information.
int	BtrieveFileInformationGetIndexCount (btrieve_file_information_t fileInformation)
	Get index count from a Btrieve file information.
int	BtrieveFileInformationGetKeyOnly (btrieve_file_information_t fileInformation)
	Get key only from a Btrieve file information.
btrieve_status_code_t	BtrieveFileInformationGetKeySegment (btrieve_file_information_t fileInformation, btrieve_key_segment_t keySegment, int keySegmentNumber)
	Get key segment from a Btrieve file information
btrieve_status_code_t	BtrieveFileInformationGetLastStatusCode (btrieve_file_information_t fileInformation)
	Get last status code from a Btrieve file information
int	BtrieveFileInformationGetLockOwnerClientIdentifier (btrieve_file_information_t fileInformation)
	Get lock owner client identifier from a Btrieve file information.
btrieve_lock_mode_t	BtrieveFileInformationGetLockOwnerExplicitLockMode (btrieve_file_information_t fileInformation)
	Get lock owner explicit lock mode from a Btrieve file information.
int	BtrieveFileInformationGetLockOwnerFileLock (btrieve_file_information_t fileInformation)
	Get lock owner file lock from a Btrieve file information.
int	BtrieveFileInformationGetLockOwnerImplicitLock (btrieve_file_information_t fileInformation)
	Get lock owner implicit lock from a Btrieve file information.
btrieve_index_t	BtrieveFileInformationGetLockOwnerIndex (btrieve_file_information_t fileInformation)
	Get lock owner index from a Btrieve file information.
btrieve_status_code_t	BtrieveFileInformationGetLockOwnerName (btrieve_file_information_t fileInformation, char *name, int nameSize)
	Get lock owner name from a Btrieve file information
btrieve_page_lock_type_t	BtrieveFileInformationGetLockOwnerPageLockType (btrieve_file_information_t fileInformation)
	Get lock owner page lock type from a Btrieve file information.
int	BtrieveFileInformationGetLockOwnerRecordLock (btrieve_file_information_t fileInformation)
	Get lock owner record lock from a Btrieve file information.
int	BtrieveFileInformationGetLockOwnerSameProcess (btrieve_file_information_t fileInformation)
	Get lock owner same process from a Btrieve file information.
int	BtrieveFileInformationGetLockOwnerServiceAgentIdentifier (btrieve_file_information_t fileInformation)
	Get lock owner service agent identifier from a Btrieve file information.
int	BtrieveFileInformationGetLockOwnerTimeInTransaction (btrieve_file_information_t fileInformation)
	Get lock owner time in transaction from a Btrieve file information.
int	BtrieveFileInformationGetLockOwnerTransactionLevel (btrieve_file_information_t fileInformation)
	Get lock owner transaction level from a Btrieve file information.
int	BtrieveFileInformationGetLockOwnerWriteHold (btrieve_file_information_t fileInformation)
	Get lock owner write hold from a Btrieve file information.
int	BtrieveFileInformationGetLockOwnerWriteNoWait (btrieve_file_information_t fileInformation)
	Get lock owner write no wait from a Btrieve file information.
int	BtrieveFileInformationGetLoggable (btrieve_file_information_t fileInformation)
	Get loggable from a Btrieve file information.
btrieve_index_t	BtrieveFileInformationGetLogIndex (btrieve_file_information_t fileInformation)
	Get log index from a Btrieve file information.
int	BtrieveFileInformationGetOpenTimestamp (btrieve_file_information_t fileInformation)
	Get open timestamp from a Btrieve file information.
btrieve_owner_mode_t	BtrieveFileInformationGetOwnerMode (btrieve_file_information_t fileInformation)
	Get owner mode from a Btrieve file information.
int	BtrieveFileInformationGetPageCompression (btrieve_file_information_t fileInformation)
	Get page compression from a Btrieve file information.
int	BtrieveFileInformationGetPagePreallocation (btrieve_file_information_t fileInformation)
	Get page preallocation from a Btrieve file information.
btrieve_page_size_t	BtrieveFileInformationGetPageSize (btrieve_file_information_t fileInformation)
	Get page size from a Btrieve file information.
int	BtrieveFileInformationGetReadOnly (btrieve_file_information_t fileInformation)
	Get read only from a Btrieve file information.
btrieve_record_compression_mode_t	BtrieveFileInformationGetRecordCompressionMode (btrieve_file_information_t fileInformation)
	Get record compression mode from a Btrieve file information.
long long	BtrieveFileInformationGetRecordCount (btrieve_file_information_t fileInformation)
	Get record count from a Btrieve file information.
int	BtrieveFileInformationGetReferentialIntegrityConstraints (btrieve_file_information_t fileInformation)
	Get referential integrity constraints from a Btrieve file information.
long long	BtrieveFileInformationGetReferentialIntegrityCursorPosition (btrieve_file_information_t fileInformation)
	Get referential integrity cursor position from a Btrieve file information.
btrieve_status_code_t	BtrieveFileInformationGetReferentialIntegrityFileName (btrieve_file_information_t fileInformation, char *name, int nameSize)
	Get referential integrity file name from a Btrieve file information
int	BtrieveFileInformationGetReferentialIntegrityOperationCode (btrieve_file_information_t fileInformation)
	Get referential integrity operation code from a Btrieve file information.
int	BtrieveFileInformationGetSecurityCurrentDatabaseAuthenticationByDatabase (btrieve_file_information_t fileInformation)
	Get security current database authentication by database from a Btrieve file information.
int	BtrieveFileInformationGetSecurityCurrentDatabaseAuthorizationByDatabase (btrieve_file_information_t fileInformation)
	Get security current database authorization by database from a Btrieve file information.
int	BtrieveFileInformationGetSecurityCurrentDatabaseBtpasswd (btrieve_file_information_t fileInformation)
	Get security current database btpasswd from a Btrieve file information.
int	BtrieveFileInformationGetSecurityCurrentDatabaseExplicit (btrieve_file_information_t fileInformation)
	Get security current database explicit from a Btrieve file information.
int	BtrieveFileInformationGetSecurityCurrentDatabaseImplicit (btrieve_file_information_t fileInformation)
	Get security current database implicit from a Btrieve file information.
btrieve_status_code_t	BtrieveFileInformationGetSecurityCurrentDatabaseName (btrieve_file_information_t fileInformation, char *name, int nameSize)
	Get security current database name from a Btrieve file information
int	BtrieveFileInformationGetSecurityCurrentDatabasePAM (btrieve_file_information_t fileInformation)
	Get security current database PAM from a Btrieve file information.
int	BtrieveFileInformationGetSecurityCurrentDatabaseRTSSComplete (btrieve_file_information_t fileInformation)
	Get security current database RTSS complete from a Btrieve file information.
int	BtrieveFileInformationGetSecurityCurrentDatabaseRTSSDisabled (btrieve_file_information_t fileInformation)
	Get security current database RTSS disabled from a Btrieve file information.
int	BtrieveFileInformationGetSecurityCurrentDatabaseRTSSPreauthorized (btrieve_file_information_t fileInformation)
	Get security current database RTSS preauthorized from a Btrieve file information.
int	BtrieveFileInformationGetSecurityCurrentDatabaseTrusted (btrieve_file_information_t fileInformation)
	Get security current database trusted from a Btrieve file information.
int	BtrieveFileInformationGetSecurityCurrentDatabaseWindowsNamedPipe (btrieve_file_information_t fileInformation)
	Get security current database windows named pipe from a Btrieve file information.
int	BtrieveFileInformationGetSecurityCurrentDatabaseWorkgroup (btrieve_file_information_t fileInformation)
	Get security current database workgroup from a Btrieve file information.
btrieve_status_code_t	BtrieveFileInformationGetSecurityCurrentUserName (btrieve_file_information_t fileInformation, char *name, int nameSize)
	Get security current user name from a Btrieve file information
int	BtrieveFileInformationGetSecurityHandleAuthenticationByDatabase (btrieve_file_information_t fileInformation)
	Get security handle authentication by database from a Btrieve file information.
int	BtrieveFileInformationGetSecurityHandleAuthorizationByDatabase (btrieve_file_information_t fileInformation)
	Get security handle authorization by database from a Btrieve file information.
int	BtrieveFileInformationGetSecurityHandleBtpasswd (btrieve_file_information_t fileInformation)
	Get security handle btpasswd from a Btrieve file information.
btrieve_status_code_t	BtrieveFileInformationGetSecurityHandleDatabaseName (btrieve_file_information_t fileInformation, char *name, int nameSize)
	Get security handle database name from a Btrieve file information
int	BtrieveFileInformationGetSecurityHandleExplicit (btrieve_file_information_t fileInformation)
	Get security handle explicit from a Btrieve file information.
int	BtrieveFileInformationGetSecurityHandleImplicit (btrieve_file_information_t fileInformation)
	Get security handle implicit from a Btrieve file information.
int	BtrieveFileInformationGetSecurityHandlePAM (btrieve_file_information_t fileInformation)
	Get security handle PAM from a Btrieve file information.
int	BtrieveFileInformationGetSecurityHandleRTSSComplete (btrieve_file_information_t fileInformation)
	Get security handle RTSS complete from a Btrieve file information.
int	BtrieveFileInformationGetSecurityHandleRTSSDisabled (btrieve_file_information_t fileInformation)
	Get security handle RTSS disabled from a Btrieve file information.
int	BtrieveFileInformationGetSecurityHandleRTSSPreauthorized (btrieve_file_information_t fileInformation)
	Get security handle RTSS preauthorized from a Btrieve file information.
btrieve_status_code_t	BtrieveFileInformationGetSecurityHandleTableName (btrieve_file_information_t fileInformation, char *name, int nameSize)
	Get security handle table name from a Btrieve file information
int	BtrieveFileInformationGetSecurityHandleTrusted (btrieve_file_information_t fileInformation)
	Get security handle trusted from a Btrieve file information.
btrieve_status_code_t	BtrieveFileInformationGetSecurityHandleUserName (btrieve_file_information_t fileInformation, char *name, int nameSize)
	Get security handle user name from a Btrieve file information
int	BtrieveFileInformationGetSecurityHandleWindowsNamedPipe (btrieve_file_information_t fileInformation)
	Get security handle windows named pipe from a Btrieve file information.
int	BtrieveFileInformationGetSecurityHandleWorkgroup (btrieve_file_information_t fileInformation)
	Get security handle workgroup from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionAlter (btrieve_file_information_t fileInformation)
	Get security permission alter from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionCreateFile (btrieve_file_information_t fileInformation)
	Get security permission create file from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionCreateRecord (btrieve_file_information_t fileInformation)
	Get security permission create record from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionCreateStoredProcedure (btrieve_file_information_t fileInformation)
	Get security permission create stored procedure from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionCreateView (btrieve_file_information_t fileInformation)
	Get security permission create view from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionDelete (btrieve_file_information_t fileInformation)
	Get security permission delete from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionExecute (btrieve_file_information_t fileInformation)
	Get security permission execute from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionNoRights (btrieve_file_information_t fileInformation)
	Get security permission no rights from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionOpen (btrieve_file_information_t fileInformation)
	Get security permission open from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionRead (btrieve_file_information_t fileInformation)
	Get security permission read from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionRefer (btrieve_file_information_t fileInformation)
	Get security permission refer from a Btrieve file information.
int	BtrieveFileInformationGetSecurityPermissionUpdate (btrieve_file_information_t fileInformation)
	Get security permission update from a Btrieve file information.
int	BtrieveFileInformationGetSegmentCount (btrieve_file_information_t fileInformation)
	Get segment count from a Btrieve file information.
int	BtrieveFileInformationGetSegmented (btrieve_file_information_t fileInformation)
	Get segmented from a Btrieve file information.
btrieve_status_code_t	BtrieveFileInformationGetSegmentFileName (btrieve_file_information_t fileInformation, int segmentFileNumber, char *name, int nameSize)
	Get segment file name from a Btrieve file information
int	BtrieveFileInformationGetSystemData (btrieve_file_information_t fileInformation)
	Get system data from a Btrieve file information.
btrieve_system_data_mode_t	BtrieveFileInformationGetSystemDataMode (btrieve_file_information_t fileInformation)
	Get system data mode from a Btrieve file information
int	BtrieveFileInformationGetSystemIndex (btrieve_file_information_t fileInformation)
	Get system index from a Btrieve file information.
int	BtrieveFileInformationGetSystemIndexSize (btrieve_file_information_t fileInformation)
	Get system index size from a Btrieve file information.
int	BtrieveFileInformationGetSystemIndexVersion (btrieve_file_information_t fileInformation)
	Get system index version from a Btrieve file information.
int	BtrieveFileInformationGetUnusedDuplicatePointerCount (btrieve_file_information_t fileInformation)
	Get unused duplicate pointer count from a Btrieve file information.
int	BtrieveFileInformationGetUnusedPageCount (btrieve_file_information_t fileInformation)
	Get unused page count from a Btrieve file information.
int	BtrieveFileInformationGetUsageCount (btrieve_file_information_t fileInformation)
	Get usage count from a Btrieve file information.
btrieve_variable_length_records_mode_t	BtrieveFileInformationGetVariableLengthRecordsMode (btrieve_file_information_t fileInformation)
	Get variable length records mode from a Btrieve file information
int	BtrieveFileInformationGetWrongOwner (btrieve_file_information_t fileInformation)
	Get wrong owner from a Btrieve file information.
btrieve_status_code_t	BtrieveFileKeyRetrieve (btrieve_file_t file, btrieve_comparison_t comparison, btrieve_index_t index, char *key, int keyLength)
	Key retrieve for a Btrieve file.
btrieve_status_code_t	BtrieveFileKeyRetrieveFirst (btrieve_file_t file, btrieve_index_t index, char *key, int keySize)
	Key retrieve first for a Btrieve file.
btrieve_status_code_t	BtrieveFileKeyRetrieveLast (btrieve_file_t file, btrieve_index_t index, char *key, int keySize)
	Key retrieve last for a Btrieve file.
btrieve_status_code_t	BtrieveFileKeyRetrieveNext (btrieve_file_t file, char *key, int keySize)
	Key retrieve next for a Btrieve file.
btrieve_status_code_t	BtrieveFileKeyRetrievePrevious (btrieve_file_t file, char *key, int keySize)
	Key retrieve previous for a Btrieve file.
btrieve_status_code_t	BtrieveFileRecordAppendChunk (btrieve_file_t file, const char *chunk, int chunkLength)
	Record append chunk for a Btrieve file.
btrieve_status_code_t	BtrieveFileRecordCreate (btrieve_file_t file, char *record, int recordLength)
	Record create for a Btrieve file.
btrieve_status_code_t	BtrieveFileRecordDelete (btrieve_file_t file)
	Record delete for a Btrieve file.
btrieve_status_code_t	BtrieveFileRecordDeleteChunk (btrieve_file_t file, int offset, int chunkLength)
	Record delete chunk for a Btrieve file.
btrieve_status_code_t	BtrieveFileRecordInsertChunk (btrieve_file_t file, int offset, const char *chunk, int chunkLength)
	Record insert chunk for a Btrieve file.
int	BtrieveFileRecordRetrieve (btrieve_file_t file, btrieve_comparison_t comparison, btrieve_index_t index, char *key, int keyLength, char *record, int recordSize, btrieve_lock_mode_t lockMode)
	Record retrieve for a Btrieve file.
int	BtrieveFileRecordRetrieveByCursorPosition (btrieve_file_t file, btrieve_index_t index, long long cursorPosition, char *key, int keySize, char *record, int recordSize, btrieve_lock_mode_t lockMode)
	Record retrieve by cursor position for a Btrieve file.
int	BtrieveFileRecordRetrieveByFraction (btrieve_file_t file, btrieve_index_t index, int numerator, int denominator, char *key, int keySize, char *record, int recordSize, btrieve_lock_mode_t lockMode)
	Record retrieve by fraction for a Btrieve file.
int	BtrieveFileRecordRetrieveByPercentage (btrieve_file_t file, btrieve_index_t index, int percentage, char *key, int keySize, char *record, int recordSize, btrieve_lock_mode_t lockMode)
	Record retrieve by percentage for a Btrieve file.
int	BtrieveFileRecordRetrieveChunk (btrieve_file_t file, int offset, int length, char *chunk, int chunkSize, btrieve_lock_mode_t lockMode)
	Record retrieve chunk for a Btrieve file.
int	BtrieveFileRecordRetrieveFirst (btrieve_file_t file, btrieve_index_t index, char *key, int keySize, char *record, int recordSize, btrieve_lock_mode_t lockMode)
	Record retrieve first for a Btrieve file.
int	BtrieveFileRecordRetrieveLast (btrieve_file_t file, btrieve_index_t index, char *key, int keySize, char *record, int recordSize, btrieve_lock_mode_t lockMode)
	Record retrieve last for a Btrieve file.
int	BtrieveFileRecordRetrieveNext (btrieve_file_t file, char *key, int keySize, char *record, int recordSize, btrieve_lock_mode_t lockMode)
	Record retrieve next for a Btrieve file.
int	BtrieveFileRecordRetrievePrevious (btrieve_file_t file, char *key, int keySize, char *record, int recordSize, btrieve_lock_mode_t lockMode)
	Record retrieve previous for a Btrieve file.
btrieve_status_code_t	BtrieveFileRecordTruncate (btrieve_file_t file, int offset)
	Record truncate for a Btrieve file.
btrieve_status_code_t	BtrieveFileRecordUnlock (btrieve_file_t file, btrieve_unlock_mode_t unlockMode)
	Record unlock for a Btrieve file.
btrieve_status_code_t	BtrieveFileRecordUpdate (btrieve_file_t file, const char *record, int recordLength)
	Record update for a Btrieve file.
btrieve_status_code_t	BtrieveFileRecordUpdateChunk (btrieve_file_t file, int offset, const char *chunk, int chunkLength)
	Record update chunk for a Btrieve file.
btrieve_status_code_t	BtrieveFileSetOwner (btrieve_file_t file, btrieve_owner_mode_t ownerMode, const char *ownerName, const char *ownerNameAgain, int useLongOwnerName)
	Set owner for a Btrieve file.
btrieve_status_code_t	BtrieveFileUnlockCursorPosition (btrieve_file_t file, long long cursorPosition)
	Unlock cursor position for a Btrieve file.
const char *	BtrieveFileVersionToString (btrieve_file_version_t fileVersion)
	Return a Btrieve file version as a string.
btrieve_status_code_t	BtrieveFilterAllocate (btrieve_filter_t *btrieveFilterPtr)
	Allocate a Btrieve filter.
btrieve_status_code_t	BtrieveFilterFree (btrieve_filter_t filter)
	Free a Btrieve filter.
btrieve_status_code_t	BtrieveFilterSetACSMode (btrieve_filter_t filter, btrieve_acs_mode_t ACSMode)
	Set ACS mode for a Btrieve filter.
btrieve_status_code_t	BtrieveFilterSetACSName (btrieve_filter_t filter, const char *name)
	Set ACS name for a Btrieve filter.
btrieve_status_code_t	BtrieveFilterSetACSUserDefined (btrieve_filter_t filter, const char *name)
	Set ACS user defined for a Btrieve filter.
btrieve_status_code_t	BtrieveFilterSetComparison (btrieve_filter_t filter, btrieve_comparison_t comparison)
	Set comparison for a Btrieve filter.
btrieve_status_code_t	BtrieveFilterSetComparisonConstant (btrieve_filter_t filter, const char *constant, int constantLength)
	Set comparison constant for a Btrieve filter.
btrieve_status_code_t	BtrieveFilterSetComparisonField (btrieve_filter_t filter, int offset)
	Set comparison field for a Btrieve filter.
btrieve_status_code_t	BtrieveFilterSetConnector (btrieve_filter_t filter, btrieve_connector_t connector)
	Set connector for a Btrieve filter.
btrieve_status_code_t	BtrieveFilterSetField (btrieve_filter_t filter, int offset, int length, btrieve_data_type_t dataType)
	Set field for a Btrieve filter.
btrieve_status_code_t	BtrieveFilterSetLikeCodePageName (btrieve_filter_t filter, const char *name)
	Set like code page name for a Btrieve filter.
btrieve_status_code_t	BtrieveFilterSetSystemField (btrieve_filter_t filter, btrieve_system_field_t systemField)
	Set system field for a Btrieve filter.
const char *	BtrieveFreeSpaceThresholdToString (btrieve_free_space_threshold_t freeSpaceThreshold)
	Return a Btrieve free space threshold as a string.
btrieve_status_code_t	BtrieveIndexAttributesAddKeySegment (btrieve_index_attributes_t indexAttributes, btrieve_key_segment_t keySegment)
	segment for a Btrieve index attributes Addkey
btrieve_status_code_t	BtrieveIndexAttributesAllocate (btrieve_index_attributes_t *btrieveIndexAttributesPtr)
	Allocate a Btrieve index attributes.
btrieve_status_code_t	BtrieveIndexAttributesFree (btrieve_index_attributes_t indexAttributes)
	Free a Btrieve index attributes.
btrieve_status_code_t	BtrieveIndexAttributesSetACSMode (btrieve_index_attributes_t indexAttributes, btrieve_acs_mode_t ACSMode)
	Set ACS mode for a Btrieve index attributes.
btrieve_status_code_t	BtrieveIndexAttributesSetACSName (btrieve_index_attributes_t indexAttributes, const char *ACSName)
	Set ACS name for a Btrieve index attributes.
btrieve_status_code_t	BtrieveIndexAttributesSetACSNumber (btrieve_index_attributes_t indexAttributes, int ACSNumber)
	Set ACS number for a Btrieve index attributes.
btrieve_status_code_t	BtrieveIndexAttributesSetACSUserDefined (btrieve_index_attributes_t indexAttributes, const char *ACSName, const char *ACSMap, int ACSMapLength)
	Set ACS user defined for a Btrieve index attributes.
btrieve_status_code_t	BtrieveIndexAttributesSetDuplicateMode (btrieve_index_attributes_t indexAttributes, btrieve_duplicate_mode_t duplicateMode)
	Set duplicate mode for a Btrieve index attributes.
btrieve_status_code_t	BtrieveIndexAttributesSetIndex (btrieve_index_attributes_t indexAttributes, btrieve_index_t index)
	Set index for a Btrieve IndexAttributes.
btrieve_status_code_t	BtrieveIndexAttributesSetModifiable (btrieve_index_attributes_t indexAttributes, int enableModifiable)
	Set modifiable for a Btrieve index attributes.
const char *	BtrieveIndexToString (btrieve_index_t index)
	Return a Btrieve index as a string.
btrieve_status_code_t	BtrieveKeySegmentAllocate (btrieve_key_segment_t *btrieveKeySegmentPtr)
	Allocate a Btrieve key segment.
btrieve_status_code_t	BtrieveKeySegmentFree (btrieve_key_segment_t keySegment)
	Free a Btrieve key segment.
btrieve_acs_mode_t	BtrieveKeySegmentGetACSMode (btrieve_key_segment_t keySegment)
	Get ACS mode from a Btrieve key segment.
int	BtrieveKeySegmentGetACSNumber (btrieve_key_segment_t keySegment)
	Get ACS number from a Btrieve key segment.
btrieve_data_type_t	BtrieveKeySegmentGetDataType (btrieve_key_segment_t keySegment)
	Get data type from a Btrieve key segment.
int	BtrieveKeySegmentGetDescendingSortOrder (btrieve_key_segment_t keySegment)
	Get descending sort order from a Btrieve key segment.
btrieve_duplicate_mode_t	BtrieveKeySegmentGetDuplicateMode (btrieve_key_segment_t keySegment)
	Get duplicate mode from a Btrieve key segment.
btrieve_index_t	BtrieveKeySegmentGetIndex (btrieve_key_segment_t keySegment)
	Get index from a Btrieve key segment.
int	BtrieveKeySegmentGetKeyContinues (btrieve_key_segment_t keySegment)
	Get key continues from a Btrieve key segment.
btrieve_status_code_t	BtrieveKeySegmentGetLastStatusCode (btrieve_key_segment_t keySegment)
	Get last status code from a Btrieve key segment
int	BtrieveKeySegmentGetLength (btrieve_key_segment_t keySegment)
	Get length from a Btrieve key segment.
int	BtrieveKeySegmentGetModifiable (btrieve_key_segment_t keySegment)
	Get modifiable from a Btrieve key segment.
int	BtrieveKeySegmentGetNullAllSegments (btrieve_key_segment_t keySegment)
	Get null all segments from a Btrieve key segment.
int	BtrieveKeySegmentGetNullAnySegment (btrieve_key_segment_t keySegment)
	Get null any segment from a Btrieve key segment.
btrieve_null_key_mode_t	BtrieveKeySegmentGetNullKeyMode (btrieve_key_segment_t keySegment)
	Get null key mode from a Btrieve key segment.
int	BtrieveKeySegmentGetNullValue (btrieve_key_segment_t keySegment)
	Get null value from a Btrieve key segment.
int	BtrieveKeySegmentGetOffset (btrieve_key_segment_t keySegment)
	Get offset from a Btrieve key segment.
int	BtrieveKeySegmentGetSegmented (btrieve_key_segment_t keySegment)
	Get segmented from a Btrieve key segment.
long long	BtrieveKeySegmentGetUniqueValueCount (btrieve_key_segment_t keySegment)
	Get unique value count from a Btrieve key segment.
int	BtrieveKeySegmentGetUseNumberedACS (btrieve_key_segment_t keySegment)
	Get use numbered ACS from a Btrieve key segment.
btrieve_status_code_t	BtrieveKeySegmentSetDescendingSortOrder (btrieve_key_segment_t keySegment, int setDescendingSortOrder)
	Set descending sort order for a Btrieve key segment.
btrieve_status_code_t	BtrieveKeySegmentSetField (btrieve_key_segment_t keySegment, int offset, int length, btrieve_data_type_t dataType)
	Set field for a Btrieve key segment.
btrieve_status_code_t	BtrieveKeySegmentSetNullKeyMode (btrieve_key_segment_t keySegment, btrieve_null_key_mode_t nullKeyMode)
	Set null key mode for a Btrieve key segment.
btrieve_status_code_t	BtrieveKeySegmentSetNullValue (btrieve_key_segment_t keySegment, int nullValue)
	Set null value for a Btrieve key segment.
const char *	BtrieveLockModeToString (btrieve_lock_mode_t lockMode)
	Return a Btrieve lock mode as a string.
const char *	BtrieveNullKeyModeToString (btrieve_null_key_mode_t nullKeyMode)
	Return a Btrieve null key mode as a string.
const char *	BtrieveOwnerModeToString (btrieve_owner_mode_t ownerMode)
	Return a Btrieve owner mode as a string.
const char *	BtrievePageLockTypeToString (btrieve_page_lock_type_t pageLockType)
	Return a Btrieve page lock type as a string.
const char *	BtrievePageSizeToString (btrieve_page_size_t pageSize)
	Return a Btrieve page size as a string.
const char *	BtrieveRecordCompressionModeToString (btrieve_record_compression_mode_t recordCompressionMode)
	Return a Btrieve record compression mode as a string.
const char *	BtrieveStatusCodeToString (btrieve_status_code_t statusCode)
	Return a Btrieve status code as a string.
const char *	BtrieveSystemDataModeToString (btrieve_system_data_mode_t systemDataMode)
	Return a Btrieve system data mode as a string.
const char *	BtrieveSystemFieldToString (btrieve_system_field_t systemField)
	Return a Btrieve system field as a string.
long long	BtrieveTimestampToUnixEpochMicroseconds (long long timestamp)
	Convert a Btrieve TIMESTAMP to a Unix Epoch timestamp in microseconds.
long long	BtrieveUnixEpochMicrosecondsToTimestamp (long long microseconds)
	Convert a Unix Epoch based timestamp in microseconds to a Btrieve TIMESTAMP.
const char *	BtrieveVariableLengthRecordsModeToString (btrieve_variable_length_records_mode_t variableLengthRecordsMode)
	Return a Btrieve variable length records mode as a string.
btrieve_status_code_t	BtrieveVersionAllocate (btrieve_version_t *btrieveVersionPtr)
	Allocate a Btrieve version.
btrieve_status_code_t	BtrieveVersionFree (btrieve_version_t version)
	Free a Btrieve version.
int	BtrieveVersionGetClientRevisionNumber (btrieve_version_t version)
	Get client revision number from a Btrieve version.
int	BtrieveVersionGetClientVersionNumber (btrieve_version_t version)
	Get client version number from a Btrieve version.
btrieve_version_type_t	BtrieveVersionGetClientVersionType (btrieve_version_t version)
	Get client version type from a Btrieve version.
btrieve_status_code_t	BtrieveVersionGetLastStatusCode (btrieve_version_t version)
	Get last status code from a Btrieve version.
int	BtrieveVersionGetLocalRevisionNumber (btrieve_version_t version)
	Get local revision number from a Btrieve version.
int	BtrieveVersionGetLocalVersionNumber (btrieve_version_t version)
	Get local version number from a Btrieve version.
btrieve_version_type_t	BtrieveVersionGetLocalVersionType (btrieve_version_t version)
	Get local version type from a Btrieve version.
int	BtrieveVersionGetRemoteRevisionNumber (btrieve_version_t version)
	Get remote revision number from a Btrieve version.
int	BtrieveVersionGetRemoteVersionNumber (btrieve_version_t version)
	Get remote version number from a Btrieve version.
btrieve_version_type_t	BtrieveVersionGetRemoteVersionType (btrieve_version_t version)
	Get remote version type from a Btrieve version.
const char *	BtrieveVersionTypeToString (btrieve_version_type_t versionType)
	Return a Btrieve version type as a string.

Macro Definition Documentation

BTRIEVE_MAXIMUM_BULK_RECORD_COUNT

#define BTRIEVE_MAXIMUM_BULK_RECORD_COUNT   25804

The Btrieve maximum bulk record count.

BTRIEVE_MAXIMUM_KEY_LENGTH

#define BTRIEVE_MAXIMUM_KEY_LENGTH   1024

The Btrieve maximum key segment length.

BTRIEVE_MAXIMUM_RECORD_LENGTH

#define BTRIEVE_MAXIMUM_RECORD_LENGTH   (64 * 1024 - 1)

The Btrieve maximum record length.

Typedef Documentation

btrieve_bulk_create_payload_t

typedef struct btrieve_bulk_create_payload* btrieve_bulk_create_payload_t

A Btrieve bulk create payload.

See also

BtrieveBulkCreatePayloadAllocate

btrieve_bulk_create_result_t

typedef struct btrieve_bulk_create_result* btrieve_bulk_create_result_t

A Btrieve bulk create result.

See also

BtrieveBulkCreateResultAllocate

btrieve_bulk_delete_attributes_t

typedef struct btrieve_bulk_delete_attributes* btrieve_bulk_delete_attributes_t

A Btrieve bulk delete attributes.

See also

BtrieveBulkDeleteAttributesAllocate

btrieve_bulk_delete_result_t

typedef struct btrieve_bulk_delete_result* btrieve_bulk_delete_result_t

A Btrieve bulk delete result.

See also

BtrieveBulkDeleteResultAllocate

btrieve_bulk_retrieve_attributes_t

typedef struct btrieve_bulk_retrieve_attributes* btrieve_bulk_retrieve_attributes_t

A Btrieve bulk retrieve attributes.

See also

BtrieveBulkRetrieveAttributesAllocate

btrieve_bulk_retrieve_result_t

typedef struct btrieve_bulk_retrieve_result* btrieve_bulk_retrieve_result_t

A Btrieve bulk retrieve result.

See also

BtrieveBulkRetrieveResultAllocate

btrieve_client_t

typedef struct btrieve_client* btrieve_client_t

A Btrieve client.

Snippet

   btrieve_client_t btrieveClient = NULL;

   // If BtrieveClientAllocate() failed.
   if ((status = BtrieveClientAllocate(&btrieveClient, 0, 0)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveClientAllocate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

See also

BtrieveClientAllocate

btrieve_file_attributes_t

typedef struct btrieve_file_attributes* btrieve_file_attributes_t

A Btrieve file attributes.

Snippet

   btrieve_file_attributes_t btrieveFileAttributes = NULL;

   // If BtrieveFileAttributesAllocate() failed.
   if ((status = BtrieveFileAttributesAllocate(&btrieveFileAttributes)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveFileAttributesAllocate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

See also

BtrieveFileAttributesAllocate

btrieve_file_information_t

typedef struct btrieve_file_information* btrieve_file_information_t

A Btrieve file information.

See also

BtrieveFileInformationAllocate

btrieve_file_t

typedef struct btrieve_file* btrieve_file_t

A Btrieve file.

Snippet

   btrieve_file_t btrieveFile = NULL;

See also

BtrieveClientFileOpen

btrieve_filter_t

typedef struct btrieve_filter* btrieve_filter_t

A Btrieve filter.

See also

BtrieveFilterAllocate

btrieve_index_attributes_t

typedef struct btrieve_index_attributes* btrieve_index_attributes_t

A Btrieve index attributes.

Snippet

   btrieve_index_attributes_t btrieveIndexAttributes = NULL;

   // If BtrieveIndexAttributesAllocate() failed.
   if ((status = BtrieveIndexAttributesAllocate(&btrieveIndexAttributes)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveIndexAttributesAllocate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

See also

BtrieveIndexAttributesAllocate

btrieve_key_segment_t

typedef struct btrieve_key_segment* btrieve_key_segment_t

A Btrieve key segment.

Snippet

   btrieve_key_segment_t btrieveKeySegment = NULL;

   // If BtrieveKeySegmentAllocate() failed.
   if ((status = BtrieveKeySegmentAllocate(&btrieveKeySegment)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveKeySegmentAllocate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

See also

BtrieveKeySegmentAllocate

btrieve_version_t

typedef struct btrieve_version* btrieve_version_t

A Btrieve version.

See also

BtrieveVersionAllocate

Enumeration Type Documentation

btrieve_acs_mode_t

enum btrieve_acs_mode_t

The Btrieve alternate collation sequence modes.

See also

BtrieveACSModeToString

Enumerator
BTRIEVE_ACS_MODE_NONE	None.
BTRIEVE_ACS_MODE_NAMED	Named.
BTRIEVE_ACS_MODE_NUMBERED	Numbered.
BTRIEVE_ACS_MODE_CASE_INSENSITIVE	Case insensitive.
BTRIEVE_ACS_MODE_DEFAULT	Default.
BTRIEVE_ACS_MODE_UNKNOWN	Unknown.

btrieve_comparison_t

enum btrieve_comparison_t

The Btrieve comparisons.

Snippet

   if (BtrieveFileRecordRetrieve(btrieveFile, BTRIEVE_COMPARISON_EQUAL, BTRIEVE_INDEX_1, (char *)key, sizeof(&key), (char *)&record, sizeof(record), BTRIEVE_LOCK_MODE_NONE) != sizeof(record))
   {
      status = BtrieveFileGetLastStatusCode(btrieveFile);
      printf("Error: BtrieveFileRecordRetrieve():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Enumerator
BTRIEVE_COMPARISON_NONE	None.
BTRIEVE_COMPARISON_EQUAL	Equal.
BTRIEVE_COMPARISON_GREATER_THAN	Greater than.
BTRIEVE_COMPARISON_LESS_THAN	Less than.
BTRIEVE_COMPARISON_NOT_EQUAL	Not equal.
BTRIEVE_COMPARISON_GREATER_THAN_OR_EQUAL	Greater than or equal.
BTRIEVE_COMPARISON_LESS_THAN_OR_EQUAL	Less than or equal.
BTRIEVE_COMPARISON_LIKE	Like.
BTRIEVE_COMPARISON_NOT_LIKE	Not like.
BTRIEVE_COMPARISON_JSON_QUERY_MATCH	JSON filter query match.
BTRIEVE_COMPARISON_UNKNOWN	Unknown.

btrieve_connector_t

enum btrieve_connector_t

The Btrieve connectors.

Enumerator
BTRIEVE_CONNECTOR_LAST	Last.
BTRIEVE_CONNECTOR_AND	And.
BTRIEVE_CONNECTOR_OR	Or.
BTRIEVE_CONNECTOR_UNKNOWN	Unknown.

btrieve_create_mode_t

enum btrieve_create_mode_t

The Btrieve create modes.

Snippet

   // If BtrieveClientFileCreate() failed.
   if ((status = BtrieveClientFileCreate(btrieveClient, btrieveFileAttributes, NULL, btrieveFileName, BTRIEVE_CREATE_MODE_OVERWRITE, BTRIEVE_LOCATION_MODE_NO_PREFERENCE)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveClientFileCreate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Enumerator
BTRIEVE_CREATE_MODE_OVERWRITE	Overwrite.
BTRIEVE_CREATE_MODE_NO_OVERWRITE	No overwrite.
BTRIEVE_CREATE_MODE_UNKNOWN	Unknown.

btrieve_data_type_t

enum btrieve_data_type_t

The Btrieve data types.

Snippet

   // If BtrieveKeySegmentSetField() failed.
   if ((status = BtrieveKeySegmentSetField(btrieveKeySegment, 0, 1, BTRIEVE_DATA_TYPE_UNSIGNED_BINARY)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveKeySegmentSetField():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

See also

BtrieveDataTypeToString

Enumerator
BTRIEVE_DATA_TYPE_CHAR	Character.
BTRIEVE_DATA_TYPE_ZSTRING	Null terminated string.
BTRIEVE_DATA_TYPE_INTEGER	Integer.
BTRIEVE_DATA_TYPE_UNSIGNED_BINARY	Unsigned binary.
BTRIEVE_DATA_TYPE_FLOAT	Float.
BTRIEVE_DATA_TYPE_AUTOINCREMENT	Automatic increment.
BTRIEVE_DATA_TYPE_DATE	Date.
BTRIEVE_DATA_TYPE_NUMERICSTS	Numeric sign trailing separate.
BTRIEVE_DATA_TYPE_TIME	Time.
BTRIEVE_DATA_TYPE_NUMERICSA	Numeric signed ASCII.
BTRIEVE_DATA_TYPE_DECIMAL	Decimal.
BTRIEVE_DATA_TYPE_CURRENCY	Currency.
BTRIEVE_DATA_TYPE_MONEY	Money.
BTRIEVE_DATA_TYPE_TIMESTAMP	Timestamp.
BTRIEVE_DATA_TYPE_LOGICAL	Logical.
BTRIEVE_DATA_TYPE_WSTRING	Wide string.
BTRIEVE_DATA_TYPE_NUMERIC	Numeric.
BTRIEVE_DATA_TYPE_WZSTRING	Wide null terminated string.
BTRIEVE_DATA_TYPE_BFLOAT	BASIC float.
BTRIEVE_DATA_TYPE_GUID	Globally unique identifier.
BTRIEVE_DATA_TYPE_LSTRING	Length first string.
BTRIEVE_DATA_TYPE_NULL_INDICATOR_SEGMENT	Null indicator segment.
BTRIEVE_DATA_TYPE_LEGACY_STRING	Legacy string.
BTRIEVE_DATA_TYPE_LEGACY_BINARY	Legacy binary.
BTRIEVE_DATA_TYPE_AUTOTIMESTAMP	Automatic timestamp.
BTRIEVE_DATA_TYPE_CLOB	Character large object.
BTRIEVE_DATA_TYPE_TIMESTAMP2	Nanosecond resolution timestamp.
BTRIEVE_DATA_TYPE_BIT	Bit.
BTRIEVE_DATA_TYPE_NUMERICSLB	Numeric sign leading COBOL.
BTRIEVE_DATA_TYPE_NUMERICSLS	Numeric sign leading separate.
BTRIEVE_DATA_TYPE_NUMERICSTB	Numeric sign trailing COBOL.
BTRIEVE_DATA_TYPE_UNKNOWN	Unknown.

btrieve_disk_drive_t

enum btrieve_disk_drive_t

The Btrieve disk drives.

Enumerator
BTRIEVE_DISK_DRIVE_A	Disk drive A.
BTRIEVE_DISK_DRIVE_B	Disk drive B.
BTRIEVE_DISK_DRIVE_C	Disk drive C.
BTRIEVE_DISK_DRIVE_D	Disk drive D.
BTRIEVE_DISK_DRIVE_E	Disk drive E.
BTRIEVE_DISK_DRIVE_F	Disk drive F.
BTRIEVE_DISK_DRIVE_G	Disk drive G.
BTRIEVE_DISK_DRIVE_H	Disk drive H.
BTRIEVE_DISK_DRIVE_I	Disk drive I.
BTRIEVE_DISK_DRIVE_J	Disk drive J.
BTRIEVE_DISK_DRIVE_K	Disk drive K.
BTRIEVE_DISK_DRIVE_L	Disk drive L.
BTRIEVE_DISK_DRIVE_M	Disk drive M.
BTRIEVE_DISK_DRIVE_N	Disk drive N.
BTRIEVE_DISK_DRIVE_O	Disk drive O.
BTRIEVE_DISK_DRIVE_P	Disk drive P.
BTRIEVE_DISK_DRIVE_Q	Disk drive Q.
BTRIEVE_DISK_DRIVE_R	Disk drive R.
BTRIEVE_DISK_DRIVE_S	Disk drive S.
BTRIEVE_DISK_DRIVE_T	Disk drive T.
BTRIEVE_DISK_DRIVE_U	Disk drive U.
BTRIEVE_DISK_DRIVE_V	Disk drive V.
BTRIEVE_DISK_DRIVE_W	Disk drive W.
BTRIEVE_DISK_DRIVE_X	Disk drive X.
BTRIEVE_DISK_DRIVE_Y	Disk drive Y.
BTRIEVE_DISK_DRIVE_Z	Disk drive Z.
BTRIEVE_DISK_DRIVE_DEFAULT	Default.
BTRIEVE_DISK_DRIVE_UNKNOWN	Unknown.

btrieve_duplicate_mode_t

enum btrieve_duplicate_mode_t

The Btrieve duplicate modes.

See also

BtrieveDuplicateModeToString

Enumerator
BTRIEVE_DUPLICATE_MODE_NOT_ALLOWED	Duplicates not allowed.
BTRIEVE_DUPLICATE_MODE_ALLOWED_NONREPEATING	Duplicates allowed, nonrepeating.
BTRIEVE_DUPLICATE_MODE_ALLOWED_REPEATING	Duplicates allowed, repeating.
BTRIEVE_DUPLICATE_MODE_UNKNOWN	Unknown.

btrieve_encrypt_type_t

enum btrieve_encrypt_type_t

The Btrieve file encryption types.

See also

BtrieveOwnerModeToString

Enumerator
BTRIEVE_ENCRYPT_TYPE_NONE	None.
BTRIEVE_ENCRYPT_TYPE_TRADITIONAL	Traditional encryption.
BTRIEVE_ENCRYPT_TYPE_128_BIT	128-bit encryption.
BTRIEVE_ENCRYPT_TYPE_AES_192	AES-192 encryption.
BTRIEVE_ENCRYPT_TYPE_AES_256	AES-256 encryption.
BTRIEVE_ENCRYPT_TYPE_UNKNOWN	Unknown.

btrieve_file_version_t

enum btrieve_file_version_t

The Btrieve file versions.

See also

BtrieveFileVersionToString

Enumerator
BTRIEVE_FILE_VERSION_6_0	File version 6.0.
BTRIEVE_FILE_VERSION_6_1	File version 6.1.
BTRIEVE_FILE_VERSION_7_0	File version 7.0.
BTRIEVE_FILE_VERSION_8_0	File version 8.0.
BTRIEVE_FILE_VERSION_9_0	File version 9.0.
BTRIEVE_FILE_VERSION_9_5	File version 9.5.
BTRIEVE_FILE_VERSION_13_0	File version 13.0.
BTRIEVE_FILE_VERSION_16_0	File version 16.0.
BTRIEVE_FILE_VERSION_DEFAULT	Default.
BTRIEVE_FILE_VERSION_UNKNOWN	Unknown.

btrieve_free_space_threshold_t

enum btrieve_free_space_threshold_t

The Btrieve free space thresholds.

See also

BtrieveFreeSpaceThresholdToString

Enumerator
BTRIEVE_FREE_SPACE_THRESHOLD_10_PERCENT	Free space threshold 10%.
BTRIEVE_FREE_SPACE_THRESHOLD_20_PERCENT	Free space threshold 20%.
BTRIEVE_FREE_SPACE_THRESHOLD_30_PERCENT	Free space threshold 30%.
BTRIEVE_FREE_SPACE_THRESHOLD_DEFAULT	Default.
BTRIEVE_FREE_SPACE_THRESHOLD_UNKNOWN	Unknown.

btrieve_index_t

enum btrieve_index_t

The Btrieve indexes.

Snippet

   if (BtrieveFileRecordRetrieve(btrieveFile, BTRIEVE_COMPARISON_EQUAL, BTRIEVE_INDEX_1, (char *)key, sizeof(&key), (char *)&record, sizeof(record), BTRIEVE_LOCK_MODE_NONE) != sizeof(record))
   {
      status = BtrieveFileGetLastStatusCode(btrieveFile);
      printf("Error: BtrieveFileRecordRetrieve():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

See also

BtrieveIndexToString

Enumerator
BTRIEVE_INDEX_1	Index 1.
BTRIEVE_INDEX_2	Index 2.
BTRIEVE_INDEX_3	Index 3.
BTRIEVE_INDEX_4	Index 4.
BTRIEVE_INDEX_5	Index 5.
BTRIEVE_INDEX_6	Index 6.
BTRIEVE_INDEX_7	Index 7.
BTRIEVE_INDEX_8	Index 8.
BTRIEVE_INDEX_9	Index 9.
BTRIEVE_INDEX_10	Index 10.
BTRIEVE_INDEX_11	Index 11.
BTRIEVE_INDEX_12	Index 12.
BTRIEVE_INDEX_13	Index 13.
BTRIEVE_INDEX_14	Index 14.
BTRIEVE_INDEX_15	Index 15.
BTRIEVE_INDEX_16	Index 16.
BTRIEVE_INDEX_17	Index 17.
BTRIEVE_INDEX_18	Index 18.
BTRIEVE_INDEX_19	Index 19.
BTRIEVE_INDEX_20	Index 20.
BTRIEVE_INDEX_21	Index 21.
BTRIEVE_INDEX_22	Index 22.
BTRIEVE_INDEX_23	Index 23.
BTRIEVE_INDEX_24	Index 24.
BTRIEVE_INDEX_25	Index 25.
BTRIEVE_INDEX_26	Index 26.
BTRIEVE_INDEX_27	Index 27.
BTRIEVE_INDEX_28	Index 28.
BTRIEVE_INDEX_29	Index 29.
BTRIEVE_INDEX_30	Index 30.
BTRIEVE_INDEX_31	Index 31.
BTRIEVE_INDEX_32	Index 32.
BTRIEVE_INDEX_33	Index 33.
BTRIEVE_INDEX_34	Index 34.
BTRIEVE_INDEX_35	Index 35.
BTRIEVE_INDEX_36	Index 36.
BTRIEVE_INDEX_37	Index 37.
BTRIEVE_INDEX_38	Index 38.
BTRIEVE_INDEX_39	Index 39.
BTRIEVE_INDEX_40	Index 40.
BTRIEVE_INDEX_41	Index 41.
BTRIEVE_INDEX_42	Index 42.
BTRIEVE_INDEX_43	Index 43.
BTRIEVE_INDEX_44	Index 44.
BTRIEVE_INDEX_45	Index 45.
BTRIEVE_INDEX_46	Index 46.
BTRIEVE_INDEX_47	Index 47.
BTRIEVE_INDEX_48	Index 48.
BTRIEVE_INDEX_49	Index 49.
BTRIEVE_INDEX_50	Index 50.
BTRIEVE_INDEX_51	Index 51.
BTRIEVE_INDEX_52	Index 52.
BTRIEVE_INDEX_53	Index 53.
BTRIEVE_INDEX_54	Index 54.
BTRIEVE_INDEX_55	Index 55.
BTRIEVE_INDEX_56	Index 56.
BTRIEVE_INDEX_57	Index 57.
BTRIEVE_INDEX_58	Index 58.
BTRIEVE_INDEX_59	Index 59.
BTRIEVE_INDEX_60	Index 60.
BTRIEVE_INDEX_61	Index 61.
BTRIEVE_INDEX_62	Index 62.
BTRIEVE_INDEX_63	Index 63.
BTRIEVE_INDEX_64	Index 64.
BTRIEVE_INDEX_65	Index 65.
BTRIEVE_INDEX_66	Index 66.
BTRIEVE_INDEX_67	Index 67.
BTRIEVE_INDEX_68	Index 68.
BTRIEVE_INDEX_69	Index 69.
BTRIEVE_INDEX_70	Index 70.
BTRIEVE_INDEX_71	Index 71.
BTRIEVE_INDEX_72	Index 72.
BTRIEVE_INDEX_73	Index 73.
BTRIEVE_INDEX_74	Index 74.
BTRIEVE_INDEX_75	Index 75.
BTRIEVE_INDEX_76	Index 76.
BTRIEVE_INDEX_77	Index 77.
BTRIEVE_INDEX_78	Index 78.
BTRIEVE_INDEX_79	Index 79.
BTRIEVE_INDEX_80	Index 80.
BTRIEVE_INDEX_81	Index 81.
BTRIEVE_INDEX_82	Index 82.
BTRIEVE_INDEX_83	Index 83.
BTRIEVE_INDEX_84	Index 84.
BTRIEVE_INDEX_85	Index 85.
BTRIEVE_INDEX_86	Index 86.
BTRIEVE_INDEX_87	Index 87.
BTRIEVE_INDEX_88	Index 88.
BTRIEVE_INDEX_89	Index 89.
BTRIEVE_INDEX_90	Index 90.
BTRIEVE_INDEX_91	Index 91.
BTRIEVE_INDEX_92	Index 92.
BTRIEVE_INDEX_93	Index 93.
BTRIEVE_INDEX_94	Index 94.
BTRIEVE_INDEX_95	Index 95.
BTRIEVE_INDEX_96	Index 96.
BTRIEVE_INDEX_97	Index 97.
BTRIEVE_INDEX_98	Index 98.
BTRIEVE_INDEX_99	Index 99.
BTRIEVE_INDEX_100	Index 100.
BTRIEVE_INDEX_101	Index 101.
BTRIEVE_INDEX_102	Index 102.
BTRIEVE_INDEX_103	Index 103.
BTRIEVE_INDEX_104	Index 104.
BTRIEVE_INDEX_105	Index 105.
BTRIEVE_INDEX_106	Index 106.
BTRIEVE_INDEX_107	Index 107.
BTRIEVE_INDEX_108	Index 108.
BTRIEVE_INDEX_109	Index 109.
BTRIEVE_INDEX_110	Index 110.
BTRIEVE_INDEX_111	Index 111.
BTRIEVE_INDEX_112	Index 112.
BTRIEVE_INDEX_113	Index 113.
BTRIEVE_INDEX_114	Index 114.
BTRIEVE_INDEX_115	Index 115.
BTRIEVE_INDEX_116	Index 116.
BTRIEVE_INDEX_117	Index 117.
BTRIEVE_INDEX_118	Index 118.
BTRIEVE_INDEX_119	Index 119.
BTRIEVE_INDEX_SYSTEM_VERSION_2	System Version 2.
BTRIEVE_INDEX_SYSTEM	System.
BTRIEVE_INDEX_NONE	None.
BTRIEVE_INDEX_UNKNOWN	Unknown.

btrieve_location_mode_t

enum btrieve_location_mode_t

The Btrieve location modes.

Snippet

   // If BtrieveClientFileCreate() failed.
   if ((status = BtrieveClientFileCreate(btrieveClient, btrieveFileAttributes, NULL, btrieveFileName, BTRIEVE_CREATE_MODE_OVERWRITE, BTRIEVE_LOCATION_MODE_NO_PREFERENCE)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveClientFileCreate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Enumerator
BTRIEVE_LOCATION_MODE_NO_PREFERENCE	No preference.
BTRIEVE_LOCATION_MODE_FORCE_LOCAL	Force local.
BTRIEVE_LOCATION_MODE_FORCE_REMOTE	Force remote.
BTRIEVE_LOCATION_MODE_UNKNOWN	Unknown.

btrieve_lock_mode_t

enum btrieve_lock_mode_t

The Btrieve lock modes.

Snippet

   if (BtrieveFileRecordRetrieve(btrieveFile, BTRIEVE_COMPARISON_EQUAL, BTRIEVE_INDEX_1, (char *)key, sizeof(&key), (char *)&record, sizeof(record), BTRIEVE_LOCK_MODE_NONE) != sizeof(record))
   {
      status = BtrieveFileGetLastStatusCode(btrieveFile);
      printf("Error: BtrieveFileRecordRetrieve():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

See also

BtrieveLockModeToString

Enumerator
BTRIEVE_LOCK_MODE_NONE	None.
BTRIEVE_LOCK_MODE_SINGLE_WAIT	Single with wait.
BTRIEVE_LOCK_MODE_SINGLE_NO_WAIT	Single with no wait.
BTRIEVE_LOCK_MODE_MULTIPLE_WAIT	Multiple with wait.
BTRIEVE_LOCK_MODE_MULTIPLE_NO_WAIT	Multiple with no wait.
BTRIEVE_LOCK_MODE_UNKNOWN	Unknown.

btrieve_null_key_mode_t

enum btrieve_null_key_mode_t

The Btrieve null key modes.

See also

BtrieveNullKeyModeToString

Enumerator
BTRIEVE_NULL_KEY_MODE_ALL_SEGMENTS	All segments.
BTRIEVE_NULL_KEY_MODE_ANY_SEGMENTS	Any segments.
BTRIEVE_NULL_KEY_MODE_NONE	None.
BTRIEVE_NULL_KEY_MODE_UNKNOWN	Unknown.

btrieve_open_mode_t

enum btrieve_open_mode_t

The Btrieve open modes.

Snippet

   // If BtrieveClientFileOpen() failed.
   if ((status = BtrieveClientFileOpen(btrieveClient, btrieveFile, btrieveFileName, NULL, BTRIEVE_OPEN_MODE_NORMAL, BTRIEVE_LOCATION_MODE_NO_PREFERENCE)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveClientFileOpen():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Enumerator
BTRIEVE_OPEN_MODE_NORMAL	Normal.
BTRIEVE_OPEN_MODE_ACCELERATED	Accelerated.
BTRIEVE_OPEN_MODE_READ_ONLY	Read only.
BTRIEVE_OPEN_MODE_EXCLUSIVE	Exclusive.
BTRIEVE_OPEN_MODE_WRITABLE	Writable.
BTRIEVE_OPEN_MODE_UNKNOWN	Unknown.

btrieve_owner_mode_t

enum btrieve_owner_mode_t

The Btrieve file owner modes.

See also

BtrieveOwnerModeToString

Enumerator
BTRIEVE_OWNER_MODE_NONE	None.
BTRIEVE_OWNER_MODE_NO_ENCRYPTION_NO_READ_ALLOWED	No encryption with no read allowed.
BTRIEVE_OWNER_MODE_NO_ENCRYPTION_READ_ALLOWED	No encryption with read allowed.
BTRIEVE_OWNER_MODE_ENCRYPTION_NO_READ_ALLOWED	Encryption with no read allowed.
BTRIEVE_OWNER_MODE_ENCRYPTION_READ_ALLOWED	Encryption with read allowed.
BTRIEVE_OWNER_MODE_UNKNOWN	Unknown.

btrieve_page_lock_type_t

enum btrieve_page_lock_type_t

The Btrieve page lock type.

See also

BtrievePageLockTypeToString

Enumerator
BTRIEVE_PAGE_LOCK_TYPE_NONE	None.
BTRIEVE_PAGE_LOCK_TYPE_DATA_PAGE	Data page.
BTRIEVE_PAGE_LOCK_TYPE_INDEX_PAGE	Index page.
BTRIEVE_PAGE_LOCK_TYPE_VARIABLE_PAGE	Variable page.
BTRIEVE_PAGE_LOCK_TYPE_UNKNOWN	Unknown.

btrieve_page_size_t

enum btrieve_page_size_t

The Btrieve page sizes.

See also

BtrievePageSizeToString

Enumerator
BTRIEVE_PAGE_SIZE_512	Page size 512.
BTRIEVE_PAGE_SIZE_1024	Page size 1024.
BTRIEVE_PAGE_SIZE_1536	Page size 1536.
BTRIEVE_PAGE_SIZE_2048	Page size 2048.
BTRIEVE_PAGE_SIZE_3072	Page size 3072.
BTRIEVE_PAGE_SIZE_3584	Page size 3584.
BTRIEVE_PAGE_SIZE_4096	Page size 4096.
BTRIEVE_PAGE_SIZE_8192	Page size 8192.
BTRIEVE_PAGE_SIZE_16384	Page size 16384.
BTRIEVE_PAGE_SIZE_DEFAULT	Default.
BTRIEVE_PAGE_SIZE_UNKNOWN	Unknown.

btrieve_record_compression_mode_t

enum btrieve_record_compression_mode_t

The Btrieve record compression modes.

See also

BtrieveRecordCompressionModeToString

Enumerator
BTRIEVE_RECORD_COMPRESSION_MODE_NONE	None.
BTRIEVE_RECORD_COMPRESSION_MODE_BLANK_TRUNCATION	Blank truncation.
BTRIEVE_RECORD_COMPRESSION_MODE_RUN_LENGTH_ENCODING	Run length encoding.
BTRIEVE_RECORD_COMPRESSION_MODE_UNKNOWN	Unknown.

btrieve_status_code_t

enum btrieve_status_code_t

The Btrieve status codes.

Snippet

   // If BtrieveFileAttributesAllocate() failed.
   if ((status = BtrieveFileAttributesAllocate(&btrieveFileAttributes)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveFileAttributesAllocate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

See also

BtrieveStatusCodeToString

Enumerator
BTRIEVE_STATUS_CODE_NO_ERROR	0 - No error.
BTRIEVE_STATUS_CODE_INVALID_FUNCTION	1 - Invalid function.
BTRIEVE_STATUS_CODE_IO_ERROR	2 - Input/Output error.
BTRIEVE_STATUS_CODE_FILE_NOT_OPEN	3 - File not open.
BTRIEVE_STATUS_CODE_KEY_VALUE_NOT_FOUND	4 - Key value not found.
BTRIEVE_STATUS_CODE_DUPLICATE_KEY_VALUE	5 - Duplicate key value.
BTRIEVE_STATUS_CODE_INVALID_INDEX_NUMBER	6 - Invalid index number.
BTRIEVE_STATUS_CODE_DIFFERENT_INDEX_NUMBER	7 - Different index number.
BTRIEVE_STATUS_CODE_POSITION_NOT_SET	8 - Position not set.
BTRIEVE_STATUS_CODE_END_OF_FILE	9 - End of file.
BTRIEVE_STATUS_CODE_MODIFIABLE_KEYVALUE_ERROR	10 - Modifiable key value error.
BTRIEVE_STATUS_CODE_FILENAME_BAD	11 - File name bad.
BTRIEVE_STATUS_CODE_FILE_NOT_FOUND	12 - File not found.
BTRIEVE_STATUS_CODE_EXTENDED_FILE_ERROR	13 - Extended file error.
BTRIEVE_STATUS_CODE_PREIMAGE_OPEN_ERROR	14 - Preimage open error.
BTRIEVE_STATUS_CODE_PREIMAGE_IO_ERROR	15 - Preimage input/output error.
BTRIEVE_STATUS_CODE_EXPANSION_ERROR	16 - Expansion error.
BTRIEVE_STATUS_CODE_CLOSE_ERROR	17 - Close error.
BTRIEVE_STATUS_CODE_DISKFULL	18 - Disk full.
BTRIEVE_STATUS_CODE_UNRECOVERABLE_ERROR	19 - Unrecoverable error.
BTRIEVE_STATUS_CODE_RECORD_MANAGER_INACTIVE	20 - Record manager inactive.
BTRIEVE_STATUS_CODE_KEYBUFFER_TOO_SHORT	21 - Key buffer too short.
BTRIEVE_STATUS_CODE_DATALENGTH_ERROR	22 - Data length error.
BTRIEVE_STATUS_CODE_POSITIONBLOCK_LENGTH	23 - Position block length.
BTRIEVE_STATUS_CODE_PAGE_SIZE_ERROR	24 - Page size error.
BTRIEVE_STATUS_CODE_CREATE_IO_ERROR	25 - Create input/output error.
BTRIEVE_STATUS_CODE_NUMBER_OF_INDEXES	26 - Number of indexes.
BTRIEVE_STATUS_CODE_INVALID_KEY_POSITION	27 - Invalid key position.
BTRIEVE_STATUS_CODE_INVALID_RECORD_LENGTH	28 - Invalid record length.
BTRIEVE_STATUS_CODE_INVALID_KEYLENGTH	29 - Invalid keylength.
BTRIEVE_STATUS_CODE_NOT_A_BTRIEVE_FILE	30 - Not a Btrieve file.
BTRIEVE_STATUS_CODE_FILE_ALREADY_EXTENDED	31 - File already extended.
BTRIEVE_STATUS_CODE_EXTEND_IO_ERROR	32 - Extend input/output error.
BTRIEVE_STATUS_CODE_BTR_CANNOT_UNLOAD	33 - Btrieve cannot unload.
BTRIEVE_STATUS_CODE_INVALID_EXTENSION_NAME	34 - Invalid extension name.
BTRIEVE_STATUS_CODE_DIRECTORY_ERROR	35 - Directory error.
BTRIEVE_STATUS_CODE_TRANSACTION_ERROR	36 - Transaction error.
BTRIEVE_STATUS_CODE_TRANSACTION_IS_ACTIVE	37 - Transaction is active.
BTRIEVE_STATUS_CODE_TRANSACTION_FILE_IO_ERROR	38 - Transaction file input/output error.
BTRIEVE_STATUS_CODE_END_TRANSACTION_ERROR	39 - End transaction error.
BTRIEVE_STATUS_CODE_TRANSACTION_MAX_FILES	40 - Transaction maximum files.
BTRIEVE_STATUS_CODE_OPERATION_NOT_ALLOWED	41 - Operation not allowed.
BTRIEVE_STATUS_CODE_INCOMPLETE_ACCEL_ACCESS	42 - Incomplete accelerated access.
BTRIEVE_STATUS_CODE_INVALID_RECORD_ADDRESS	43 - Invalid record address.
BTRIEVE_STATUS_CODE_NULL_KEYPATH	44 - Null key path.
BTRIEVE_STATUS_CODE_INCONSISTENT_KEY_FLAGS	45 - Inconsistent key flags.
BTRIEVE_STATUS_CODE_ACCESS_TO_FILE_DENIED	46 - Access to file denied.
BTRIEVE_STATUS_CODE_MAXIMUM_OPEN_FILES	47 - Maximum open files.
BTRIEVE_STATUS_CODE_INVALID_ALT_SEQUENCE_DEF	48 - Invalid alternate collating sequence definition.
BTRIEVE_STATUS_CODE_KEY_TYPE_ERROR	49 - Key type error.
BTRIEVE_STATUS_CODE_OWNER_ALREADY_SET	50 - Owner already set.
BTRIEVE_STATUS_CODE_INVALID_OWNER	51 - Invalid owner.
BTRIEVE_STATUS_CODE_ERROR_WRITING_CACHE	52 - Error writing cache.
BTRIEVE_STATUS_CODE_INVALID_INTERFACE	53 - Invalid interface.
BTRIEVE_STATUS_CODE_VARIABLE_PAGE_ERROR	54 - Variable page error.
BTRIEVE_STATUS_CODE_AUTOINCREMENT_ERROR	55 - Autoincrement error.
BTRIEVE_STATUS_CODE_INCOMPLETE_INDEX	56 - Incomplete index.
BTRIEVE_STATUS_CODE_EXPANED_MEM_ERROR	57 - Expaned memory error.
BTRIEVE_STATUS_CODE_COMPRESS_BUFFER_TOO_SHORT	58 - Compress buffer too short.
BTRIEVE_STATUS_CODE_FILE_ALREADY_EXISTS	59 - File already exists.
BTRIEVE_STATUS_CODE_REJECT_COUNT_REACHED	60 - Reject count reached.
BTRIEVE_STATUS_CODE_SMALL_EX_GET_BUFFER_ERROR	61 - Small extended get buffer error.
BTRIEVE_STATUS_CODE_INVALID_GET_EXPRESSION	62 - Invalid get expression.
BTRIEVE_STATUS_CODE_INVALID_EXT_INSERT_BUFF	63 - Invalid extended insert buffer.
BTRIEVE_STATUS_CODE_OPTIMIZE_LIMIT_REACHED	64 - Optimize limit reached.
BTRIEVE_STATUS_CODE_INVALID_EXTRACTOR	65 - Invalid extractor.
BTRIEVE_STATUS_CODE_RI_TOO_MANY_DATABASES	66 - Referential integrity too many databases.
BTRIEVE_STATUS_CODE_RIDDF_CANNOT_OPEN	67 - Referential integrity SQL data dictionary files cannot open.
BTRIEVE_STATUS_CODE_RI_CASCADE_TOO_DEEP	68 - Referential integrity cascade too deep.
BTRIEVE_STATUS_CODE_RI_CASCADE_ERROR	69 - Referential integrity cascade error.
BTRIEVE_STATUS_CODE_RI_VIOLATION	71 - Referential integrity violation.
BTRIEVE_STATUS_CODE_RI_REFERENCED_FILE_CANNOT_OPEN	72 - Referential integrity referenced file cannot open.
BTRIEVE_STATUS_CODE_RI_OUT_OF_SYNC	73 - Referential integrity out of sync.
BTRIEVE_STATUS_CODE_END_CHANGED_TO_ABORT	74 - End changed to abort.
BTRIEVE_STATUS_CODE_RI_CONFLICT	76 - Referential integrity conflict.
BTRIEVE_STATUS_CODE_CANT_LOOP_IN_SERVER	77 - Can't loop in server.
BTRIEVE_STATUS_CODE_DEAD_LOCK	78 - Dead lock.
BTRIEVE_STATUS_CODE_PROGRAMMING_ERROR	79 - Programming error.
BTRIEVE_STATUS_CODE_CONFLICT	80 - Conflict.
BTRIEVE_STATUS_CODE_LOCKERROR	81 - Lock error.
BTRIEVE_STATUS_CODE_LOST_POSITION	82 - Lost position.
BTRIEVE_STATUS_CODE_READ_OUTSIDE_TRANSACTION	83 - Read outside transaction.
BTRIEVE_STATUS_CODE_RECORD_INUSE	84 - Record in use.
BTRIEVE_STATUS_CODE_FILE_INUSE	85 - File in use.
BTRIEVE_STATUS_CODE_FILE_TABLE_FULL	86 - File table full.
BTRIEVE_STATUS_CODE_NOHANDLES_AVAILABLE	87 - No handles available.
BTRIEVE_STATUS_CODE_INCOMPATIBLE_MODE_ERROR	88 - Incompatible mode error.
BTRIEVE_STATUS_CODE_DEVICE_TABLE_FULL	90 - Device table full.
BTRIEVE_STATUS_CODE_SERVER_ERROR	91 - Server error.
BTRIEVE_STATUS_CODE_TRANSACTION_TABLE_FULL	92 - Transaction table full.
BTRIEVE_STATUS_CODE_INCOMPATIBLE_LOCK_TYPE	93 - Incompatible lock type.
BTRIEVE_STATUS_CODE_PERMISSION_ERROR	94 - Permission error.
BTRIEVE_STATUS_CODE_SESSION_NO_LONGER_VALID	95 - Session no longer valid.
BTRIEVE_STATUS_CODE_COMMUNICATIONS_ERROR	96 - Communications error.
BTRIEVE_STATUS_CODE_DATA_MESSAGE_TOO_SMALL	97 - Data message too small.
BTRIEVE_STATUS_CODE_INTERNAL_TRANSACTION_ERROR	98 - Internal transaction error.
BTRIEVE_STATUS_CODE_REQUESTER_CANT_ACCESS_RUNTIME	99 - Requester can't access runtime.
BTRIEVE_STATUS_CODE_NO_CACHE_BUFFERS_AVAIL	100 - No cache buffers available.
BTRIEVE_STATUS_CODE_NO_OS_MEMORY_AVAIL	101 - No operating system memory available.
BTRIEVE_STATUS_CODE_NO_STACK_AVAIL	102 - No stack available.
BTRIEVE_STATUS_CODE_CHUNK_OFFSET_TOO_LONG	103 - Chunk offset too long.
BTRIEVE_STATUS_CODE_LOCALE_ERROR	104 - Locale error.
BTRIEVE_STATUS_CODE_CANNOT_CREATE_WITH_VAT	105 - Cannot create with variable tail allocation table.
BTRIEVE_STATUS_CODE_CHUNK_CANNOT_GET_NEXT	106 - Chunk cannot get next.
BTRIEVE_STATUS_CODE_CHUNK_INCOMPATIBLE_FILE	107 - Chunk incompatible file.
BTRIEVE_STATUS_CODE_TRANSACTION_TOO_COMPLEX	109 - Transaction too complex.
BTRIEVE_STATUS_CODE_ARCH_BLOG_OPEN_ERROR	110 - Archival BLOG open error.
BTRIEVE_STATUS_CODE_ARCH_FILE_NOT_LOGGED	111 - Archival file not logged.
BTRIEVE_STATUS_CODE_ARCH_FILE_IN_USE	112 - Archival file in use.
BTRIEVE_STATUS_CODE_ARCH_LOGFILE_NOT_FOUND	113 - Archival log file not found.
BTRIEVE_STATUS_CODE_ARCH_LOGFILE_INVALID	114 - Archival log file invalid.
BTRIEVE_STATUS_CODE_ARCH_DUMPFILE_ACCESS_ERROR	115 - Archival dump file access error.
BTRIEVE_STATUS_CODE_LOCATOR_FILE_INDICATOR	116 - Locator file indicator.
BTRIEVE_STATUS_CODE_NO_SYSTEM_LOCKS_AVAILABLE	130 - No system locks available.
BTRIEVE_STATUS_CODE_FILE_FULL	132 - File full.
BTRIEVE_STATUS_CODE_MORE_THAN_5_CONCURRENT_USERS	133 - More than 5 concurrent users.
BTRIEVE_STATUS_CODE_ISR_NOT_FOUND	134 - International sorting rule not found.
BTRIEVE_STATUS_CODE_ISR_INVALID	135 - International sorting rule invalid.
BTRIEVE_STATUS_CODE_ACS_NOT_FOUND	136 - Alternate collating sequence not found.
BTRIEVE_STATUS_CODE_CANNOT_CONVERT_RP	137 - Cannot convert RP.
BTRIEVE_STATUS_CODE_INVALID_NULL_INDICATOR	138 - Invalid null indicator.
BTRIEVE_STATUS_CODE_INVALID_KEY_OPTION	139 - Invalid key option.
BTRIEVE_STATUS_CODE_INCOMPATIBLE_CLOSE	140 - Incompatible close.
BTRIEVE_STATUS_CODE_INVALID_USERNAME	141 - Invalid user name.
BTRIEVE_STATUS_CODE_INVALID_DATABASE	142 - Invalid database.
BTRIEVE_STATUS_CODE_NO_SSQL_RIGHTS	143 - No SSQL rights.
BTRIEVE_STATUS_CODE_ALREADY_LOGGED_IN	144 - Already logged in.
BTRIEVE_STATUS_CODE_NO_DATABASE_SERVICES	145 - No database services.
BTRIEVE_STATUS_CODE_DUPLICATE_SYSTEM_KEY	146 - Duplicate system key.
BTRIEVE_STATUS_CODE_LOG_SEGMENT_MISSING	147 - Log segment missing.
BTRIEVE_STATUS_CODE_ROLL_FORWARD_ERROR	148 - Roll forward error.
BTRIEVE_STATUS_CODE_SYSTEM_KEY_INTERNAL	149 - System key internal.
BTRIEVE_STATUS_CODE_DBS_INTERNAL_ERROR	150 - DBS internal error.
BTRIEVE_STATUS_CODE_CHUNK_OFFSET_TOO_SMALL	151 - Chunk offset too small. Note Renamed from BTRIEVE_STATUS_CODE_NESTING_DEPTH_ERROR in Zen v15 R1.
BTRIEVE_STATUS_CODE_INVALID_PARAMETER_TO_MKDE	160 - Invalid parameter to MicroKernel.
BTRIEVE_STATUS_CODE_USER_COUNT_LIMIT_EXCEEDED	161 - User count limit exceeded.
BTRIEVE_STATUS_CODE_CLIENT_TABLE_FULL	162 - Client table full.
BTRIEVE_STATUS_CODE_LAST_SEGMENT_ERROR	163 - Last segment error.
BTRIEVE_STATUS_CODE_LOGIN_FAILED_BAD_USERNAME	170 - Login failed bad user name.
BTRIEVE_STATUS_CODE_LOGIN_FAILED_BAD_PASSWORD	171 - Login failed bad password.
BTRIEVE_STATUS_CODE_LOGIN_FAILED_BAD_DATABASE	172 - Login failed bad database.
BTRIEVE_STATUS_CODE_LOGIN_ALREADY_LOGGED_IN	173 - Login already logged in.
BTRIEVE_STATUS_CODE_LOGIN_LOGOUT_FAILED	174 - Login logout failed.
BTRIEVE_STATUS_CODE_LOGIN_WRONG_URI_FORMAT	175 - Login wrong uniform resource indicator format.
BTRIEVE_STATUS_CODE_LOGIN_FILE_AND_TABLE_NOT_FOUND	176 - Login file and table not found.
BTRIEVE_STATUS_CODE_LOGIN_TABLE_NOT_IN_DATABASE	177 - Login table not in database.
BTRIEVE_STATUS_CODE_LOGIN_DIRECTORY_NOT_IN_DATABASE	178 - Login directory not in database.
BTRIEVE_STATUS_CODE_LOCK_PARM_OUTOFRANGE	1001 - Lock parameter out of range.
BTRIEVE_STATUS_CODE_MEM_ALLOCATION_ERR	1002 - Memory allocation error.
BTRIEVE_STATUS_CODE_MEM_PARM_TOO_SMALL	1003 - Memory parameter too small.
BTRIEVE_STATUS_CODE_PAGE_SIZE_PARM_OUTOFRANGE	1004 - Page size parameter out of range.
BTRIEVE_STATUS_CODE_INVALID_PREIMAGE_PARM	1005 - Invalid preimage parameter.
BTRIEVE_STATUS_CODE_PREIMAGE_BUF_PARM_OUTOFRANGE	1006 - Preimage buffer parameter out of range.
BTRIEVE_STATUS_CODE_FILES_PARM_OUTOFRANGE	1007 - Files parameter out of range.
BTRIEVE_STATUS_CODE_INVALID_INIT_PARM	1008 - Invalid initialization parameter.
BTRIEVE_STATUS_CODE_INVALID_TRANS_PARM	1009 - Invalid transaction parameter.
BTRIEVE_STATUS_CODE_ERROR_ACC_TRANS_CONTROL_FILE	1010 - Error access transaction control file.
BTRIEVE_STATUS_CODE_COMPRESSION_BUF_PARM_OUTOFRANGE	1011 - Compression buffer parameter out of range.
BTRIEVE_STATUS_CODE_INV_N_OPTION	1012 - Invalid "Maximum Number Of Files In A Transaction" option.
BTRIEVE_STATUS_CODE_TASK_LIST_FULL	1013 - Task list full.
BTRIEVE_STATUS_CODE_STOP_WARNING	1014 - Stop warning.
BTRIEVE_STATUS_CODE_POINTER_PARM_INVALID	1015 - Pointer parameter invalid.
BTRIEVE_STATUS_CODE_ALREADY_INITIALIZED	1016 - Already initialized.
BTRIEVE_STATUS_CODE_REQ_CANT_FIND_RES_DLL	1017 - Btrieve Requester can't find resource DLL.
BTRIEVE_STATUS_CODE_ALREADY_INSIDE_BTR_FUNCTION	1018 - Already inside Btrieve function.
BTRIEVE_STATUS_CODE_CALLBACK_ABORT	1019 - Callback abort.
BTRIEVE_STATUS_CODE_INTF_COMM_ERROR	1020 - Interface communications error.
BTRIEVE_STATUS_CODE_FAILED_TO_INITIALIZE	1021 - Failed to initialize.
BTRIEVE_STATUS_CODE_MKDE_SHUTTING_DOWN	1022 - MicroKernel shutting down.
BTRIEVE_STATUS_CODE_INTERNAL_ERROR	2000 - Internal error.
BTRIEVE_STATUS_CODE_INSUFFICIENT_MEM_ALLOC	2001 - Insufficient memory allocation.
BTRIEVE_STATUS_CODE_INVALID_OPTION	2002 - Invalid option.
BTRIEVE_STATUS_CODE_NO_LOCAL_ACCESS_ALLOWED	2003 - No local access allowed.
BTRIEVE_STATUS_CODE_SPX_NOT_INSTALLED	2004 - SPX not installed.
BTRIEVE_STATUS_CODE_INCORRECT_SPX_VERSION	2005 - Incorrect SPX version.
BTRIEVE_STATUS_CODE_NO_AVAIL_SPX_CONNECTION	2006 - No available SPX connection.
BTRIEVE_STATUS_CODE_INVALID_PTR_PARM	2007 - Invalid pointer parameter.
BTRIEVE_STATUS_CODE_CANT_CONNECT_TO_615	2008 - Can't connect to 615.
BTRIEVE_STATUS_CODE_CANT_LOAD_MKDE_ROUTER	2009 - Can't load MicroKernel router.
BTRIEVE_STATUS_CODE_UT_THUNK_NOT_LOADED	2010 - UT thunk not loaded.
BTRIEVE_STATUS_CODE_NO_RESOURCE_DLL	2011 - No resource DLL.
BTRIEVE_STATUS_CODE_OS_ERROR	2012 - Operating system error.
BTRIEVE_STATUS_CODE_MK_ROUTER_MEM_ERROR	3000 - MicroKernel router memory error.
BTRIEVE_STATUS_CODE_MK_NO_LOCAL_ACCESS_ALLOWED	3001 - MicroKernel no local access allowed.
BTRIEVE_STATUS_CODE_MK_NO_RESOURCE_DLL	3002 - MicroKernel no resource DLL.
BTRIEVE_STATUS_CODE_MK_INCOMPAT_COMPONENT	3003 - MicroKernel incompatible component.
BTRIEVE_STATUS_CODE_MK_TIMEOUT_ERROR	3004 - MicroKernel timeout error.
BTRIEVE_STATUS_CODE_MK_OS_ERROR	3005 - MicroKernel operating system error.
BTRIEVE_STATUS_CODE_MK_INVALID_SESSION	3006 - MicroKernel invalid session.
BTRIEVE_STATUS_CODE_MK_SERVER_NOT_FOUND	3007 - MicroKernel server not found.
BTRIEVE_STATUS_CODE_MK_INVALID_CONFIG	3008 - MicroKernel invalid configuration.
BTRIEVE_STATUS_CODE_MK_NETAPI_NOT_LOADED	3009 - MicroKernel NETAPI not loaded.
BTRIEVE_STATUS_CODE_MK_NWAPI_NOT_LOADED	3010 - MicroKernel NWAPI not loaded.
BTRIEVE_STATUS_CODE_MK_THUNK_NOT_LOADED	3011 - MicroKernel thunk not loaded.
BTRIEVE_STATUS_CODE_MK_LOCAL_NOT_LOADED	3012 - MicroKernel local not loaded.
BTRIEVE_STATUS_CODE_MK_PNSL_NOT_LOADED	3013 - MicroKernel Network Services Layer not loaded.
BTRIEVE_STATUS_CODE_MK_CANT_FIND_ENGINE	3014 - MicroKernel can't find engine.
BTRIEVE_STATUS_CODE_MK_INIT_ERROR	3015 - MicroKernel initialization error.
BTRIEVE_STATUS_CODE_MK_INTERNAL_ERROR	3016 - MicroKernel internal error.
BTRIEVE_STATUS_CODE_MK_LOCAL_MKDE_DATABUF_TOO_SMALL	3017 - MicroKernel local MicroKernel data buffer too small.
BTRIEVE_STATUS_CODE_MK_CLOSED_ERROR	3018 - MicroKernel closed error.
BTRIEVE_STATUS_CODE_MK_SEMAPHORE_ERROR	3019 - MicroKernel semaphore error.
BTRIEVE_STATUS_CODE_MK_LOADING_ERROR	3020 - MicroKernel loading error.
BTRIEVE_STATUS_CODE_MK_BAD_SRB_FORMAT	3021 - MicroKernel bad SRB format.
BTRIEVE_STATUS_CODE_MK_DATABUF_LEN_TOO_LARGE	3022 - MicroKernel data buffer length too large.
BTRIEVE_STATUS_CODE_MK_TASK_TABLE_FULL	3023 - MicroKernel task table full.
BTRIEVE_STATUS_CODE_MK_INVALID_OP_ON_REMOTE	3024 - MicroKernel invalid operation on remote.
BTRIEVE_STATUS_CODE_MK_PIDS_NOT_LOADED	3025 - MicroKernel PIDs not loaded.
BTRIEVE_STATUS_CODE_MK_BAD_PIDS	3026 - MicroKernel bad PIDs.
BTRIEVE_STATUS_CODE_MK_IDS_CONNECT_FAILURE	3027 - MicroKernel IDS connect failure.
BTRIEVE_STATUS_CODE_MK_IDS_LOGIN_FAILURE	3028 - MicroKernel IDS login failure.
BTRIEVE_STATUS_CODE_NL_FAILURE	3101 - Network layer failure.
BTRIEVE_STATUS_CODE_NL_NOT_INITIALIZED	3102 - Network layer not initialized.
BTRIEVE_STATUS_CODE_NL_NAME_NOT_FOUND	3103 - Network layer name not found.
BTRIEVE_STATUS_CODE_NL_PERMISSION_ERROR	3104 - Network layer permission error.
BTRIEVE_STATUS_CODE_NL_NO_AVAILABLE_TRANSPORT	3105 - Network layer no available transport.
BTRIEVE_STATUS_CODE_NL_CONNECTION_FAILURE	3106 - Network layer connection failure.
BTRIEVE_STATUS_CODE_NL_OUT_OF_MEMORY	3107 - Network layer out of memory.
BTRIEVE_STATUS_CODE_NL_INVALID_SESSION	3108 - Network layer invalid session.
BTRIEVE_STATUS_CODE_NL_MORE_DATA	3109 - Network layer more data.
BTRIEVE_STATUS_CODE_NL_NOT_CONNECTED	3110 - Network layer not connected.
BTRIEVE_STATUS_CODE_NL_SEND_FAILURE	3111 - Network layer send failure.
BTRIEVE_STATUS_CODE_NL_RECEIVE_FAILURE	3112 - Network layer receive failure.
BTRIEVE_STATUS_CODE_NL_INVALID_SERVER_TYPE	3113 - Network layer invalid server type.
BTRIEVE_STATUS_CODE_NL_SRT_FULL	3114 - Network layer server routing table full.
BTRIEVE_STATUS_CODE_NL_TRANSPORT_FAILURE	3115 - Network layer transport failure.
BTRIEVE_STATUS_CODE_NL_RCV_DATA_OVERFLOW	3116 - Network layer receive data overflow.
BTRIEVE_STATUS_CODE_NL_CST_FULL	3117 - Network layer CST full.
BTRIEVE_STATUS_CODE_NL_INVALID_ADDRESS_FAMILY	3118 - Network layer invalid address family.
BTRIEVE_STATUS_CODE_NL_NO_AUTH_CONTEXT_AVAILABLE	3119 - Network layer no authentication context available.
BTRIEVE_STATUS_CODE_NL_INVALID_AUTH_TYPE	3120 - Network layer invalid authentication type.
BTRIEVE_STATUS_CODE_NL_INVALID_AUTH_OBJECT	3121 - Network layer invalid authentication object.
BTRIEVE_STATUS_CODE_NL_AUTH_LEN_TOO_SMALL	3122 - Network layer authentication length too small.
BTRIEVE_STATUS_CODE_NL_INVALID_SESSION_LEVEL_PARM	3123 - Network layer invalid session level parameter.
BTRIEVE_STATUS_CODE_NL_TASK_TABLE_FULL	3124 - Network layer task table full.
BTRIEVE_STATUS_CODE_NL_NDS_NAME_RESOLUTION_ERROR	3125 - Network layer NDS name resolution error.
BTRIEVE_STATUS_CODE_NL_FILE_NAME_RESOLUTION_ERROR	3126 - Network layer file name resolution error.
BTRIEVE_STATUS_CODE_NL_IDS_SEND_FAILURE	3127 - Network layer IDS send failure.
BTRIEVE_STATUS_CODE_NL_IDS_RCV_FAILURE	3128 - Network layer IDS receive failure.
BTRIEVE_STATUS_CODE_UNKNOWN	-7 - Unknown.

btrieve_system_data_mode_t

enum btrieve_system_data_mode_t

The Btrieve system data modes.

See also

BtrieveSystemDataModeToString

Enumerator
BTRIEVE_SYSTEM_DATA_MODE_YES	Yes.
BTRIEVE_SYSTEM_DATA_MODE_NO	No.
BTRIEVE_SYSTEM_DATA_MODE_DEFAULT	Default.
BTRIEVE_SYSTEM_DATA_MODE_VERSION_2	Version 2.
BTRIEVE_SYSTEM_DATA_MODE_UNKNOWN	Unknown.

btrieve_system_field_t

enum btrieve_system_field_t

The Btrieve system fields.

See also

BtrieveSystemFieldToString

Enumerator
BTRIEVE_SYSTEM_FIELD_CREATE_TIME	Create time.
BTRIEVE_SYSTEM_FIELD_UPDATE_TIME	Update time.
BTRIEVE_SYSTEM_FIELD_UNKNOWN	Unknown.

btrieve_transaction_mode_t

enum btrieve_transaction_mode_t

The Btrieve transaction modes.

Enumerator
BTRIEVE_TRANSACTION_MODE_EXCLUSIVE	Exclusive.
BTRIEVE_TRANSACTION_MODE_CONCURRENT_WRITE_WAIT	Concurrent with write wait.
BTRIEVE_TRANSACTION_MODE_CONCURRENT_NO_WRITE_WAIT	Concurrent with no write wait.
BTRIEVE_TRANSACTION_MODE_UNKNOWN	Unknown.

btrieve_unlock_mode_t

enum btrieve_unlock_mode_t

The Btrieve unlock modes.

Enumerator
BTRIEVE_UNLOCK_MODE_SINGLE	Single.
BTRIEVE_UNLOCK_MODE_MULTIPLE	Multiple.
BTRIEVE_UNLOCK_MODE_UNKNOWN	Unknown.

btrieve_variable_length_records_mode_t

enum btrieve_variable_length_records_mode_t

The Btrieve variable length records modes.

See also

BtrieveVariableLengthRecordsModeToString

Enumerator
BTRIEVE_VARIABLE_LENGTH_RECORDS_MODE_NO	No.
BTRIEVE_VARIABLE_LENGTH_RECORDS_MODE_YES	Yes.
BTRIEVE_VARIABLE_LENGTH_RECORDS_MODE_YES_VARIABLE_ALLOCATION_TAILS	Yes with variable allocation tails.
BTRIEVE_VARIABLE_LENGTH_RECORDS_MODE_UNKNOWN	Unknown.

btrieve_version_type_t

enum btrieve_version_type_t

The Btrieve version types.

See also

BtrieveVersionTypeToString

Enumerator
BTRIEVE_VERSION_TYPE_NONE	None.
BTRIEVE_VERSION_TYPE_BTRIEVE_ENGINE	Btrieve engine.
BTRIEVE_VERSION_TYPE_WORKGROUP_ENGINE	Workgroup engine.
BTRIEVE_VERSION_TYPE_DOS_WORKSTATION	DOS workstation.
BTRIEVE_VERSION_TYPE_CLIENT_REQUESTOR	Client.
BTRIEVE_VERSION_TYPE_WINDOWS_SERVER_ENGINE	Windows server engine.
BTRIEVE_VERSION_TYPE_UNIX	UNIX.
BTRIEVE_VERSION_TYPE_CLIENT_ENGINE	Client engine.
BTRIEVE_VERSION_TYPE_UNKNOWN	Unknown.

Function Documentation

BtrieveACSModeToString()

const char * BtrieveACSModeToString ( btrieve_acs_mode_t ACSMode )

extern

Return a Btrieve ACS mode as a string.

Parameters

[in]

ACSMode

The ACS mode.

Returns

The string.

BtrieveBulkCreatePayloadAddRecord()

btrieve_status_code_t BtrieveBulkCreatePayloadAddRecord ( btrieve_bulk_create_payload_t bulkCreatePayload, const char * record, int recordLength )

extern

Add a record to a Btrieve bulk create payload.

Parameters

[in]	bulkCreatePayload	The bulk create payload. See BtrieveBulkCreatePayloadAllocate().
[in]	record	The record.
[in]	recordLength	The record length. Record length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkCreatePayloadAllocate()

btrieve_status_code_t BtrieveBulkCreatePayloadAllocate ( btrieve_bulk_create_payload_t * btrieveBulkCreatePayloadPtr )

extern

Allocate a Btrieve bulk create payload.

Parameters

[out]

btrieveBulkCreatePayloadPtr

The Btrieve bulk create payload pointer.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkCreatePayloadFree

BtrieveBulkCreatePayloadFree()

btrieve_status_code_t BtrieveBulkCreatePayloadFree ( btrieve_bulk_create_payload_t bulkCreatePayload )

extern

Free a Btrieve bulk create payload.

Parameters

[in]

bulkCreatePayload

The bulk create payload.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkCreatePayloadAllocate

BtrieveBulkCreateResultAllocate()

btrieve_status_code_t BtrieveBulkCreateResultAllocate ( btrieve_bulk_create_result_t * btrieveBulkCreateResultPtr )

extern

Allocate a Btrieve bulk create result.

Parameters

[out]

btrieveBulkCreateResultPtr

The Btrieve bulk create result pointer.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkCreateResultFree

BtrieveBulkCreateResultFree()

btrieve_status_code_t BtrieveBulkCreateResultFree ( btrieve_bulk_create_result_t bulkCreateResult )

extern

Free a Btrieve bulk create result.

Parameters

[in]

bulkCreateResult

The bulk create result.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkCreateResultAllocate

BtrieveBulkCreateResultGetLastStatusCode()

btrieve_status_code_t BtrieveBulkCreateResultGetLastStatusCode ( btrieve_bulk_create_result_t bulkCreateResult )

extern

Get last status code from a Btrieve bulk create result

Note

This function is intended for use following functions which don't return a status code.

Parameters

[in]

bulkCreateResult

The bulk create result. See BtrieveFileBulkCreate().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkCreateResultGetRecordCount()

int BtrieveBulkCreateResultGetRecordCount ( btrieve_bulk_create_result_t bulkCreateResult )

extern

Get record count from a Btrieve bulk create result

Parameters

[in]

bulkCreateResult

The bulk create result. See BtrieveFileBulkCreate().

Return values

>= 0	The record count.
-1	An error has occurred. Use BtrieveBulkCreateResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveBulkCreateResultGetRecordCursorPosition()

long long BtrieveBulkCreateResultGetRecordCursorPosition ( btrieve_bulk_create_result_t bulkCreateResult, int recordNumber )

extern

Get record cursor position from a Btrieve bulk create result

Parameters

[in]	bulkCreateResult	The bulk create result. See BtrieveFileBulkCreate().
[in]	recordNumber	The record number.

Return values

>= 0	The record cursor position .
-1	An error has occurred. Use BtrieveBulkCreateResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveBulkDeleteAttributesAddFilter()

btrieve_status_code_t BtrieveBulkDeleteAttributesAddFilter ( btrieve_bulk_delete_attributes_t bulkDeleteAttributes, btrieve_filter_t filter )

extern

Add a filter to a Btrieve bulk delete attributes.

Parameters

[in]	bulkDeleteAttributes	The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate().
[in]	filter	The filter. See BtrieveFilterAllocate().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkDeleteAttributesAllocate()

btrieve_status_code_t BtrieveBulkDeleteAttributesAllocate ( btrieve_bulk_delete_attributes_t * bulkDeleteAttributesPtr )

extern

Allocate a Btrieve bulk delete attributes.

Parameters

[out]

bulkDeleteAttributesPtr

The Btrieve bulk delete attributes pointer.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkDeleteAttributesFree

BtrieveBulkDeleteAttributesFree()

btrieve_status_code_t BtrieveBulkDeleteAttributesFree ( btrieve_bulk_delete_attributes_t bulkDeleteAttributes )

extern

Free a Btrieve bulk delete attributes.

Parameters

[in]

bulkDeleteAttributes

The bulk delete attributes.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkDeleteAttributesAllocate

BtrieveBulkDeleteAttributesSetMaximumRecordCount()

btrieve_status_code_t BtrieveBulkDeleteAttributesSetMaximumRecordCount ( btrieve_bulk_delete_attributes_t bulkDeleteAttributes, int maximumRecordCount )

extern

Set maximum record count for a Btrieve bulk delete attributes.

Parameters

[in]	bulkDeleteAttributes	The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate().
[in]	maximumRecordCount	The maximum record count.

Description

Maximum record count defaults to zero.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkDeleteAttributesSetMaximumRejectCount()

btrieve_status_code_t BtrieveBulkDeleteAttributesSetMaximumRejectCount ( btrieve_bulk_delete_attributes_t bulkDeleteAttributes, int maximumRejectCount )

extern

Set maximum reject count for a Btrieve bulk delete attributes.

Parameters

[in]	bulkDeleteAttributes	The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate().
[in]	maximumRejectCount	The maximum reject count.

Description

Maximum reject count defaults to the Zen defined value.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkDeleteAttributesSetSkipCurrentRecord()

btrieve_status_code_t BtrieveBulkDeleteAttributesSetSkipCurrentRecord ( btrieve_bulk_delete_attributes_t bulkDeleteAttributes, int skipCurrentRecord )

extern

Set skip current record for a Btrieve bulk delete attributes.

Parameters

[in]	bulkDeleteAttributes	The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate().
[in]	skipCurrentRecord	Skip current record?

Description

Skip current record is disabled by default.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkDeleteResultAllocate()

btrieve_status_code_t BtrieveBulkDeleteResultAllocate ( btrieve_bulk_delete_result_t * bulkDeleteResultPtr )

extern

Allocate a Btrieve bulk delete result.

Parameters

[out]

bulkDeleteResultPtr

The Btrieve bulk delete results pointer.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkDeleteResultFree

BtrieveBulkDeleteResultFree()

btrieve_status_code_t BtrieveBulkDeleteResultFree ( btrieve_bulk_delete_result_t bulkDeleteResult )

extern

Free a Btrieve bulk delete result.

Parameters

[in]

bulkDeleteResult

The bulk delete result.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkDeleteResultAllocate

BtrieveBulkDeleteResultGetLastStatusCode()

btrieve_status_code_t BtrieveBulkDeleteResultGetLastStatusCode ( btrieve_bulk_delete_result_t bulkDeleteResult )

extern

Get last status code from a Btrieve bulk delete result

Note

This function is intended for use following functions which don't return a status code.

Parameters

[in]

bulkDeleteResult

The bulk delete result. See BtrieveFileBulkDeleteNext() and BtrieveFileBulkDeletePrevious().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkDeleteResultGetRecordCount()

int BtrieveBulkDeleteResultGetRecordCount ( btrieve_bulk_delete_result_t bulkDeleteResult )

extern

Get record count from a Btrieve bulk delete result

Parameters

[in]

bulkDeleteResult

The bulk delete result. See BtrieveFileBulkDeleteNext() and BtrieveFileBulkDeletePrevious().

Return values

>= 0	The record count.
-1	An error has occurred. Use BtrieveBulkDeleteResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveBulkDeleteResultGetRecordCursorPosition()

long long BtrieveBulkDeleteResultGetRecordCursorPosition ( btrieve_bulk_delete_result_t bulkDeleteResult, int recordNumber )

extern

Get record cursor position from a Btrieve bulk delete result

Parameters

[in]	bulkDeleteResult	The bulk delete result. See BtrieveFileBulkDeleteNext() and BtrieveFileBulkDeletePrevious().
[in]	recordNumber	The record number.

Return values

>= 0	The record cursor position .
-1	An error has occurred. Use BtrieveBulkDeleteResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveBulkRetrieveAttributesAddField()

btrieve_status_code_t BtrieveBulkRetrieveAttributesAddField ( btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int offset, int length )

extern

Add a field to a Btrieve bulk retrieve attributes.

Parameters

[in]	bulkRetrieveAttributes	The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
[in]	offset	The offset. Offset must be less than BTRIEVE_MAXIMUM_RECORD_LENGTH.
[in]	length	The length. Length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.

Description

Bulk retrieve attributes have no fields initially. Offset plus length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. The sum of the lengths of all added fields is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkRetrieveAttributesAddFilter()

btrieve_status_code_t BtrieveBulkRetrieveAttributesAddFilter ( btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, btrieve_filter_t filter )

extern

Add a filter to a Btrieve bulk retrieve attributes.

Parameters

[in]	bulkRetrieveAttributes	The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
[in]	filter	The filter. See BtrieveFilterAllocate().

Description

Bulk retrieve attributes have no filters initially.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkRetrieveAttributesAddSystemField()

btrieve_status_code_t BtrieveBulkRetrieveAttributesAddSystemField ( btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, btrieve_system_field_t systemField )

extern

Add a system field to a Btrieve bulk retrieve attributes.

Parameters

[in]	bulkRetrieveAttributes	The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
[in]	systemField	The system field.

Description

Bulk retrieve attributes have no system fields initially. The sum of the lengths of all added fields is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkRetrieveAttributesAllocate()

btrieve_status_code_t BtrieveBulkRetrieveAttributesAllocate ( btrieve_bulk_retrieve_attributes_t * bulkRetrieveAttributesPtr )

extern

Allocate a Btrieve bulk retrieve attributes.

Parameters

[out]

bulkRetrieveAttributesPtr

The Btrieve bulk retrieve attributes pointer.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkRetrieveAttributesFree

BtrieveBulkRetrieveAttributesFree()

btrieve_status_code_t BtrieveBulkRetrieveAttributesFree ( btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes )

extern

Free a Btrieve bulk retrieve attributes.

Parameters

[in]

bulkRetrieveAttributes

The bulk retrieve attributes.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkRetrieveAttributesAllocate

BtrieveBulkRetrieveAttributesSetMaximumRecordCount()

btrieve_status_code_t BtrieveBulkRetrieveAttributesSetMaximumRecordCount ( btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int maximumRecordCount )

extern

Set maximum record count for a Btrieve bulk retrieve attributes.

Parameters

[in]	bulkRetrieveAttributes	The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
[in]	maximumRecordCount	The maximum record count.

Description

Maximum record count defaults to zero.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkRetrieveAttributesSetMaximumRejectCount()

btrieve_status_code_t BtrieveBulkRetrieveAttributesSetMaximumRejectCount ( btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int maximumRejectCount )

extern

Set maximum reject count for a Btrieve bulk retrieve attributes.

Parameters

[in]	bulkRetrieveAttributes	The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
[in]	maximumRejectCount	The maximum reject count.

Description

Maximum reject count defaults to the Zen defined value.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkRetrieveAttributesSetSkipCurrentRecord()

btrieve_status_code_t BtrieveBulkRetrieveAttributesSetSkipCurrentRecord ( btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int skipCurrentRecord )

extern

Set skip current record for a Btrieve bulk retrieve attributes.

Parameters

[in]	bulkRetrieveAttributes	The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
[in]	skipCurrentRecord	Skip current record?

Description

Skip current record is disabled by default.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkRetrieveResultAllocate()

btrieve_status_code_t BtrieveBulkRetrieveResultAllocate ( btrieve_bulk_retrieve_result_t * bulkRetrieveResultPtr )

extern

Allocate a Btrieve bulk retrieve result.

Parameters

[out]

bulkRetrieveResultPtr

The Btrieve bulk retrieve results pointer.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkRetrieveResultFree

BtrieveBulkRetrieveResultFree()

btrieve_status_code_t BtrieveBulkRetrieveResultFree ( btrieve_bulk_retrieve_result_t bulkRetrieveResult )

extern

Free a Btrieve bulk retrieve result.

Parameters

[in]

bulkRetrieveResult

The bulk retrieve result.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveBulkRetrieveResultAllocate

BtrieveBulkRetrieveResultGetLastStatusCode()

btrieve_status_code_t BtrieveBulkRetrieveResultGetLastStatusCode ( btrieve_bulk_retrieve_result_t bulkRetrieveResult )

extern

Get last status code from a Btrieve bulk retrieve result

Note

This function is intended for use following functions which don't return a status code.

Parameters

[in]

bulkRetrieveResult

The bulk retrieve result. See BtrieveFileBulkRetrieveNext() and BtrieveFileBulkRetrievePrevious().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveBulkRetrieveResultGetRecord()

int BtrieveBulkRetrieveResultGetRecord ( btrieve_bulk_retrieve_result_t bulkRetrieveResult, int recordNumber, char * record, int recordSize )

extern

Get record from a Btrieve bulk retrieve result

Note

This function doesn't return a btrieve_status_code_t. See below for more information.

Parameters

[in]	bulkRetrieveResult	The bulk retrieve result. See BtrieveFileBulkRetrieveNext() and BtrieveFileBulkRetrievePrevious().
[in]	recordNumber	The record number.
[out]	record	The record.
[in]	recordSize	The record size.

Return values

>= 0	The number of bytes read. The number of bytes read is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. See BtrieveFileRecordRetrieveChunk() for retrieving records greater than BTRIEVE_MAXIMUM_RECORD_LENGTH in length.
-1	An error has occurred. Use BtrieveBulkRetrieveResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveBulkRetrieveResultGetRecordCount()

int BtrieveBulkRetrieveResultGetRecordCount ( btrieve_bulk_retrieve_result_t bulkRetrieveResult )

extern

Get record count from a Btrieve bulk retrieve result

Parameters

[in]

bulkRetrieveResult

The bulk retrieve result. See BtrieveFileBulkRetrieveNext() and BtrieveFileBulkRetrievePrevious().

Return values

>= 0	The record count.
-1	An error has occurred. Use BtrieveBulkRetrieveResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveBulkRetrieveResultGetRecordCursorPosition()

long long BtrieveBulkRetrieveResultGetRecordCursorPosition ( btrieve_bulk_retrieve_result_t bulkRetrieveResult, int recordNumber )

extern

Get record cursor position from a Btrieve bulk retrieve result

Parameters

[in]	bulkRetrieveResult	The bulk retrieve result. See BtrieveFileBulkRetrieveNext() and BtrieveFileBulkRetrievePrevious().
[in]	recordNumber	The record number.

Return values

>= 0	The record cursor position .
-1	An error has occurred. Use BtrieveBulkRetrieveResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveBulkRetrieveResultGetRecordLength()

int BtrieveBulkRetrieveResultGetRecordLength ( btrieve_bulk_retrieve_result_t bulkRetrieveResult, int recordNumber )

extern

Get record length from a Btrieve bulk retrieve result

Parameters

[in]	bulkRetrieveResult	The bulk retrieve result. See BtrieveFileBulkRetrieveNext() and BtrieveFileBulkRetrievePrevious().
[in]	recordNumber	The record number.

Return values

>= 0	The record length.
-1	An error has occurred. Use BtrieveBulkRetrieveResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveClientAllocate()

btrieve_status_code_t BtrieveClientAllocate ( btrieve_client_t * btrieveClientPtr, int serviceAgentIdentifier, int clientIdentifier )

extern

Allocate a Btrieve client.

Parameters

[out]	btrieveClientPtr	The Btrieve client pointer.
[in]	serviceAgentIdentifier	The service agent identifier. Use 0 to automatically generate a service agent identifier based on the caller's process identifier.
[in]	clientIdentifier	The client identifier. Use 0 to automatically generate a client identifier based on the caller's thread identifier.

Snippet

   // If BtrieveClientAllocate() failed.
   if ((status = BtrieveClientAllocate(&btrieveClient, 0, 0)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveClientAllocate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveClientFree

Examples

btest.c.

BtrieveClientContinuousOperationBegin()

btrieve_status_code_t BtrieveClientContinuousOperationBegin ( btrieve_client_t client, const char * pathNames )

extern

Continuous operation begin for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	pathNames	The path names.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientContinuousOperationBeginW()

btrieve_status_code_t BtrieveClientContinuousOperationBeginW ( btrieve_client_t client, const wchar_t * pathNames )

extern

Continuous operation begin for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	pathNames	The path names.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientContinuousOperationEnd()

btrieve_status_code_t BtrieveClientContinuousOperationEnd ( btrieve_client_t client, const char * pathNames )

extern

Continuous operation end for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	pathNames	The path names.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientContinuousOperationEndW()

btrieve_status_code_t BtrieveClientContinuousOperationEndW ( btrieve_client_t client, const wchar_t * pathNames )

extern

Continuous operation end for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	pathNames	The path names.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientFileClose()

btrieve_status_code_t BtrieveClientFileClose ( btrieve_client_t client, btrieve_file_t file )

extern

File close for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	file	The file. See BtrieveClientFileOpen().

Snippet

   // If BtrieveClientFileClose() failed.
   if ((status = BtrieveClientFileClose(btrieveClient, btrieveFile)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveClientFileClose():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

Examples

btest.c.

BtrieveClientFileCreate()

btrieve_status_code_t BtrieveClientFileCreate ( btrieve_client_t client, const btrieve_file_attributes_t fileAttributes, const btrieve_index_attributes_t indexAttributes, const char * fileName, btrieve_create_mode_t createMode, btrieve_location_mode_t locationMode )

extern

File create for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	indexAttributes	The index attributes. See BtrieveIndexAttributesAllocate().
[in]	fileName	The file name.
[in]	createMode	The create mode.
[in]	locationMode	The location mode.

Snippet

   // If BtrieveClientFileCreate() failed.
   if ((status = BtrieveClientFileCreate(btrieveClient, btrieveFileAttributes, NULL, btrieveFileName, BTRIEVE_CREATE_MODE_OVERWRITE, BTRIEVE_LOCATION_MODE_NO_PREFERENCE)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveClientFileCreate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

Examples

btest.c.

BtrieveClientFileCreateW()

btrieve_status_code_t BtrieveClientFileCreateW ( btrieve_client_t client, const btrieve_file_attributes_t fileAttributes, const btrieve_index_attributes_t indexAttributes, const wchar_t * fileName, btrieve_create_mode_t createMode, btrieve_location_mode_t locationMode )

extern

File create for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	indexAttributes	The index attributes. See BtrieveIndexAttributesAllocate().
[in]	fileName	The file name.
[in]	createMode	The create mode.
[in]	locationMode	The location mode.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientFileDelete()

btrieve_status_code_t BtrieveClientFileDelete ( btrieve_client_t client, const char * fileName )

extern

File delete for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	fileName	The file name.

Snippet

   // If BtrieveClientFileDelete() failed.
   if ((status = BtrieveClientFileDelete(btrieveClient, btrieveFileName)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveClientFileDelete():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

Examples

btest.c.

BtrieveClientFileDeleteW()

btrieve_status_code_t BtrieveClientFileDeleteW ( btrieve_client_t client, const wchar_t * fileName )

extern

File delete for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	fileName	The file name.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientFileOpen()

btrieve_status_code_t BtrieveClientFileOpen ( btrieve_client_t client, btrieve_file_t * btrieveFilePtr, const char * fileName, const char * ownerName, btrieve_open_mode_t openMode, btrieve_location_mode_t locationMode )

extern

File open for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[out]	btrieveFilePtr	The Btrieve file pointer.
[in]	fileName	The file name.
[in]	ownerName	The owner name.
[in]	openMode	The open mode.
[in]	locationMode	The location mode.

Snippet

   // If BtrieveClientFileOpen() failed.
   if ((status = BtrieveClientFileOpen(btrieveClient, btrieveFile, btrieveFileName, NULL, BTRIEVE_OPEN_MODE_NORMAL, BTRIEVE_LOCATION_MODE_NO_PREFERENCE)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveClientFileOpen():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveClientFileClose

Examples

btest.c.

BtrieveClientFileOpenW()

btrieve_status_code_t BtrieveClientFileOpenW ( btrieve_client_t client, btrieve_file_t * btrieveFilePtr, const wchar_t * fileName, const char * ownerName, btrieve_open_mode_t openMode, btrieve_location_mode_t locationMode )

extern

File open for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[out]	btrieveFilePtr	The Btrieve file pointer.
[in]	fileName	The file name.
[in]	ownerName	The owner name.
[in]	openMode	The open mode.
[in]	locationMode	The location mode.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveClientFileClose

BtrieveClientFileRename()

btrieve_status_code_t BtrieveClientFileRename ( btrieve_client_t client, const char * existingFileName, const char * newFileName )

extern

File rename for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	existingFileName	The existing file name.
[in]	newFileName	The new file name.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientFileRenameW()

btrieve_status_code_t BtrieveClientFileRenameW ( btrieve_client_t client, const wchar_t * existingFileName, const wchar_t * newFileName )

extern

File rename for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	existingFileName	The existing file name.
[in]	newFileName	The new file name.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientFree()

btrieve_status_code_t BtrieveClientFree ( btrieve_client_t client )

extern

Free a Btrieve client.

Parameters

[in]

client

The client.

Snippet

   if (btrieveClient != NULL)
   {
      BtrieveClientFree(btrieveClient);
      btrieveClient = NULL;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveClientAllocate

Examples

btest.c.

BtrieveClientGetClientIdentifier()

int BtrieveClientGetClientIdentifier ( btrieve_client_t client )

extern

Get client identifier from a Btrieve client

Parameters

[in]

client

The client. See BtrieveClientAllocate().

Return values

>= 0	The client identifier.
-1	An error has occurred. Use BtrieveClientGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveClientGetCurrentDirectory()

btrieve_status_code_t BtrieveClientGetCurrentDirectory ( btrieve_client_t client, btrieve_disk_drive_t diskDrive, char * currentDirectory, int currentDirectorySize )

extern

Get current directory from a Btrieve client

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	diskDrive	The disk drive. Non-Windows based systems must use BTRIEVE_DISK_DRIVE_DEFAULT.
[out]	currentDirectory	The current directory.
[in]	currentDirectorySize	The current directory size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientGetCurrentDirectoryW()

btrieve_status_code_t BtrieveClientGetCurrentDirectoryW ( btrieve_client_t client, btrieve_disk_drive_t diskDrive, wchar_t * currentDirectory, int currentDirectorySize )

extern

Get current directory from a Btrieve client

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	diskDrive	The disk drive. Non-Windows based systems must use BTRIEVE_DISK_DRIVE_DEFAULT.
[in]	currentDirectory	The current directory.
[in]	currentDirectorySize	The current directory size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientGetLastStatusCode()

btrieve_status_code_t BtrieveClientGetLastStatusCode ( btrieve_client_t client )

extern

Get last status code from a Btrieve client

Note

This function is intended for use following functions which don't return a status code.

Parameters

[in]

client

The client. See BtrieveClientAllocate().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientGetServiceAgentIdentifier()

int BtrieveClientGetServiceAgentIdentifier ( btrieve_client_t client )

extern

Get service agent identifier from a Btrieve client

Parameters

[in]

client

The client. See BtrieveClientAllocate().

Return values

>= 0	The service agent identifier.
-1	An error has occurred. Use BtrieveClientGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveClientGetVersion()

btrieve_status_code_t BtrieveClientGetVersion ( btrieve_client_t client, btrieve_version_t version, btrieve_file_t file )

extern

Get version from a Btrieve client

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[out]	version	The version. See BtrieveVersionAllocate().
[in]	file	The file. See BtrieveClientFileOpen().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientLogin()

btrieve_status_code_t BtrieveClientLogin ( btrieve_client_t client, const char * databaseURI )

extern

Login for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	databaseURI	The database URI.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientLoginW()

btrieve_status_code_t BtrieveClientLoginW ( btrieve_client_t client, const wchar_t * databaseURI )

extern

Login for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	databaseURI	The database URI.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientLogout()

btrieve_status_code_t BtrieveClientLogout ( btrieve_client_t client, const char * databaseURI )

extern

Logout for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	databaseURI	The database URI.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientLogoutW()

btrieve_status_code_t BtrieveClientLogoutW ( btrieve_client_t client, const wchar_t * databaseURI )

extern

Logout for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	databaseURI	The database URI.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientReset()

btrieve_status_code_t BtrieveClientReset ( btrieve_client_t client )

extern

Reset for a Btrieve client.

Parameters

[in]

client

The client. See BtrieveClientAllocate().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientSetCurrentDirectory()

btrieve_status_code_t BtrieveClientSetCurrentDirectory ( btrieve_client_t client, const char * currentDirectory )

extern

Set current directory for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	currentDirectory	The current directory.

Description

Current directory defaults to the current working directory.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientSetCurrentDirectoryW()

btrieve_status_code_t BtrieveClientSetCurrentDirectoryW ( btrieve_client_t client, const wchar_t * currentDirectory )

extern

Set current directory for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	currentDirectory	The current directory.

Description

Current directory defaults to the current working directory.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientStop()

btrieve_status_code_t BtrieveClientStop ( btrieve_client_t client )

extern

Stop for a Btrieve client.

Parameters

[in]

client

The client. See BtrieveClientAllocate().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientTransactionAbort()

btrieve_status_code_t BtrieveClientTransactionAbort ( btrieve_client_t client )

extern

Transaction abort for a Btrieve client.

Parameters

[in]

client

The client. See BtrieveClientAllocate().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientTransactionBegin()

btrieve_status_code_t BtrieveClientTransactionBegin ( btrieve_client_t client, btrieve_transaction_mode_t transactionMode, btrieve_lock_mode_t lockMode )

extern

Transaction begin for a Btrieve client.

Parameters

[in]	client	The client. See BtrieveClientAllocate().
[in]	transactionMode	The transaction mode.
[in]	lockMode	The lock mode.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveClientTransactionEnd()

btrieve_status_code_t BtrieveClientTransactionEnd ( btrieve_client_t client )

extern

Transaction end for a Btrieve client.

Parameters

[in]

client

The client. See BtrieveClientAllocate().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveDataTypeToString()

const char * BtrieveDataTypeToString ( btrieve_data_type_t dataType )

extern

Return a Btrieve data type as a string.

Parameters

[in]

dataType

The data type.

Returns

The string.

BtrieveDuplicateModeToString()

const char * BtrieveDuplicateModeToString ( btrieve_duplicate_mode_t duplicateMode )

extern

Return a Btrieve duplicate mode as a string.

Parameters

[in]

duplicateMode

The duplicate mode.

Returns

The string.

BtrieveEncryptionTypeToString()

const char * BtrieveEncryptionTypeToString ( btrieve_encrypt_type_t encryptType )

extern

Return a Btrieve encryption type as a string.

Parameters

[in]

encryptType

The encrypt type.

Returns

The string.

BtrieveFileAttributesAllocate()

btrieve_status_code_t BtrieveFileAttributesAllocate ( btrieve_file_attributes_t * btrieveFileAttributesPtr )

extern

Allocate a Btrieve file attributes.

Parameters

[out]

btrieveFileAttributesPtr

The Btrieve file attributes pointer.

Snippet

   // If BtrieveFileAttributesAllocate() failed.
   if ((status = BtrieveFileAttributesAllocate(&btrieveFileAttributes)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveFileAttributesAllocate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveFileAttributesFree

Examples

btest.c.

BtrieveFileAttributesFree()

btrieve_status_code_t BtrieveFileAttributesFree ( btrieve_file_attributes_t fileAttributes )

extern

Free a Btrieve file attributes.

Parameters

[in]

fileAttributes

The file attributes.

Snippet

   if (btrieveFileAttributes != NULL)
   {
      BtrieveFileAttributesFree(btrieveFileAttributes);
      btrieveFileAttributes = NULL;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveFileAttributesAllocate

Examples

btest.c.

BtrieveFileAttributesSetBalancedIndexes()

btrieve_status_code_t BtrieveFileAttributesSetBalancedIndexes ( btrieve_file_attributes_t fileAttributes, int enableBalancedIndexes )

extern

Set balanced indexes for a Btrieve file attributes.

Parameters

[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	enableBalancedIndexes	Enable balanced indexes?

Description

Balanced indexes are disabled by default.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileAttributesSetFileVersion()

btrieve_status_code_t BtrieveFileAttributesSetFileVersion ( btrieve_file_attributes_t fileAttributes, btrieve_file_version_t fileVersion )

extern

Set file version for a Btrieve file attributes.

Parameters

[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	fileVersion	The file version.

Description

File version defaults to BTRIEVE_FILE_VERSION_DEFAULT. A file version of BTRIEVE_FILE_VERSION_6_0 is mapped to BTRIEVE_FILE_VERSION_6_1.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileAttributesSetFixedRecordLength()

btrieve_status_code_t BtrieveFileAttributesSetFixedRecordLength ( btrieve_file_attributes_t fileAttributes, int fixedRecordLength )

extern

Set fixed record length for a Btrieve file attributes.

Parameters

[in]

fileAttributes

The file attributes. See BtrieveFileAttributesAllocate().

Snippet

Parameters

[in]

fixedRecordLength

The fixed record length. The fixed record length must be between 1 and BTRIEVE_MAXIMUM_RECORD_LENGTH, inclusive.

Description

Fixed record length defaults to zero.

   // If BtrieveFileAttributesSetFixedRecordLength() failed.
   if ((status = BtrieveFileAttributesSetFixedRecordLength(btrieveFileAttributes, sizeof(record))) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveFileAttributesSetFixedRecordLength():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

Examples

btest.c.

BtrieveFileAttributesSetFreeSpaceThreshold()

btrieve_status_code_t BtrieveFileAttributesSetFreeSpaceThreshold ( btrieve_file_attributes_t fileAttributes, btrieve_free_space_threshold_t freeSpaceThreshold )

extern

Set free space threshold for a Btrieve file attributes.

Parameters

[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	freeSpaceThreshold	The free space threshold.

Description

Free space threshold defaults to BTRIEVE_FREE_SPACE_THRESHOLD_DEFAULT. The free space threshold setting is ignored unless variable length records are enabled.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileAttributesSetKeyOnly()

btrieve_status_code_t BtrieveFileAttributesSetKeyOnly ( btrieve_file_attributes_t fileAttributes, int enableKeyOnly )

extern

Set key only for a Btrieve file attributes.

Parameters

[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	enableKeyOnly	Enable key only?

Description

Key only is disabled by default.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileAttributesSetPageSize()

btrieve_status_code_t BtrieveFileAttributesSetPageSize ( btrieve_file_attributes_t fileAttributes, btrieve_page_size_t pageSize, int enablePageCompression )

extern

Set page size for a Btrieve file attributes.

Parameters

[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	pageSize	The page size.
[in]	enablePageCompression	Enable page compression?

Description

Page size defaults to BTRIEVE_PAGE_SIZE_4096. Page compression is disabled by default and requires file version BTRIEVE_FILE_VERSION_9_5 or greater. Not all page sizes are valid for all file versions. Pages sizes greater than 4096 require file version BTRIEVE_FILE_VERSION_9_0 or greater. Pages sizes which are unsupported for a particular file version will be rounded up to the next supported size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileAttributesSetPreallocatedPageCount()

btrieve_status_code_t BtrieveFileAttributesSetPreallocatedPageCount ( btrieve_file_attributes_t fileAttributes, int preallocatedPageCount )

extern

Set preallocated page count for a Btrieve file attributes.

Parameters

[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	preallocatedPageCount	The preallocated page count.

Description

Preallocated page count defaults to zero.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileAttributesSetRecordCompressionMode()

btrieve_status_code_t BtrieveFileAttributesSetRecordCompressionMode ( btrieve_file_attributes_t fileAttributes, btrieve_record_compression_mode_t recordCompressionMode )

extern

Set record compression mode for a Btrieve file attributes.

Parameters

[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	recordCompressionMode	The record compression mode.

Description

Record compression defaults to BTRIEVE_RECORD_COMPRESSION_MODE_NONE. Compression mode blank truncation requires variable length records be enabled.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileAttributesSetReservedDuplicatePointerCount()

btrieve_status_code_t BtrieveFileAttributesSetReservedDuplicatePointerCount ( btrieve_file_attributes_t fileAttributes, int reservedDuplicatePointerCount )

extern

Set reserved duplicate pointer count for a Btrieve file attributes.

Parameters

[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	reservedDuplicatePointerCount	The reserved duplicate pointer count.

Description

Reserved duplicate pointer count defaults to zero. The maximum reserved duplicate pointer count may be less than 119 depending on file version and page size. For example, a file version of BTRIEVE_FILE_VERSION_9_0 and page size of BTRIEVE_PAGE_SIZE_3584 allows for a maximum reserved duplicate pointer count of 54.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileAttributesSetSystemDataMode()

btrieve_status_code_t BtrieveFileAttributesSetSystemDataMode ( btrieve_file_attributes_t fileAttributes, btrieve_system_data_mode_t systemDataMode )

extern

Set system data mode for a Btrieve file attributes.

Parameters

[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	systemDataMode	The system data mode.

Description

System data mode defaults to BTRIEVE_SYSTEM_DATA_MODE_DEFAULT.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileAttributesSetVariableLengthRecordsMode()

btrieve_status_code_t BtrieveFileAttributesSetVariableLengthRecordsMode ( btrieve_file_attributes_t fileAttributes, btrieve_variable_length_records_mode_t variableLengthRecordsMode )

extern

Set variable length records mode for a Btrieve file attributes.

Parameters

[in]	fileAttributes	The file attributes. See BtrieveFileAttributesAllocate().
[in]	variableLengthRecordsMode	The variable length records mode.

Description

Variable length records mode defaults to BTRIEVE_VARIABLE_LENGTH_RECORDS_MODE_NO.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileBulkCreate()

btrieve_status_code_t BtrieveFileBulkCreate ( btrieve_file_t file, const btrieve_bulk_create_payload_t bulkCreatePayload, btrieve_bulk_create_result_t bulkCreateResult )

extern

Bulk create for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	bulkCreatePayload	The bulk create payload. See BtrieveBulkCreatePayloadAllocate().
[out]	bulkCreateResult	The bulk create result. See BtrieveBulkCreateResultAllocate().

Cursor

The cursor is unaffected.

Current Offset

The current offset is unaffected.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileBulkDeleteNext()

btrieve_status_code_t BtrieveFileBulkDeleteNext ( btrieve_file_t file, const btrieve_bulk_delete_attributes_t bulkDeleteAttributes, btrieve_bulk_delete_result_t bulkDeleteResult )

extern

Bulk delete next for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	bulkDeleteAttributes	The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate().
[out]	bulkDeleteResult	The bulk delete result. See BtrieveBulkDeleteResultAllocate().

Cursor

The cursor must be established. The cursor is traversed forward to the last record examined.

Current Offset

The current offset is destroyed.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileBulkDeletePrevious()

btrieve_status_code_t BtrieveFileBulkDeletePrevious ( btrieve_file_t file, const btrieve_bulk_delete_attributes_t bulkDeleteAttributes, btrieve_bulk_delete_result_t bulkDeleteResult )

extern

Bulk delete previous for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	bulkDeleteAttributes	The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate().
[out]	bulkDeleteResult	The bulk delete result. See BtrieveBulkDeleteResultAllocate().

Cursor

The cursor must be established. The cursor is traversed backwards to the last record examined.

Current Offset

The current offset is destroyed.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileBulkRetrieveNext()

btrieve_status_code_t BtrieveFileBulkRetrieveNext ( btrieve_file_t file, const btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, btrieve_bulk_retrieve_result_t bulkRetrieveResult, btrieve_lock_mode_t lockMode )

extern

Bulk retrieve next for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	bulkRetrieveAttributes	The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
[out]	bulkRetrieveResult	The bulk retrieve result. See BtrieveBulkRetrieveResultAllocate().
[in]	lockMode	The lock mode.

Cursor

The cursor must be established. The cursor is traversed forward to the last record examined.

Current Offset

The current offset is destroyed.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileBulkRetrievePrevious()

btrieve_status_code_t BtrieveFileBulkRetrievePrevious ( btrieve_file_t file, const btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, btrieve_bulk_retrieve_result_t bulkRetrieveResult, btrieve_lock_mode_t lockMode )

extern

Bulk retrieve previous for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	bulkRetrieveAttributes	The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
[out]	bulkRetrieveResult	The bulk retrieve result. See BtrieveBulkRetrieveResultAllocate().
[in]	lockMode	The lock mode.

Cursor

The cursor must be established. The cursor is traversed backwards to the last record examined.

Current Offset

The current offset is destroyed.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileGetCursorPosition()

long long BtrieveFileGetCursorPosition ( btrieve_file_t file )

extern

Get cursor position from a Btrieve file

Parameters

[in]

file

The file. See BtrieveClientFileOpen().

Cursor

The cursor is unaffected but must be established.

Current Offset

The current offset is unaffected.

Return values

>= 0	The cursor position.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileGetInformation()

btrieve_status_code_t BtrieveFileGetInformation ( btrieve_file_t file, btrieve_file_information_t fileInformation )

extern

Get information from a Btrieve file

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[out]	fileInformation	The file information. See BtrieveFileInformationAllocate().

Cursor

The cursor is unaffected.

Current Offset

The current offset is unaffected.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileGetLastStatusCode()

btrieve_status_code_t BtrieveFileGetLastStatusCode ( btrieve_file_t file )

extern

Get last status code from a Btrieve file

Note

This function is intended for use following functions which don't return a status code.

Parameters

[in]

file

The file. See BtrieveClientFileOpen().

Snippet

   if (BtrieveFileRecordRetrieve(btrieveFile, BTRIEVE_COMPARISON_EQUAL, BTRIEVE_INDEX_1, (char *)key, sizeof(&key), (char *)&record, sizeof(record), BTRIEVE_LOCK_MODE_NONE) != sizeof(record))
   {
      status = BtrieveFileGetLastStatusCode(btrieveFile);
      printf("Error: BtrieveFileRecordRetrieve():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Cursor

The cursor is unaffected.

Current Offset

The current offset is unaffected.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

Examples

btest.c.

BtrieveFileGetNumerator()

int BtrieveFileGetNumerator ( btrieve_file_t file, btrieve_index_t index, const char * key, int keyLength, long long cursorPosition, int denominator )

extern

Get numerator from a Btrieve file

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	index	The index.
[in]	key	The key.
[in]	keyLength	The key length.
[in]	cursorPosition	The cursor position.
[in]	denominator	The denominator.

Cursor

The cursor is unaffected.

Current Offset

The current offset is unaffected.

Return values

>= 0	The numerator.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileGetPercentage()

int BtrieveFileGetPercentage ( btrieve_file_t file, btrieve_index_t index, const char * key, int keyLength, long long cursorPosition )

extern

Get percentage from a Btrieve file

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	index	The index.
[in]	key	The key.
[in]	keyLength	The key length.
[in]	cursorPosition	The cursor position.

Cursor

The cursor is unaffected.

Current Offset

The current offset is unaffected.

Return values

>= 0	The percentage.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileGetRecordCreateTime()

long long BtrieveFileGetRecordCreateTime ( btrieve_file_t file )

extern

Get record create time from a Btrieve file.

Parameters

[in]

file

The file. See BtrieveClientFileOpen().

Cursor

The cursor is unaffected but must be established.

Current Offset

The current offset is unaffected.

Return values

> 0	The record create time as a Btrieve timestamp.
= 0	The record create time is unavailable. Ensure the file was created with system data. See BtrieveFileAttributesSetSystemDataMode().
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

See also

BtrieveTimestampToUnixEpochMicroseconds

BtrieveFileGetRecordUpdateTime()

long long BtrieveFileGetRecordUpdateTime ( btrieve_file_t file )

extern

Get record update time from a Btrieve file.

Parameters

[in]

file

The file. See BtrieveClientFileOpen().

Cursor

The cursor is unaffected but must be established.

Current Offset

The current offset is unaffected.

Return values

> 0	The record update time as a Btrieve timestamp.
= 0	The record update time is unavailable. Ensure the file was created with system data version 2. See BtrieveFileAttributesSetSystemDataMode().
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

See also

BtrieveTimestampToUnixEpochMicroseconds

BtrieveFileIndexCreate()

btrieve_status_code_t BtrieveFileIndexCreate ( btrieve_file_t file, const btrieve_index_attributes_t indexAttributes )

extern

Index create for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	indexAttributes	The index attributes. See BtrieveIndexAttributesAllocate().

Snippet

   // If BtrieveFileIndexCreate() failed.
   if ((status = BtrieveFileIndexCreate(btrieveFile, btrieveIndexAttributes)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveFileIndexCreate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Cursor

The cursor is unaffected.

Current Offset

The current offset is unaffected.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

Examples

btest.c.

BtrieveFileIndexDrop()

btrieve_status_code_t BtrieveFileIndexDrop ( btrieve_file_t file, btrieve_index_t index )

extern

Index drop for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	index	The index.

Cursor

If the cursor index is dropped the cursor is destroyed. Otherwise, the cursor is unaffected.

Current Offset

The current offset is unaffected.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileInformationAllocate()

btrieve_status_code_t BtrieveFileInformationAllocate ( btrieve_file_information_t * btrieveFileInformationPtr )

extern

Allocate a Btrieve file information.

Parameters

[out]

btrieveFileInformationPtr

The Btrieve file information pointer.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveFileInformationFree

BtrieveFileInformationFree()

btrieve_status_code_t BtrieveFileInformationFree ( btrieve_file_information_t fileInformation )

extern

Free a Btrieve file information.

Parameters

[in]

fileInformation

The file information.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveFileInformationAllocate

BtrieveFileInformationGetBalancedIndexes()

int BtrieveFileInformationGetBalancedIndexes ( btrieve_file_information_t fileInformation )

extern

Get balanced indexes from a Btrieve file information

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Balanced indexes enabled.
0	Balanced indexes disabled.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetClientTransactions()

int BtrieveFileInformationGetClientTransactions ( btrieve_file_information_t fileInformation )

extern

Get client transactions from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Client transactions are active.
0	Client transactions are not active.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetContinuousOperation()

int BtrieveFileInformationGetContinuousOperation ( btrieve_file_information_t fileInformation )

extern

Get continuous operation from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	The file is in continuous operation.
0	The file isn't in continuous operation.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetDuplicateRecordConflictCursorPosition()

long long BtrieveFileInformationGetDuplicateRecordConflictCursorPosition ( btrieve_file_information_t fileInformation )

extern

Get duplicate record conflict cursor position from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The duplicate record conflict cursor position.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetDuplicateRecordConflictIndex()

btrieve_index_t BtrieveFileInformationGetDuplicateRecordConflictIndex ( btrieve_file_information_t fileInformation )

extern

Get duplicate record conflict index from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_INDEX_UNKNOWN	The duplicate record conflict index.
= BTRIEVE_INDEX_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetEncryptionType()

btrieve_encrypt_type_t BtrieveFileInformationGetEncryptionType ( btrieve_file_information_t fileInformation )

extern

Get encryption type from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_ENCRYPT_TYPE_UNKNOWN	The encryption type.
= BTRIEVE_ENCRYPT_TYPE_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetExplicitLocks()

int BtrieveFileInformationGetExplicitLocks ( btrieve_file_information_t fileInformation )

extern

Get explicit locks from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Explicit locks are active.
0	Explicit locks are not active.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetFileVersion()

btrieve_file_version_t BtrieveFileInformationGetFileVersion ( btrieve_file_information_t fileInformation )

extern

Get file version from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_FILE_VERSION_UNKNOWN	The file version.
= BTRIEVE_FILE_VERSION_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetFixedRecordLength()

int BtrieveFileInformationGetFixedRecordLength ( btrieve_file_information_t fileInformation )

extern

Get fixed record length from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The fixed record length.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetFreeSpaceThreshold()

btrieve_free_space_threshold_t BtrieveFileInformationGetFreeSpaceThreshold ( btrieve_file_information_t fileInformation )

extern

Get free space threshold from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_FREE_SPACE_THRESHOLD_UNKNOWN	The free space threshold.
= BTRIEVE_FREE_SPACE_THRESHOLD_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetGatewayMajorVersion()

int BtrieveFileInformationGetGatewayMajorVersion ( btrieve_file_information_t fileInformation )

extern

Get gateway major version from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The gateway major version.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetGatewayMinorVersion()

int BtrieveFileInformationGetGatewayMinorVersion ( btrieve_file_information_t fileInformation )

extern

Get gateway minor version from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The gateway minor version.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetGatewayName()

btrieve_status_code_t BtrieveFileInformationGetGatewayName ( btrieve_file_information_t fileInformation, char * name, int nameSize )

extern

Get gateway name from a Btrieve file information

Parameters

[in]	fileInformation	The file information. See BtrieveFileGetInformation().
[out]	name	The name.
[in]	nameSize	The name size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileInformationGetGatewayPatchLevel()

int BtrieveFileInformationGetGatewayPatchLevel ( btrieve_file_information_t fileInformation )

extern

Get gateway patch level from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The gateway patch level.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetGatewayPlatform()

int BtrieveFileInformationGetGatewayPlatform ( btrieve_file_information_t fileInformation )

extern

Get gateway platform from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The gateway platform.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetHandleCount()

int BtrieveFileInformationGetHandleCount ( btrieve_file_information_t fileInformation )

extern

Get handle count from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The handle count.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetIdentifier()

int BtrieveFileInformationGetIdentifier ( btrieve_file_information_t fileInformation )

extern

Get identifier from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The identifier.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetIndexCount()

int BtrieveFileInformationGetIndexCount ( btrieve_file_information_t fileInformation )

extern

Get index count from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The index count.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetKeyOnly()

int BtrieveFileInformationGetKeyOnly ( btrieve_file_information_t fileInformation )

extern

Get key only from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	File is key only.
0	File isn't key only.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetKeySegment()

btrieve_status_code_t BtrieveFileInformationGetKeySegment ( btrieve_file_information_t fileInformation, btrieve_key_segment_t keySegment, int keySegmentNumber )

extern

Get key segment from a Btrieve file information

Parameters

[in]	fileInformation	The file information. See BtrieveFileGetInformation().
[out]	keySegment	The key segment. See BtrieveKeySegmentAllocate().
[in]	keySegmentNumber	The key segment number.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileInformationGetLastStatusCode()

btrieve_status_code_t BtrieveFileInformationGetLastStatusCode ( btrieve_file_information_t fileInformation )

extern

Get last status code from a Btrieve file information

Note

This function is intended for use following functions which don't return a status code.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileInformationGetLockOwnerClientIdentifier()

int BtrieveFileInformationGetLockOwnerClientIdentifier ( btrieve_file_information_t fileInformation )

extern

Get lock owner client identifier from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The lock owner client identifier.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerExplicitLockMode()

btrieve_lock_mode_t BtrieveFileInformationGetLockOwnerExplicitLockMode ( btrieve_file_information_t fileInformation )

extern

Get lock owner explicit lock mode from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_LOCK_MODE_UNKNOWN	The lock owner explicit lock mode.
= BTRIEVE_LOCK_MODE_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerFileLock()

int BtrieveFileInformationGetLockOwnerFileLock ( btrieve_file_information_t fileInformation )

extern

Get lock owner file lock from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	The lock owner has a file lock.
0	The lock owner doesn't have a file lock.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerImplicitLock()

int BtrieveFileInformationGetLockOwnerImplicitLock ( btrieve_file_information_t fileInformation )

extern

Get lock owner implicit lock from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	The lock owner has an implicit lock.
0	The lock owner doesn't have an implicit lock.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerIndex()

btrieve_index_t BtrieveFileInformationGetLockOwnerIndex ( btrieve_file_information_t fileInformation )

extern

Get lock owner index from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_INDEX_UNKNOWN	The lock owner index.
= BTRIEVE_INDEX_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerName()

btrieve_status_code_t BtrieveFileInformationGetLockOwnerName ( btrieve_file_information_t fileInformation, char * name, int nameSize )

extern

Get lock owner name from a Btrieve file information

Parameters

[in]	fileInformation	The file information. See BtrieveFileGetInformation().
[out]	name	The name.
[in]	nameSize	The name size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileInformationGetLockOwnerPageLockType()

btrieve_page_lock_type_t BtrieveFileInformationGetLockOwnerPageLockType ( btrieve_file_information_t fileInformation )

extern

Get lock owner page lock type from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_PAGE_LOCK_TYPE_UNKNOWN	The lock owner page lock type.
= BTRIEVE_PAGE_LOCK_TYPE_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerRecordLock()

int BtrieveFileInformationGetLockOwnerRecordLock ( btrieve_file_information_t fileInformation )

extern

Get lock owner record lock from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	The lock owner has a record lock.
0	The lock owner doesn't have a record lock.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerSameProcess()

int BtrieveFileInformationGetLockOwnerSameProcess ( btrieve_file_information_t fileInformation )

extern

Get lock owner same process from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	The lock owner is the same process.
0	The lock owner isn't the same process.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerServiceAgentIdentifier()

int BtrieveFileInformationGetLockOwnerServiceAgentIdentifier ( btrieve_file_information_t fileInformation )

extern

Get lock owner service agent identifier from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The lock owner service agent identifier.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerTimeInTransaction()

int BtrieveFileInformationGetLockOwnerTimeInTransaction ( btrieve_file_information_t fileInformation )

extern

Get lock owner time in transaction from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The lock owner time in transaction.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerTransactionLevel()

int BtrieveFileInformationGetLockOwnerTransactionLevel ( btrieve_file_information_t fileInformation )

extern

Get lock owner transaction level from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The lock owner transaction level.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerWriteHold()

int BtrieveFileInformationGetLockOwnerWriteHold ( btrieve_file_information_t fileInformation )

extern

Get lock owner write hold from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	The lock owner has a write hold.
0	The lock owner doesn't have a write hold.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLockOwnerWriteNoWait()

int BtrieveFileInformationGetLockOwnerWriteNoWait ( btrieve_file_information_t fileInformation )

extern

Get lock owner write no wait from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	The lock owner is performing a write with no wait.
0	The lock owner isn't performing a write with no wait.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLoggable()

int BtrieveFileInformationGetLoggable ( btrieve_file_information_t fileInformation )

extern

Get loggable from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	File is loggable.
0	File isn't loggable.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetLogIndex()

btrieve_index_t BtrieveFileInformationGetLogIndex ( btrieve_file_information_t fileInformation )

extern

Get log index from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_INDEX_UNKNOWN	The log index.
= BTRIEVE_INDEX_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetOpenTimestamp()

int BtrieveFileInformationGetOpenTimestamp ( btrieve_file_information_t fileInformation )

extern

Get open timestamp from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The open timestamp.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetOwnerMode()

btrieve_owner_mode_t BtrieveFileInformationGetOwnerMode ( btrieve_file_information_t fileInformation )

extern

Get owner mode from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_OWNER_MODE_UNKNOWN	The owner mode.
= BTRIEVE_OWNER_MODE_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetPageCompression()

int BtrieveFileInformationGetPageCompression ( btrieve_file_information_t fileInformation )

extern

Get page compression from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Page compression enabled.
0	Page compression disabled.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetPagePreallocation()

int BtrieveFileInformationGetPagePreallocation ( btrieve_file_information_t fileInformation )

extern

Get page preallocation from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Page preallocation enabled.
0	Page preallocation disabled.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetPageSize()

btrieve_page_size_t BtrieveFileInformationGetPageSize ( btrieve_file_information_t fileInformation )

extern

Get page size from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_PAGE_SIZE_UNKNOWN	The page size.
= BTRIEVE_PAGE_SIZE_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetReadOnly()

int BtrieveFileInformationGetReadOnly ( btrieve_file_information_t fileInformation )

extern

Get read only from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	The file is opened read only.
0	The file isn't opened read only.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetRecordCompressionMode()

btrieve_record_compression_mode_t BtrieveFileInformationGetRecordCompressionMode ( btrieve_file_information_t fileInformation )

extern

Get record compression mode from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_RECORD_COMPRESSION_MODE_UNKNOWN	The record compression mode.
= BTRIEVE_RECORD_COMPRESSION_MODE_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

See also

BtrieveRecordCompressionModeToString

BtrieveFileInformationGetRecordCount()

long long BtrieveFileInformationGetRecordCount ( btrieve_file_information_t fileInformation )

extern

Get record count from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The record count.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetReferentialIntegrityConstraints()

int BtrieveFileInformationGetReferentialIntegrityConstraints ( btrieve_file_information_t fileInformation )

extern

Get referential integrity constraints from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	The file has referential integrity constraints.
0	The file doesn't have referential integrity constraints.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetReferentialIntegrityCursorPosition()

long long BtrieveFileInformationGetReferentialIntegrityCursorPosition ( btrieve_file_information_t fileInformation )

extern

Get referential integrity cursor position from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The referential integrity cursor position.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetReferentialIntegrityFileName()

btrieve_status_code_t BtrieveFileInformationGetReferentialIntegrityFileName ( btrieve_file_information_t fileInformation, char * name, int nameSize )

extern

Get referential integrity file name from a Btrieve file information

Parameters

[in]	fileInformation	The file information. See BtrieveFileGetInformation().
[out]	name	The name.
[in]	nameSize	The name size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileInformationGetReferentialIntegrityOperationCode()

int BtrieveFileInformationGetReferentialIntegrityOperationCode ( btrieve_file_information_t fileInformation )

extern

Get referential integrity operation code from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The referential integrity operation code.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseAuthenticationByDatabase()

int BtrieveFileInformationGetSecurityCurrentDatabaseAuthenticationByDatabase ( btrieve_file_information_t fileInformation )

extern

Get security current database authentication by database from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database authentication by database.
0	Security current database not authentication by database.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseAuthorizationByDatabase()

int BtrieveFileInformationGetSecurityCurrentDatabaseAuthorizationByDatabase ( btrieve_file_information_t fileInformation )

extern

Get security current database authorization by database from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database authorization by database.
0	Security current database not authorization by database.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseBtpasswd()

int BtrieveFileInformationGetSecurityCurrentDatabaseBtpasswd ( btrieve_file_information_t fileInformation )

extern

Get security current database btpasswd from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database Btpasswd.
0	Security current database not Btpasswd.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseExplicit()

int BtrieveFileInformationGetSecurityCurrentDatabaseExplicit ( btrieve_file_information_t fileInformation )

extern

Get security current database explicit from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database explicit.
0	Security current database not explicit.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseImplicit()

int BtrieveFileInformationGetSecurityCurrentDatabaseImplicit ( btrieve_file_information_t fileInformation )

extern

Get security current database implicit from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database implicit.
0	Security current database not implicit.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseName()

btrieve_status_code_t BtrieveFileInformationGetSecurityCurrentDatabaseName ( btrieve_file_information_t fileInformation, char * name, int nameSize )

extern

Get security current database name from a Btrieve file information

Parameters

[in]	fileInformation	The file information. See BtrieveFileGetInformation().
[out]	name	The name.
[in]	nameSize	The name size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileInformationGetSecurityCurrentDatabasePAM()

int BtrieveFileInformationGetSecurityCurrentDatabasePAM ( btrieve_file_information_t fileInformation )

extern

Get security current database PAM from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database PAM.
0	Security current database not PAM.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseRTSSComplete()

int BtrieveFileInformationGetSecurityCurrentDatabaseRTSSComplete ( btrieve_file_information_t fileInformation )

extern

Get security current database RTSS complete from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database RTSS complete.
0	Security current database not RTSS complete.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseRTSSDisabled()

int BtrieveFileInformationGetSecurityCurrentDatabaseRTSSDisabled ( btrieve_file_information_t fileInformation )

extern

Get security current database RTSS disabled from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database RTSS disabled.
0	Security current database not RTSS disabled.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseRTSSPreauthorized()

int BtrieveFileInformationGetSecurityCurrentDatabaseRTSSPreauthorized ( btrieve_file_information_t fileInformation )

extern

Get security current database RTSS preauthorized from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database RTSS preauthorized.
0	Security current database not RTSS preauthorized.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseTrusted()

int BtrieveFileInformationGetSecurityCurrentDatabaseTrusted ( btrieve_file_information_t fileInformation )

extern

Get security current database trusted from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database trusted.
0	Security current database not trusted.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseWindowsNamedPipe()

int BtrieveFileInformationGetSecurityCurrentDatabaseWindowsNamedPipe ( btrieve_file_information_t fileInformation )

extern

Get security current database windows named pipe from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database Windows named pipe.
0	Security current database not Windows named pipe.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentDatabaseWorkgroup()

int BtrieveFileInformationGetSecurityCurrentDatabaseWorkgroup ( btrieve_file_information_t fileInformation )

extern

Get security current database workgroup from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security current database workgroup.
0	Security current database not workgroup.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityCurrentUserName()

btrieve_status_code_t BtrieveFileInformationGetSecurityCurrentUserName ( btrieve_file_information_t fileInformation, char * name, int nameSize )

extern

Get security current user name from a Btrieve file information

Parameters

[in]	fileInformation	The file information. See BtrieveFileGetInformation().
[out]	name	The name.
[in]	nameSize	The name size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileInformationGetSecurityHandleAuthenticationByDatabase()

int BtrieveFileInformationGetSecurityHandleAuthenticationByDatabase ( btrieve_file_information_t fileInformation )

extern

Get security handle authentication by database from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle authentication by database.
0	Security handle not authentication by database.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityHandleAuthorizationByDatabase()

int BtrieveFileInformationGetSecurityHandleAuthorizationByDatabase ( btrieve_file_information_t fileInformation )

extern

Get security handle authorization by database from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle authorization by database.
0	Security handle not authorization by database.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityHandleBtpasswd()

int BtrieveFileInformationGetSecurityHandleBtpasswd ( btrieve_file_information_t fileInformation )

extern

Get security handle btpasswd from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle Btpasswd.
0	Security handle not Btpasswd.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityHandleDatabaseName()

btrieve_status_code_t BtrieveFileInformationGetSecurityHandleDatabaseName ( btrieve_file_information_t fileInformation, char * name, int nameSize )

extern

Get security handle database name from a Btrieve file information

Parameters

[in]	fileInformation	The file information. See BtrieveFileGetInformation().
[out]	name	The name.
[in]	nameSize	The name size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileInformationGetSecurityHandleExplicit()

int BtrieveFileInformationGetSecurityHandleExplicit ( btrieve_file_information_t fileInformation )

extern

Get security handle explicit from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle explicit.
0	Security handle not explicit.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityHandleImplicit()

int BtrieveFileInformationGetSecurityHandleImplicit ( btrieve_file_information_t fileInformation )

extern

Get security handle implicit from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle implicit.
0	Security handle not implicit.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityHandlePAM()

int BtrieveFileInformationGetSecurityHandlePAM ( btrieve_file_information_t fileInformation )

extern

Get security handle PAM from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle PAM.
0	Security handle not PAM.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityHandleRTSSComplete()

int BtrieveFileInformationGetSecurityHandleRTSSComplete ( btrieve_file_information_t fileInformation )

extern

Get security handle RTSS complete from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle RTSS complete.
0	Security handle not RTSS complete.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityHandleRTSSDisabled()

int BtrieveFileInformationGetSecurityHandleRTSSDisabled ( btrieve_file_information_t fileInformation )

extern

Get security handle RTSS disabled from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle RTSS disabled.
0	Security handle not RTSS disabled.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityHandleRTSSPreauthorized()

int BtrieveFileInformationGetSecurityHandleRTSSPreauthorized ( btrieve_file_information_t fileInformation )

extern

Get security handle RTSS preauthorized from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle RTSS preautorized.
0	Security handle not RTSS preautorized.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityHandleTableName()

btrieve_status_code_t BtrieveFileInformationGetSecurityHandleTableName ( btrieve_file_information_t fileInformation, char * name, int nameSize )

extern

Get security handle table name from a Btrieve file information

Parameters

[in]	fileInformation	The file information. See BtrieveFileGetInformation().
[out]	name	The name.
[in]	nameSize	The name size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileInformationGetSecurityHandleTrusted()

int BtrieveFileInformationGetSecurityHandleTrusted ( btrieve_file_information_t fileInformation )

extern

Get security handle trusted from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle trusted.
0	Security handle not trusted.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityHandleUserName()

btrieve_status_code_t BtrieveFileInformationGetSecurityHandleUserName ( btrieve_file_information_t fileInformation, char * name, int nameSize )

extern

Get security handle user name from a Btrieve file information

Parameters

[in]	fileInformation	The file information. See BtrieveFileGetInformation().
[out]	name	The name.
[in]	nameSize	The name size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileInformationGetSecurityHandleWindowsNamedPipe()

int BtrieveFileInformationGetSecurityHandleWindowsNamedPipe ( btrieve_file_information_t fileInformation )

extern

Get security handle windows named pipe from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle Windows named pipe.
0	Security handle not Windows named pipe.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityHandleWorkgroup()

int BtrieveFileInformationGetSecurityHandleWorkgroup ( btrieve_file_information_t fileInformation )

extern

Get security handle workgroup from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security handle workgroup.
0	Security handle not workgroup.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionAlter()

int BtrieveFileInformationGetSecurityPermissionAlter ( btrieve_file_information_t fileInformation )

extern

Get security permission alter from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission alter.
0	Security permission no alter.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionCreateFile()

int BtrieveFileInformationGetSecurityPermissionCreateFile ( btrieve_file_information_t fileInformation )

extern

Get security permission create file from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission file create.
0	Security permission no file create.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionCreateRecord()

int BtrieveFileInformationGetSecurityPermissionCreateRecord ( btrieve_file_information_t fileInformation )

extern

Get security permission create record from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission record create.
0	Security permission no record create.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionCreateStoredProcedure()

int BtrieveFileInformationGetSecurityPermissionCreateStoredProcedure ( btrieve_file_information_t fileInformation )

extern

Get security permission create stored procedure from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission create stored procedure.
0	Security permission no create stored procedure.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionCreateView()

int BtrieveFileInformationGetSecurityPermissionCreateView ( btrieve_file_information_t fileInformation )

extern

Get security permission create view from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission create view.
0	Security permission no create view.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionDelete()

int BtrieveFileInformationGetSecurityPermissionDelete ( btrieve_file_information_t fileInformation )

extern

Get security permission delete from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission delete.
0	Security permission no delete.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionExecute()

int BtrieveFileInformationGetSecurityPermissionExecute ( btrieve_file_information_t fileInformation )

extern

Get security permission execute from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission execute.
0	Security permission no execute.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionNoRights()

int BtrieveFileInformationGetSecurityPermissionNoRights ( btrieve_file_information_t fileInformation )

extern

Get security permission no rights from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission no rights.
0	Security permission rights.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionOpen()

int BtrieveFileInformationGetSecurityPermissionOpen ( btrieve_file_information_t fileInformation )

extern

Get security permission open from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission open.
0	Security permission no open.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionRead()

int BtrieveFileInformationGetSecurityPermissionRead ( btrieve_file_information_t fileInformation )

extern

Get security permission read from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission read.
0	Security permission no read.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionRefer()

int BtrieveFileInformationGetSecurityPermissionRefer ( btrieve_file_information_t fileInformation )

extern

Get security permission refer from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission refer.
0	Security permission no refer.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSecurityPermissionUpdate()

int BtrieveFileInformationGetSecurityPermissionUpdate ( btrieve_file_information_t fileInformation )

extern

Get security permission update from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	Security permission update.
0	Security permission no update.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSegmentCount()

int BtrieveFileInformationGetSegmentCount ( btrieve_file_information_t fileInformation )

extern

Get segment count from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The segment count.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSegmented()

int BtrieveFileInformationGetSegmented ( btrieve_file_information_t fileInformation )

extern

Get segmented from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	File is segmented.
0	File isn't segmented.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSegmentFileName()

btrieve_status_code_t BtrieveFileInformationGetSegmentFileName ( btrieve_file_information_t fileInformation, int segmentFileNumber, char * name, int nameSize )

extern

Get segment file name from a Btrieve file information

Parameters

[in]	fileInformation	The file information. See BtrieveFileGetInformation().
[in]	segmentFileNumber	The segment file number.
[out]	name	The name.
[in]	nameSize	The name size.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString,

BtrieveFileInformationGetSystemData()

int BtrieveFileInformationGetSystemData ( btrieve_file_information_t fileInformation )

extern

Get system data from a Btrieve file information.

Note

Renamed from BtrieveFileInformationGetSystemIndexPresent() in Zen v15 R1.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

2	System data version 2 is present.
1	System data is present.
0	System data isn't present.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSystemDataMode()

btrieve_system_data_mode_t BtrieveFileInformationGetSystemDataMode ( btrieve_file_information_t fileInformation )

extern

Get system data mode from a Btrieve file information

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_SYSTEM_DATA_MODE_UNKNOWN	The system data mode.
= BTRIEVE_SYSTEM_DATA_MODE_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

See also

BtrieveSystemDataModeToString

BtrieveFileInformationGetSystemIndex()

int BtrieveFileInformationGetSystemIndex ( btrieve_file_information_t fileInformation )

extern

Get system index from a Btrieve file information.

Note

Renamed from BtrieveFileInformationGetSystemIndexUsed() in Zen v15 R1.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

3	System indexes BTRIEVE_INDEX_SYSTEM and BTRIEVE_INDEX_SYSTEM_VERSION_2 are present.
2	System index BTRIEVE_INDEX_SYSTEM_VERSION_2 is present.
1	System index BTRIEVE_INDEX_SYSTEM is present.
0	No system index is present.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSystemIndexSize()

int BtrieveFileInformationGetSystemIndexSize ( btrieve_file_information_t fileInformation )

extern

Get system index size from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The system index size.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetSystemIndexVersion()

int BtrieveFileInformationGetSystemIndexVersion ( btrieve_file_information_t fileInformation )

extern

Get system index version from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The system index version.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetUnusedDuplicatePointerCount()

int BtrieveFileInformationGetUnusedDuplicatePointerCount ( btrieve_file_information_t fileInformation )

extern

Get unused duplicate pointer count from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The unused duplicate pointer count.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetUnusedPageCount()

int BtrieveFileInformationGetUnusedPageCount ( btrieve_file_information_t fileInformation )

extern

Get unused page count from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The unused page count.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetUsageCount()

int BtrieveFileInformationGetUsageCount ( btrieve_file_information_t fileInformation )

extern

Get usage count from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

>= 0	The usage count.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileInformationGetVariableLengthRecordsMode()

btrieve_variable_length_records_mode_t BtrieveFileInformationGetVariableLengthRecordsMode ( btrieve_file_information_t fileInformation )

extern

Get variable length records mode from a Btrieve file information

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

!= BTRIEVE_VARIABLE_LENGTH_RECORDS_MODE_UNKNOWN	The variable length records mode.
= BTRIEVE_VARIABLE_LENGTH_RECORDS_MODE_UNKNOWN	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

See also

BtrieveVariableLengthRecordsModeToString

BtrieveFileInformationGetWrongOwner()

int BtrieveFileInformationGetWrongOwner ( btrieve_file_information_t fileInformation )

extern

Get wrong owner from a Btrieve file information.

Parameters

[in]

fileInformation

The file information. See BtrieveFileGetInformation().

Return values

> 0	The file was opened with an incorrect owner name.
0	The file wasn't opened with an incorrect owner name.
-1	An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileKeyRetrieve()

btrieve_status_code_t BtrieveFileKeyRetrieve ( btrieve_file_t file, btrieve_comparison_t comparison, btrieve_index_t index, char * key, int keyLength )

extern

Key retrieve for a Btrieve file.

Note

The declaration of this function changed in PSQL v15 R0.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	comparison	The comparison.
[in]	index	The index.
[out]	key	The key.
[in]	keyLength	The key length.

Cursor

The cursor is established.

Current Offset

The current offset is destroyed.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileKeyRetrieveFirst()

btrieve_status_code_t BtrieveFileKeyRetrieveFirst ( btrieve_file_t file, btrieve_index_t index, char * key, int keySize )

extern

Key retrieve first for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	index	The index.
[out]	key	The key.
[in]	keySize	The key size.

Cursor

The cursor is established.

Current Offset

The current offset is destroyed.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileKeyRetrieveLast()

btrieve_status_code_t BtrieveFileKeyRetrieveLast ( btrieve_file_t file, btrieve_index_t index, char * key, int keySize )

extern

Key retrieve last for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	index	The index.
[out]	key	The key.
[in]	keySize	The key size.

Cursor

The cursor is established.

Current Offset

The current offset is destroyed.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileKeyRetrieveNext()

btrieve_status_code_t BtrieveFileKeyRetrieveNext ( btrieve_file_t file, char * key, int keySize )

extern

Key retrieve next for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[out]	key	The key.
[in]	keySize	The key size.

Cursor

The cursor must be established. The cursor is traversed forward one key.

Current Offset

The current offset is destroyed.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileKeyRetrievePrevious()

btrieve_status_code_t BtrieveFileKeyRetrievePrevious ( btrieve_file_t file, char * key, int keySize )

extern

Key retrieve previous for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[out]	key	The key.
[in]	keySize	The key size.

Cursor

The cursor must be established. The cursor is traversed backward one key.

Current Offset

The current offset is destroyed.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileRecordAppendChunk()

btrieve_status_code_t BtrieveFileRecordAppendChunk ( btrieve_file_t file, const char * chunk, int chunkLength )

extern

Record append chunk for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	chunk	The chunk.
[in]	chunkLength	The chunk length.

Description

The file must have variable length records. See BtrieveFileAttributesSetVariableLengthRecordsMode.

Cursor

The cursor is unaffected but must be established.

Current Offset

The current offset is established at the end of the appended chunk.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileRecordCreate()

btrieve_status_code_t BtrieveFileRecordCreate ( btrieve_file_t file, char * record, int recordLength )

extern

Record create for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in,out]	record	The record. If the current record contains a BTRIEVE_DATA_TYPE_AUTOINCREMENT or BTRIEVE_DATA_TYPE_AUTOTIMESTAMP key segment then the passed in record may be modifed.
[in]	recordLength	The record length. Record length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. See BtrieveFileRecordAppendChunk() for creating records greater than BTRIEVE_MAXIMUM_RECORD_LENGTH in length.

Snippet

           // If BtrieveFileRecordCreate() failed.
      if ((status = BtrieveFileRecordCreate(btrieveFile, (char *)&record, sizeof(record))) != BTRIEVE_STATUS_CODE_NO_ERROR)
      {
         printf("Error: BtrieveFileRecordCreate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
         goto leave;
      }

Cursor

The cursor is established.

Current Offset

The current offset is unaffected.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

Examples

btest.c.

BtrieveFileRecordDelete()

btrieve_status_code_t BtrieveFileRecordDelete ( btrieve_file_t file )

extern

Record delete for a Btrieve file.

Parameters

[in]

file

The file. See BtrieveClientFileOpen().

Cursor

The cursor is unaffected but must be established.

Current Offset

The current offset is destroyed.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileRecordDeleteChunk()

btrieve_status_code_t BtrieveFileRecordDeleteChunk ( btrieve_file_t file, int offset, int chunkLength )

extern

Record delete chunk for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	offset	The offset. If offset is -1, then the current offset is used.
[in]	chunkLength	The chunk length.

Description

The file must have variable length records. See BtrieveFileAttributesSetVariableLengthRecordsMode.

Cursor

The cursor is unaffected but must be established.

Current Offset

The current offset is established at the end of the deleted chunk.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileRecordInsertChunk()

btrieve_status_code_t BtrieveFileRecordInsertChunk ( btrieve_file_t file, int offset, const char * chunk, int chunkLength )

extern

Record insert chunk for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	offset	The offset. If offset is -1, then the current offset is used.
[in]	chunk	The chunk.
[in]	chunkLength	The chunk length.

Description

The file must have variable length records. See BtrieveFileAttributesSetVariableLengthRecordsMode.

Cursor

The cursor is unaffected but must be established.

Current Offset

The current offset is established at the end of the inserted chunk.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileRecordRetrieve()

int BtrieveFileRecordRetrieve ( btrieve_file_t file, btrieve_comparison_t comparison, btrieve_index_t index, char * key, int keyLength, char * record, int recordSize, btrieve_lock_mode_t lockMode )

extern

Record retrieve for a Btrieve file.

Note

This function doesn't return a btrieve_status_code_t. See below for more information.

The declaration of this function changed in PSQL v15 R0.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	comparison	The comparison.
[in]	index	The index.
[in]	key	The key.
[in]	keyLength	The key length.
[out]	record	The record.
[in]	recordSize	The record size.
[in]	lockMode	The lock mode.

Snippet

   if (BtrieveFileRecordRetrieve(btrieveFile, BTRIEVE_COMPARISON_EQUAL, BTRIEVE_INDEX_1, (char *)key, sizeof(&key), (char *)&record, sizeof(record), BTRIEVE_LOCK_MODE_NONE) != sizeof(record))
   {
      status = BtrieveFileGetLastStatusCode(btrieveFile);
      printf("Error: BtrieveFileRecordRetrieve():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Cursor

The cursor is established.

Current Offset

The current offset is destroyed.

Return values

>= 0	The number of bytes read. The number of bytes read is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. See BtrieveFileRecordRetrieveChunk() for retrieving records greater than BTRIEVE_MAXIMUM_RECORD_LENGTH in length. If the record size requested is less than the length of the current record then BtrieveFileGetLastStatusCode() will return BTRIEVE_STATUS_CODE_DATALENGTH_ERROR.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

Examples

btest.c.

BtrieveFileRecordRetrieveByCursorPosition()

int BtrieveFileRecordRetrieveByCursorPosition ( btrieve_file_t file, btrieve_index_t index, long long cursorPosition, char * key, int keySize, char * record, int recordSize, btrieve_lock_mode_t lockMode )

extern

Record retrieve by cursor position for a Btrieve file.

Note

This function doesn't return a btrieve_status_code_t. See below for more information.

The declaration of this function changed in PSQL v15 R0.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	index	The index.
[in]	cursorPosition	The cursor position.
[out]	key	The key.
[in]	keySize	The key size.
[out]	record	The record.
[in]	recordSize	The record size.
[in]	lockMode	The lock mode.

Cursor

The cursor is established.

Current Offset

The current offset is destroyed.

Return values

>= 0	The number of bytes read. The number of bytes read is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. See BtrieveFileRecordRetrieveChunk() for retrieving records greater than BTRIEVE_MAXIMUM_RECORD_LENGTH in length. If the record size requested is less than the length of the current record then BtrieveFileGetLastStatusCode() will return BTRIEVE_STATUS_CODE_DATALENGTH_ERROR.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileRecordRetrieveByFraction()

int BtrieveFileRecordRetrieveByFraction ( btrieve_file_t file, btrieve_index_t index, int numerator, int denominator, char * key, int keySize, char * record, int recordSize, btrieve_lock_mode_t lockMode )

extern

Record retrieve by fraction for a Btrieve file.

Note

This function doesn't return a btrieve_status_code_t. See below for more information.

The declaration of this function changed in PSQL v15 R0.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	index	The index.
[in]	numerator	The numerator.
[in]	denominator	The denominator.
[out]	key	The key.
[in]	keySize	The key size.
[out]	record	The record.
[in]	recordSize	The record size.
[in]	lockMode	The lock mode.

Cursor

The cursor is established.

Current Offset

The current offset is destroyed.

Return values

>= 0	The number of bytes read. The number of bytes read is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. See BtrieveFileRecordRetrieveChunk() for retrieving records greater than BTRIEVE_MAXIMUM_RECORD_LENGTH in length. If the record size requested is less than the length of the current record then BtrieveFileGetLastStatusCode() will return BTRIEVE_STATUS_CODE_DATALENGTH_ERROR.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileRecordRetrieveByPercentage()

int BtrieveFileRecordRetrieveByPercentage ( btrieve_file_t file, btrieve_index_t index, int percentage, char * key, int keySize, char * record, int recordSize, btrieve_lock_mode_t lockMode )

extern

Record retrieve by percentage for a Btrieve file.

Note

This function doesn't return a btrieve_status_code_t. See below for more information.

The declaration of this function changed in PSQL v15 R0.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	index	The index.
[in]	percentage	The percentage.
[out]	key	The key.
[in]	keySize	The key size.
[out]	record	The record.
[in]	recordSize	The record size.
[in]	lockMode	The lock mode.

Cursor

The cursor is established.

Current Offset

The current offset is destroyed.

Return values

>= 0	The number of bytes read. The number of bytes read is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. See BtrieveFileRecordRetrieveChunk() for retrieving records greater than BTRIEVE_MAXIMUM_RECORD_LENGTH in length. If the record size requested is less than the length of the current record then BtrieveFileGetLastStatusCode() will return BTRIEVE_STATUS_CODE_DATALENGTH_ERROR.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileRecordRetrieveChunk()

int BtrieveFileRecordRetrieveChunk ( btrieve_file_t file, int offset, int length, char * chunk, int chunkSize, btrieve_lock_mode_t lockMode )

extern

Record retrieve chunk for a Btrieve file.

Note

This function doesn't return a btrieve_status_code_t. See below for more information.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	offset	The offset. If offset is -1, then the current offset is used.
[in]	length	The length.
[in]	lockMode	The lock mode.
[out]	chunk	The chunk.
[in]	chunkSize	The chunk size.

Cursor

The cursor is unaffected but must be established.

Current Offset

The current offset is established at the end of the retrieved chunk.

Return values

>= 0	The number of bytes read. You may retrieve multiple chunks.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileRecordRetrieveFirst()

int BtrieveFileRecordRetrieveFirst ( btrieve_file_t file, btrieve_index_t index, char * key, int keySize, char * record, int recordSize, btrieve_lock_mode_t lockMode )

extern

Record retrieve first for a Btrieve file.

Note

This function doesn't return a btrieve_status_code_t. See below for more information.

The declaration of this function changed in PSQL v15 R0.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	index	The index.
[out]	key	The key.
[in]	keySize	The key size.
[out]	record	The record.
[in]	recordSize	The record size.
[in]	lockMode	The lock mode.

Cursor

The cursor is established.

Current Offset

The current offset is destroyed.

Return values

>= 0	The number of bytes read. The number of bytes read is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. See BtrieveFileRecordRetrieveChunk() for retrieving records greater than BTRIEVE_MAXIMUM_RECORD_LENGTH in length. If the record size requested is less than the length of the current record then BtrieveFileGetLastStatusCode() will return BTRIEVE_STATUS_CODE_DATALENGTH_ERROR.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileRecordRetrieveLast()

int BtrieveFileRecordRetrieveLast ( btrieve_file_t file, btrieve_index_t index, char * key, int keySize, char * record, int recordSize, btrieve_lock_mode_t lockMode )

extern

Record retrieve last for a Btrieve file.

Note

This function doesn't return a btrieve_status_code_t. See below for more information.

The declaration of this function changed in PSQL v15 R0.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	index	The index.
[out]	key	The key.
[in]	keySize	The key size.
[out]	record	The record.
[in]	recordSize	The record size.
[in]	lockMode	The lock mode.

Cursor

The cursor is established.

Current Offset

The current offset is destroyed.

Return values

>= 0	The number of bytes read. The number of bytes read is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. See BtrieveFileRecordRetrieveChunk() for retrieving records greater than BTRIEVE_MAXIMUM_RECORD_LENGTH in length. If the record size requested is less than the length of the current record then BtrieveFileGetLastStatusCode() will return BTRIEVE_STATUS_CODE_DATALENGTH_ERROR.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileRecordRetrieveNext()

int BtrieveFileRecordRetrieveNext ( btrieve_file_t file, char * key, int keySize, char * record, int recordSize, btrieve_lock_mode_t lockMode )

extern

Record retrieve next for a Btrieve file.

Note

This function doesn't return a btrieve_status_code_t. See below for more information.

The declaration of this function changed in PSQL v15 R0.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[out]	key	The key.
[in]	keySize	The key size.
[out]	record	The record.
[in]	recordSize	The record size.
[in]	lockMode	The lock mode.

Cursor

The cursor must be established. The cursor is traversed forward one record.

Current Offset

The current offset is destroyed.

Return values

>= 0	The number of bytes read. The number of bytes read is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. See BtrieveFileRecordRetrieveChunk() for retrieving records greater than BTRIEVE_MAXIMUM_RECORD_LENGTH in length. If the record size requested is less than the length of the current record then BtrieveFileGetLastStatusCode() will return BTRIEVE_STATUS_CODE_DATALENGTH_ERROR.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileRecordRetrievePrevious()

int BtrieveFileRecordRetrievePrevious ( btrieve_file_t file, char * key, int keySize, char * record, int recordSize, btrieve_lock_mode_t lockMode )

extern

Record retrieve previous for a Btrieve file.

Note

This function doesn't return a btrieve_status_code_t. See below for more information.

The declaration of this function changed in PSQL v15 R0.

Parameters

[out]	key	The key.
[in]	keySize	The key size.
[in]	file	The file. See BtrieveClientFileOpen().
[out]	record	The record.
[in]	recordSize	The record size.
[in]	lockMode	The lock mode.

Cursor

The cursor must be established. The cursor is traversed backward one record.

Current Offset

The current offset is destroyed.

Return values

>= 0	The number of bytes read. The number of bytes read is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. See BtrieveFileRecordRetrieveChunk() for retrieving records greater than BTRIEVE_MAXIMUM_RECORD_LENGTH in length. If the record size requested is less than the length of the current record then BtrieveFileGetLastStatusCode() will return BTRIEVE_STATUS_CODE_DATALENGTH_ERROR.
-1	An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveFileRecordTruncate()

btrieve_status_code_t BtrieveFileRecordTruncate ( btrieve_file_t file, int offset )

extern

Record truncate for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	offset	The offset. If offset is -1, then the current offset is used.

Cursor

The cursor is unaffected but must be established.

Current Offset

The current offset is established at the end of the record.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileRecordUnlock()

btrieve_status_code_t BtrieveFileRecordUnlock ( btrieve_file_t file, btrieve_unlock_mode_t unlockMode )

extern

Record unlock for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	unlockMode	The unlock mode.

Cursor

The cursor is unaffected.

Current Offset

The current offset is unaffected.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileRecordUpdate()

btrieve_status_code_t BtrieveFileRecordUpdate ( btrieve_file_t file, const char * record, int recordLength )

extern

Record update for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	record	The record.
[in]	recordLength	The record length. Record length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH. See BtrieveFileRecordUpdateChunk() for updating records greater than BTRIEVE_MAXIMUM_RECORD_LENGTH in length.

Cursor

The cursor is unaffected but must be established.

Current Offset

The current offset is unaffected.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileRecordUpdateChunk()

btrieve_status_code_t BtrieveFileRecordUpdateChunk ( btrieve_file_t file, int offset, const char * chunk, int chunkLength )

extern

Record update chunk for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	offset	The offset. If offset is -1, then the current offset is used.
[in]	chunk	The chunk.
[in]	chunkLength	The chunk length.

Snippet

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

Cursor

The cursor is unaffected but must be established.

Current Offset

The current offset is established at the end of the updated chunk.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileSetOwner()

btrieve_status_code_t BtrieveFileSetOwner ( btrieve_file_t file, btrieve_owner_mode_t ownerMode, const char * ownerName, const char * ownerNameAgain, int useLongOwnerName )

extern

Set owner for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	ownerMode	The owner mode.
[in]	ownerName	The owner name.
[in]	ownerNameAgain	The owner name again.
[in]	useLongOwnerName	Use a long owner name?

Description

Owner mode defaults to BTRIEVE_OWNER_MODE_NONE.

Cursor

The cursor is unaffected.

Current Offset

The current offset is unaffected.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileUnlockCursorPosition()

btrieve_status_code_t BtrieveFileUnlockCursorPosition ( btrieve_file_t file, long long cursorPosition )

extern

Unlock cursor position for a Btrieve file.

Parameters

[in]	file	The file. See BtrieveClientFileOpen().
[in]	cursorPosition	The cursor position.

Cursor

The cursor is unaffected.

Current Offset

The current offset is unaffected.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFileVersionToString()

const char * BtrieveFileVersionToString ( btrieve_file_version_t fileVersion )

extern

Return a Btrieve file version as a string.

Parameters

[in]

fileVersion

The file version.

Returns

The string.

BtrieveFilterAllocate()

btrieve_status_code_t BtrieveFilterAllocate ( btrieve_filter_t * btrieveFilterPtr )

extern

Allocate a Btrieve filter.

Parameters

[out]

btrieveFilterPtr

The Btrieve filter pointer.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveFilterFree

BtrieveFilterFree()

btrieve_status_code_t BtrieveFilterFree ( btrieve_filter_t filter )

extern

Free a Btrieve filter.

Parameters

[in]

filter

The filter.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveFilterAllocate

BtrieveFilterSetACSMode()

btrieve_status_code_t BtrieveFilterSetACSMode ( btrieve_filter_t filter, btrieve_acs_mode_t ACSMode )

extern

Set ACS mode for a Btrieve filter.

Parameters

[in]	filter	The filter. See BtrieveFilterAllocate().
[in]	ACSMode	The ACS mode.

Description

Alternate collation sequence mode defaults to BTRIEVE_ACS_MODE_NONE. To set the alternate collation sequence mode to BTRIEVE_ACS_MODE_NAMED use BtrieveFilterSetACSName() or BtrieveFilterSetACSUserDefined(). BTRIEVE_ACS_MODE_NUMBERED is unsupported.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFilterSetACSName()

btrieve_status_code_t BtrieveFilterSetACSName ( btrieve_filter_t filter, const char * name )

extern

Set ACS name for a Btrieve filter.

Parameters

[in]	filter	The filter. See BtrieveFilterAllocate().
[in]	name	The name.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFilterSetACSUserDefined()

btrieve_status_code_t BtrieveFilterSetACSUserDefined ( btrieve_filter_t filter, const char * name )

extern

Set ACS user defined for a Btrieve filter.

Parameters

[in]	filter	The filter. See BtrieveFilterAllocate().
[in]	name	The name.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFilterSetComparison()

btrieve_status_code_t BtrieveFilterSetComparison ( btrieve_filter_t filter, btrieve_comparison_t comparison )

extern

Set comparison for a Btrieve filter.

Parameters

[in]	filter	The filter. See BtrieveFilterAllocate().
[in]	comparison	The comparison.

Description

Comparison defaults to BTRIEVE_COMPARISON_NONE.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFilterSetComparisonConstant()

btrieve_status_code_t BtrieveFilterSetComparisonConstant ( btrieve_filter_t filter, const char * constant, int constantLength )

extern

Set comparison constant for a Btrieve filter.

Parameters

[in]	filter	The filter. See BtrieveFilterAllocate().
[in]	constant	The constant.
[in]	constantLength	The comparison constant length. Comparison constant length is limited to BTRIEVE_MAXIMUM_KEY_LENGTH.

Description

Filters have no comparison constant initially.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFilterSetComparisonField()

btrieve_status_code_t BtrieveFilterSetComparisonField ( btrieve_filter_t filter, int offset )

extern

Set comparison field for a Btrieve filter.

Parameters

[in]	filter	The filter. See BtrieveFilterAllocate().
[in]	offset	The comparison field offset. Offset must be less than BTRIEVE_MAXIMUM_RECORD_LENGTH.

Description

Filters have no comparison field initially.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFilterSetConnector()

btrieve_status_code_t BtrieveFilterSetConnector ( btrieve_filter_t filter, btrieve_connector_t connector )

extern

Set connector for a Btrieve filter.

Parameters

[in]	filter	The filter. See BtrieveFilterAllocate().
[in]	connector	The connector.

Description

Field connector defaults to BTRIEVE_CONNECTOR_LAST.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFilterSetField()

btrieve_status_code_t BtrieveFilterSetField ( btrieve_filter_t filter, int offset, int length, btrieve_data_type_t dataType )

extern

Set field for a Btrieve filter.

Parameters

[in]	filter	The filter. See BtrieveFilterAllocate().
[in]	offset	The offset. Offset must be less than BTRIEVE_MAXIMUM_RECORD_LENGTH.
[in]	length	The length. Length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
[in]	dataType	The data type. BTRIEVE_DATA_TYPE_LEGACY_BINARY and BTRIEVE_DATA_TYPE_LEGACY_STRING are not supported.

Description

Filters have no field initially. Offset plus length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFilterSetLikeCodePageName()

btrieve_status_code_t BtrieveFilterSetLikeCodePageName ( btrieve_filter_t filter, const char * name )

extern

Set like code page name for a Btrieve filter.

Parameters

[in]	filter	The filter. See BtrieveFilterAllocate().
[in]	name	The name.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFilterSetSystemField()

btrieve_status_code_t BtrieveFilterSetSystemField ( btrieve_filter_t filter, btrieve_system_field_t systemField )

extern

Set system field for a Btrieve filter.

Parameters

[in]	filter	The filter. See BtrieveFilterAllocate().
[in]	systemField	The system field.

Description

Filters have no system field initially.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveFreeSpaceThresholdToString()

const char * BtrieveFreeSpaceThresholdToString ( btrieve_free_space_threshold_t freeSpaceThreshold )

extern

Return a Btrieve free space threshold as a string.

Parameters

[in]

freeSpaceThreshold

The free space threshold.

Returns

The string.

BtrieveIndexAttributesAddKeySegment()

btrieve_status_code_t BtrieveIndexAttributesAddKeySegment ( btrieve_index_attributes_t indexAttributes, btrieve_key_segment_t keySegment )

extern

segment for a Btrieve index attributes Addkey

Parameters

[in]	indexAttributes	The index attributes. See BtrieveIndexAttributesAllocate().
[in]	keySegment	The key segment. See BtrieveKeySegmentAllocate().

Snippet

   // If BtrieveIndexAttributesAddKeySegment() failed.
   if ((status = BtrieveIndexAttributesAddKeySegment(btrieveIndexAttributes, btrieveKeySegment)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveIndexAttributesAddKeySegment():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

Examples

btest.c.

BtrieveIndexAttributesAllocate()

btrieve_status_code_t BtrieveIndexAttributesAllocate ( btrieve_index_attributes_t * btrieveIndexAttributesPtr )

extern

Allocate a Btrieve index attributes.

Parameters

[out]

btrieveIndexAttributesPtr

The Btrieve index attributes pointer.

Snippet

   // If BtrieveIndexAttributesAllocate() failed.
   if ((status = BtrieveIndexAttributesAllocate(&btrieveIndexAttributes)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveIndexAttributesAllocate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveIndexAttributesFree

Examples

btest.c.

BtrieveIndexAttributesFree()

btrieve_status_code_t BtrieveIndexAttributesFree ( btrieve_index_attributes_t indexAttributes )

extern

Free a Btrieve index attributes.

Parameters

[in]

indexAttributes

The index attributes.

Snippet

   if (btrieveIndexAttributes != NULL)
   {
      BtrieveIndexAttributesFree(btrieveIndexAttributes);
      btrieveIndexAttributes = NULL;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveIndexAttributesAllocate

Examples

btest.c.

BtrieveIndexAttributesSetACSMode()

btrieve_status_code_t BtrieveIndexAttributesSetACSMode ( btrieve_index_attributes_t indexAttributes, btrieve_acs_mode_t ACSMode )

extern

Set ACS mode for a Btrieve index attributes.

Parameters

[in]	indexAttributes	The index attributes. See BtrieveIndexAttributesAllocate().
[in]	ACSMode	The ACS mode.

Description

Alternate collation sequence mode defaults to BTRIEVE_ACS_MODE_NONE. To set the alternate collation sequence mode to BTRIEVE_ACS_MODE_NAMED use BtrieveIndexAttributesSetACSName() or BtrieveIndexAttributesSetACSUserDefined(). To set the alternate collation sequence mode to BTRIEVE_ACS_MODE_NUMBERED use BtrieveIndexAttributesSetACSNumber().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString,

BtrieveIndexAttributesSetACSName()

btrieve_status_code_t BtrieveIndexAttributesSetACSName ( btrieve_index_attributes_t indexAttributes, const char * ACSName )

extern

Set ACS name for a Btrieve index attributes.

Parameters

[in]	indexAttributes	The index attributes. See BtrieveIndexAttributesAllocate().
[in]	ACSName	The ACS name.

Description

By default there is no alternate collation sequence name. Setting the alternate collation sequence name also sets the alternate collation sequence mode to BTRIEVE_ACS_MODE_NAMED.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveIndexAttributesSetACSNumber()

btrieve_status_code_t BtrieveIndexAttributesSetACSNumber ( btrieve_index_attributes_t indexAttributes, int ACSNumber )

extern

Set ACS number for a Btrieve index attributes.

Parameters

[in]	indexAttributes	The index attributes. See BtrieveIndexAttributesAllocate().
[in]	ACSNumber	The ACS number.

Description

By default there is no alternate collation sequence number. Setting the alternate collation sequence number also sets the alternate collation sequence mode to BTRIEVE_ACS_MODE_NUMBERED.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveIndexAttributesSetACSUserDefined()

btrieve_status_code_t BtrieveIndexAttributesSetACSUserDefined ( btrieve_index_attributes_t indexAttributes, const char * ACSName, const char * ACSMap, int ACSMapLength )

extern

Set ACS user defined for a Btrieve index attributes.

Parameters

[in]	indexAttributes	The index attributes. See BtrieveIndexAttributesAllocate().
[in]	ACSName	The ACS name.
[in]	ACSMap	The ACS map.
[in]	ACSMapLength	The ACS map length.

Description

By default there is no user defined alternate collation sequence. Setting the user defined alternate collation sequence also sets the alternate collation sequence mode to BTRIEVE_ACS_MODE_NAMED.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveIndexAttributesSetDuplicateMode()

btrieve_status_code_t BtrieveIndexAttributesSetDuplicateMode ( btrieve_index_attributes_t indexAttributes, btrieve_duplicate_mode_t duplicateMode )

extern

Set duplicate mode for a Btrieve index attributes.

Parameters

[in]	indexAttributes	The index attributes. See BtrieveIndexAttributesAllocate().
[in]	duplicateMode	The duplicate mode.

Description

Duplicate mode defaults to BTRIEVE_DUPLICATE_MODE_NOT_ALLOWED.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveIndexAttributesSetIndex()

btrieve_status_code_t BtrieveIndexAttributesSetIndex ( btrieve_index_attributes_t indexAttributes, btrieve_index_t index )

extern

Set index for a Btrieve IndexAttributes.

Parameters

[in]	index	The index.
[in]	indexAttributes	The index attributes. See BtrieveIndexAttributesAllocate().

Description

Index defaults to the first available index starting at BTRIEVE_INDEX_1.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveIndexAttributesSetModifiable()

btrieve_status_code_t BtrieveIndexAttributesSetModifiable ( btrieve_index_attributes_t indexAttributes, int enableModifiable )

extern

Set modifiable for a Btrieve index attributes.

Parameters

[in]	indexAttributes	The index attributes. See BtrieveIndexAttributesAllocate().
[in]	enableModifiable	Enable modifiable?

Description

Modifiable is enabled by default.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveIndexToString()

const char * BtrieveIndexToString ( btrieve_index_t index )

extern

Return a Btrieve index as a string.

Parameters

[in]

index

The index.

Returns

The string.

BtrieveKeySegmentAllocate()

btrieve_status_code_t BtrieveKeySegmentAllocate ( btrieve_key_segment_t * btrieveKeySegmentPtr )

extern

Allocate a Btrieve key segment.

Parameters

[out]

btrieveKeySegmentPtr

The Btrieve key segment pointer.

Snippet

   // If BtrieveKeySegmentAllocate() failed.
   if ((status = BtrieveKeySegmentAllocate(&btrieveKeySegment)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveKeySegmentAllocate():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveKeySegmentFree

Examples

btest.c.

BtrieveKeySegmentFree()

btrieve_status_code_t BtrieveKeySegmentFree ( btrieve_key_segment_t keySegment )

extern

Free a Btrieve key segment.

Parameters

[in]

keySegment

The key segment.

Snippet

   if (btrieveKeySegment != NULL)
   {
      BtrieveKeySegmentFree(btrieveKeySegment);
      btrieveKeySegment = NULL;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveKeySegmentAllocate

Examples

btest.c.

BtrieveKeySegmentGetACSMode()

btrieve_acs_mode_t BtrieveKeySegmentGetACSMode ( btrieve_key_segment_t keySegment )

extern

Get ACS mode from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

!= BTRIEVE_ACS_MODE_UNKNOWN	The ACS mode.
= BTRIEVE_ACS_MODE_UNKNOWN	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetACSNumber()

int BtrieveKeySegmentGetACSNumber ( btrieve_key_segment_t keySegment )

extern

Get ACS number from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

>= 0	The ACS number.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetDataType()

btrieve_data_type_t BtrieveKeySegmentGetDataType ( btrieve_key_segment_t keySegment )

extern

Get data type from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

!= BTRIEVE_DATA_TYPE_UNKNOWN	The data type.
= BTRIEVE_DATA_TYPE_UNKNOWN	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetDescendingSortOrder()

int BtrieveKeySegmentGetDescendingSortOrder ( btrieve_key_segment_t keySegment )

extern

Get descending sort order from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

> 0	Descending sort order is set.
0	Descending sort order isn't set.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetDuplicateMode()

btrieve_duplicate_mode_t BtrieveKeySegmentGetDuplicateMode ( btrieve_key_segment_t keySegment )

extern

Get duplicate mode from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

!= BTRIEVE_DUPLICATE_MODE_UNKNOWN	The duplicate mode.
= BTRIEVE_DUPLICATE_MODE_UNKNOWN	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetIndex()

btrieve_index_t BtrieveKeySegmentGetIndex ( btrieve_key_segment_t keySegment )

extern

Get index from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

!= BTRIEVE_INDEX_UNKNOWN	The index.
= BTRIEVE_INDEX_UNKNOWN	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetKeyContinues()

int BtrieveKeySegmentGetKeyContinues ( btrieve_key_segment_t keySegment )

extern

Get key continues from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

> 0	Key continues is set.
0	Key continues isn't set.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetLastStatusCode()

btrieve_status_code_t BtrieveKeySegmentGetLastStatusCode ( btrieve_key_segment_t keySegment )

extern

Get last status code from a Btrieve key segment

Note

This function is intended for use following functions which don't return a status code.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveKeySegmentGetLength()

int BtrieveKeySegmentGetLength ( btrieve_key_segment_t keySegment )

extern

Get length from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

>= 0	The length.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetModifiable()

int BtrieveKeySegmentGetModifiable ( btrieve_key_segment_t keySegment )

extern

Get modifiable from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

> 0	Modifications are allowed.
0	Modifications are not allowed.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetNullAllSegments()

int BtrieveKeySegmentGetNullAllSegments ( btrieve_key_segment_t keySegment )

extern

Get null all segments from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

>= 0	The null all segments.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetNullAnySegment()

int BtrieveKeySegmentGetNullAnySegment ( btrieve_key_segment_t keySegment )

extern

Get null any segment from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

>= 0	The null any segment.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetNullKeyMode()

btrieve_null_key_mode_t BtrieveKeySegmentGetNullKeyMode ( btrieve_key_segment_t keySegment )

extern

Get null key mode from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

!= BTRIEVE_NULL_KEY_MODE_UNKNOWN	The null key mode.
= BTRIEVE_NULL_KEY_MODE_UNKNOWN	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetNullValue()

int BtrieveKeySegmentGetNullValue ( btrieve_key_segment_t keySegment )

extern

Get null value from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

>= 0	The null value.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetOffset()

int BtrieveKeySegmentGetOffset ( btrieve_key_segment_t keySegment )

extern

Get offset from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

>= 0	The offset.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetSegmented()

int BtrieveKeySegmentGetSegmented ( btrieve_key_segment_t keySegment )

extern

Get segmented from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

>= 0	The segmented.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetUniqueValueCount()

long long BtrieveKeySegmentGetUniqueValueCount ( btrieve_key_segment_t keySegment )

extern

Get unique value count from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

>= 0	The unique value count.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentGetUseNumberedACS()

int BtrieveKeySegmentGetUseNumberedACS ( btrieve_key_segment_t keySegment )

extern

Get use numbered ACS from a Btrieve key segment.

Parameters

[in]

keySegment

The key segment. See BtrieveFileInformationGetKeySegment().

Return values

>= 0	The use numbered ACS.
-1	An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveKeySegmentSetDescendingSortOrder()

btrieve_status_code_t BtrieveKeySegmentSetDescendingSortOrder ( btrieve_key_segment_t keySegment, int setDescendingSortOrder )

extern

Set descending sort order for a Btrieve key segment.

Parameters

[in]	keySegment	The key segment. See BtrieveKeySegmentAllocate().
[in]	setDescendingSortOrder	Enable descending sort order?

Description

Descending sort order is disabled by default.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveKeySegmentSetField()

btrieve_status_code_t BtrieveKeySegmentSetField ( btrieve_key_segment_t keySegment, int offset, int length, btrieve_data_type_t dataType )

extern

Set field for a Btrieve key segment.

Parameters

[in]	keySegment	The key segment. See BtrieveKeySegmentAllocate().
[in]	offset	The offset. Offset must be less than BTRIEVE_MAXIMUM_RECORD_LENGTH.
[in]	length	The length. Length is limited to BTRIEVE_MAXIMUM_KEY_LENGTH.
[in]	dataType	The data type.

Description

Key segments have no field initially. Offset plus length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.

Snippet

   // If BtrieveKeySegmentSetField() failed.
   if ((status = BtrieveKeySegmentSetField(btrieveKeySegment, 0, 1, BTRIEVE_DATA_TYPE_UNSIGNED_BINARY)) != BTRIEVE_STATUS_CODE_NO_ERROR)
   {
      printf("Error: BtrieveKeySegmentSetField():%d:%s.\n", status, BtrieveStatusCodeToString(status));
      goto leave;
   }

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

Examples

btest.c.

BtrieveKeySegmentSetNullKeyMode()

btrieve_status_code_t BtrieveKeySegmentSetNullKeyMode ( btrieve_key_segment_t keySegment, btrieve_null_key_mode_t nullKeyMode )

extern

Set null key mode for a Btrieve key segment.

Parameters

[in]	keySegment	The key segment. See BtrieveKeySegmentAllocate().
[in]	nullKeyMode	The null key mode.

Description

Null key mode defaults to BTRIEVE_NULL_KEY_MODE_NONE.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveKeySegmentSetNullValue()

btrieve_status_code_t BtrieveKeySegmentSetNullValue ( btrieve_key_segment_t keySegment, int nullValue )

extern

Set null value for a Btrieve key segment.

Parameters

[in]	keySegment	The key segment. See BtrieveKeySegmentAllocate().
[in]	nullValue	The null value.

Description

Null value defaults to zero.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveLockModeToString()

const char * BtrieveLockModeToString ( btrieve_lock_mode_t lockMode )

extern

Return a Btrieve lock mode as a string.

Parameters

[in]

lockMode

The lock mode.

Returns

The string.

BtrieveNullKeyModeToString()

const char * BtrieveNullKeyModeToString ( btrieve_null_key_mode_t nullKeyMode )

extern

Return a Btrieve null key mode as a string.

Parameters

[in]

nullKeyMode

The null key mode.

Returns

The string.

BtrieveOwnerModeToString()

const char * BtrieveOwnerModeToString ( btrieve_owner_mode_t ownerMode )

extern

Return a Btrieve owner mode as a string.

Parameters

[in]

ownerMode

The owner mode.

Returns

The string.

BtrievePageLockTypeToString()

const char * BtrievePageLockTypeToString ( btrieve_page_lock_type_t pageLockType )

extern

Return a Btrieve page lock type as a string.

Parameters

[in]

pageLockType

The page lock type.

Returns

The string.

BtrievePageSizeToString()

const char * BtrievePageSizeToString ( btrieve_page_size_t pageSize )

extern

Return a Btrieve page size as a string.

Parameters

[in]

pageSize

The page size.

Returns

The string.

BtrieveRecordCompressionModeToString()

const char * BtrieveRecordCompressionModeToString ( btrieve_record_compression_mode_t recordCompressionMode )

extern

Return a Btrieve record compression mode as a string.

Parameters

[in]

recordCompressionMode

The record compression mode.

Returns

The string.

BtrieveStatusCodeToString()

const char * BtrieveStatusCodeToString ( btrieve_status_code_t statusCode )

extern

Return a Btrieve status code as a string.

Parameters

[in]

statusCode

The status code.

Returns

The string.

Examples

btest.c.

BtrieveSystemDataModeToString()

const char * BtrieveSystemDataModeToString ( btrieve_system_data_mode_t systemDataMode )

extern

Return a Btrieve system data mode as a string.

Parameters

[in]

systemDataMode

The system data mode.

Returns

The string.

BtrieveSystemFieldToString()

const char * BtrieveSystemFieldToString ( btrieve_system_field_t systemField )

extern

Return a Btrieve system field as a string.

Parameters

[in]

systemField

The system field.

Returns

The string.

BtrieveTimestampToUnixEpochMicroseconds()

long long BtrieveTimestampToUnixEpochMicroseconds ( long long timestamp )

extern

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

Parameters

[in]

timestamp

The Btrieve TIMESTAMP.

Returns

The Epoch based timestamp in microseconds.

BtrieveUnixEpochMicrosecondsToTimestamp()

long long BtrieveUnixEpochMicrosecondsToTimestamp ( long long microseconds )

extern

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

Parameters

[in]

microseconds

The Unix Epoch timestamp in microseconds granularity.

Returns

The Btrieve TIMESTAMP.

BtrieveVariableLengthRecordsModeToString()

const char * BtrieveVariableLengthRecordsModeToString ( btrieve_variable_length_records_mode_t variableLengthRecordsMode )

extern

Return a Btrieve variable length records mode as a string.

Parameters

[in]

variableLengthRecordsMode

The variable length records mode.

Returns

The string.

BtrieveVersionAllocate()

btrieve_status_code_t BtrieveVersionAllocate ( btrieve_version_t * btrieveVersionPtr )

extern

Allocate a Btrieve version.

Parameters

[out]

btrieveVersionPtr

The Btrieve version pointer.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveVersionFree

BtrieveVersionFree()

btrieve_status_code_t BtrieveVersionFree ( btrieve_version_t version )

extern

Free a Btrieve version.

Parameters

[in]

version

The version.

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString, BtrieveFileInformationAllocate

BtrieveVersionGetClientRevisionNumber()

int BtrieveVersionGetClientRevisionNumber ( btrieve_version_t version )

extern

Get client revision number from a Btrieve version.

Parameters

[in]

version

The version. See BtrieveClientGetVersion().

Return values

>= 0	The client revision number.
-1	An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveVersionGetClientVersionNumber()

int BtrieveVersionGetClientVersionNumber ( btrieve_version_t version )

extern

Get client version number from a Btrieve version.

Parameters

[in]

version

The version. See BtrieveClientGetVersion().

Return values

>= 0	The client version number.
-1	An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveVersionGetClientVersionType()

btrieve_version_type_t BtrieveVersionGetClientVersionType ( btrieve_version_t version )

extern

Get client version type from a Btrieve version.

Parameters

[in]

version

The version. See BtrieveClientGetVersion().

Return values

!= BTRIEVE_VERSION_TYPE_UNKNOWN	The client version type.
= BTRIEVE_VERSION_TYPE_UNKNOWN	An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveVersionGetLastStatusCode()

btrieve_status_code_t BtrieveVersionGetLastStatusCode ( btrieve_version_t version )

extern

Get last status code from a Btrieve version.

Note

This function is intended for use following functions which don't return a status code.

Parameters

[in]

version

The version. See BtrieveClientGetVersion().

Return values

= BTRIEVE_STATUS_CODE_NO_ERROR	Success.
!= BTRIEVE_STATUS_CODE_NO_ERROR	An error has occurred.

See also

BtrieveStatusCodeToString

BtrieveVersionGetLocalRevisionNumber()

int BtrieveVersionGetLocalRevisionNumber ( btrieve_version_t version )

extern

Get local revision number from a Btrieve version.

Parameters

[in]

version

The version. See BtrieveClientGetVersion().

Return values

>= 0	The local revision number.
-1	An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveVersionGetLocalVersionNumber()

int BtrieveVersionGetLocalVersionNumber ( btrieve_version_t version )

extern

Get local version number from a Btrieve version.

Parameters

[in]

version

The version. See BtrieveClientGetVersion().

Return values

>= 0	The local version number.
-1	An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveVersionGetLocalVersionType()

btrieve_version_type_t BtrieveVersionGetLocalVersionType ( btrieve_version_t version )

extern

Get local version type from a Btrieve version.

Parameters

[in]

version

The version. See BtrieveClientGetVersion().

Return values

!= BTRIEVE_VERSION_TYPE_UNKNOWN	The local version type.
= BTRIEVE_VERSION_TYPE_UNKNOWN	An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveVersionGetRemoteRevisionNumber()

int BtrieveVersionGetRemoteRevisionNumber ( btrieve_version_t version )

extern

Get remote revision number from a Btrieve version.

Parameters

[in]

version

The version. See BtrieveClientGetVersion().

Return values

>= 0	The remote revision number.
-1	An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveVersionGetRemoteVersionNumber()

int BtrieveVersionGetRemoteVersionNumber ( btrieve_version_t version )

extern

Get remote version number from a Btrieve version.

Parameters

[in]

version

The version. See BtrieveClientGetVersion().

Return values

>= 0	The remote version number.
-1	An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveVersionGetRemoteVersionType()

btrieve_version_type_t BtrieveVersionGetRemoteVersionType ( btrieve_version_t version )

extern

Get remote version type from a Btrieve version.

Parameters

[in]

version

The version. See BtrieveClientGetVersion().

Return values

!= BTRIEVE_VERSION_TYPE_UNKNOWN	The remote version type.
= BTRIEVE_VERSION_TYPE_UNKNOWN	An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error.

BtrieveVersionTypeToString()

const char * BtrieveVersionTypeToString ( btrieve_version_type_t versionType )

extern

Return a Btrieve version type as a string.

Parameters

[in]

versionType

The version type. See BtrieveClientGetVersion().

Returns

The string.