 |
|
Go to the source code of this file.
Macros | |
| #define | BTRIEVE_MAXIMUM_BULK_RECORD_COUNT 25804 |
| The Btrieve maximum bulk record count. More... | |
| #define | BTRIEVE_MAXIMUM_KEY_LENGTH 255 |
| The Btrieve maximum key segment length. More... | |
| #define | BTRIEVE_MAXIMUM_RECORD_LENGTH (64 * 1024 - 1) |
| The Btrieve maximum record length. More... | |
Typedefs | |
| typedef struct btrieve_bulk_create_payload * | btrieve_bulk_create_payload_t |
| A Btrieve bulk create payload. More... | |
| typedef struct btrieve_bulk_create_result * | btrieve_bulk_create_result_t |
| A Btrieve bulk create result. More... | |
| typedef struct btrieve_bulk_delete_attributes * | btrieve_bulk_delete_attributes_t |
| A Btrieve bulk delete attributes. More... | |
| typedef struct btrieve_bulk_delete_result * | btrieve_bulk_delete_result_t |
| A Btrieve bulk delete result. More... | |
| typedef struct btrieve_bulk_retrieve_attributes * | btrieve_bulk_retrieve_attributes_t |
| A Btrieve bulk retrieve attributes. More... | |
| typedef struct btrieve_bulk_retrieve_result * | btrieve_bulk_retrieve_result_t |
| A Btrieve bulk retrieve result. More... | |
| typedef struct btrieve_client * | btrieve_client_t |
| A Btrieve client. More... | |
| typedef struct btrieve_file_attributes * | btrieve_file_attributes_t |
| A Btrieve file attributes. More... | |
| typedef struct btrieve_file_information * | btrieve_file_information_t |
| A Btrieve file information. More... | |
| typedef struct btrieve_file * | btrieve_file_t |
| A Btrieve file. More... | |
| typedef struct btrieve_filter * | btrieve_filter_t |
| A Btrieve filter. More... | |
| typedef struct btrieve_index_attributes * | btrieve_index_attributes_t |
| A Btrieve index attributes. More... | |
| typedef struct btrieve_key_segment * | btrieve_key_segment_t |
| A Btrieve key segment. More... | |
| typedef struct btrieve_version * | btrieve_version_t |
| A Btrieve version. More... | |
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. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveBulkCreatePayloadAllocate (btrieve_bulk_create_payload_t *btrieveBulkCreatePayloadPtr) |
| Allocate a Btrieve bulk create payload. More... | |
| btrieve_status_code_t | BtrieveBulkCreatePayloadFree (btrieve_bulk_create_payload_t bulkCreatePayload) |
| Free a Btrieve bulk create payload. More... | |
| btrieve_status_code_t | BtrieveBulkCreateResultAllocate (btrieve_bulk_create_result_t *btrieveBulkCreateResultPtr) |
| Allocate a Btrieve bulk create result. More... | |
| btrieve_status_code_t | BtrieveBulkCreateResultFree (btrieve_bulk_create_result_t bulkCreateResult) |
| Free a Btrieve bulk create result. More... | |
| btrieve_status_code_t | BtrieveBulkCreateResultGetLastStatusCode (btrieve_bulk_create_result_t bulkCreateResult) |
| Get last status code from a Btrieve bulk create result. More... | |
| int | BtrieveBulkCreateResultGetRecordCount (btrieve_bulk_create_result_t bulkCreateResult) |
| Get record count from a Btrieve bulk create result. More... | |
| long long | BtrieveBulkCreateResultGetRecordCursorPosition (btrieve_bulk_create_result_t bulkCreateResult, int recordNumber) |
| Get record cursor position from a Btrieve bulk create result. More... | |
| btrieve_status_code_t | BtrieveBulkDeleteAttributesAddFilter (btrieve_bulk_delete_attributes_t bulkDeleteAttributes, btrieve_filter_t filter) |
| Add a filter to a Btrieve bulk delete attributes. More... | |
| btrieve_status_code_t | BtrieveBulkDeleteAttributesAllocate (btrieve_bulk_delete_attributes_t *bulkDeleteAttributesPtr) |
| Allocate a Btrieve bulk delete attributes. More... | |
| btrieve_status_code_t | BtrieveBulkDeleteAttributesFree (btrieve_bulk_delete_attributes_t bulkDeleteAttributes) |
| Free a Btrieve bulk delete attributes. More... | |
| btrieve_status_code_t | BtrieveBulkDeleteAttributesSetMaximumRecordCount (btrieve_bulk_delete_attributes_t bulkDeleteAttributes, int maximumRecordCount) |
| Set maximum record count for a Btrieve bulk delete attributes. More... | |
| btrieve_status_code_t | BtrieveBulkDeleteAttributesSetMaximumRejectCount (btrieve_bulk_delete_attributes_t bulkDeleteAttributes, int maximumRejectCount) |
| Set maximum reject count for a Btrieve bulk delete attributes. More... | |
| btrieve_status_code_t | BtrieveBulkDeleteAttributesSetSkipCurrentRecord (btrieve_bulk_delete_attributes_t bulkDeleteAttributes, int skipCurrentRecord) |
| Set skip current record for a Btrieve bulk delete attributes. More... | |
| btrieve_status_code_t | BtrieveBulkDeleteResultAllocate (btrieve_bulk_delete_result_t *bulkDeleteResultPtr) |
| Allocate a Btrieve bulk delete result. More... | |
| btrieve_status_code_t | BtrieveBulkDeleteResultFree (btrieve_bulk_delete_result_t bulkDeleteResult) |
| Free a Btrieve bulk delete result. More... | |
| btrieve_status_code_t | BtrieveBulkDeleteResultGetLastStatusCode (btrieve_bulk_delete_result_t bulkDeleteResult) |
| Get last status code from a Btrieve bulk delete result. More... | |
| int | BtrieveBulkDeleteResultGetRecordCount (btrieve_bulk_delete_result_t bulkDeleteResult) |
| Get record count from a Btrieve bulk delete result. More... | |
| long long | BtrieveBulkDeleteResultGetRecordCursorPosition (btrieve_bulk_delete_result_t bulkDeleteResult, int recordNumber) |
| Get record cursor position from a Btrieve bulk delete result. More... | |
| btrieve_status_code_t | BtrieveBulkRetrieveAttributesAddField (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int offset, int length) |
| Add a field to a Btrieve bulk retrieve attributes. More... | |
| btrieve_status_code_t | BtrieveBulkRetrieveAttributesAddFilter (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, btrieve_filter_t filter) |
| Add a filter to a Btrieve bulk retrieve attributes. More... | |
| btrieve_status_code_t | BtrieveBulkRetrieveAttributesAllocate (btrieve_bulk_retrieve_attributes_t *bulkRetrieveAttributesPtr) |
| Allocate a Btrieve bulk retrieve attributes. More... | |
| btrieve_status_code_t | BtrieveBulkRetrieveAttributesFree (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes) |
| Free a Btrieve bulk retrieve attributes. More... | |
| btrieve_status_code_t | BtrieveBulkRetrieveAttributesSetMaximumRecordCount (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int maximumRecordCount) |
| Set maximum record count for a Btrieve bulk retrieve attributes. More... | |
| btrieve_status_code_t | BtrieveBulkRetrieveAttributesSetMaximumRejectCount (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int maximumRejectCount) |
| Set maximum reject count for a Btrieve bulk retrieve attributes. More... | |
| btrieve_status_code_t | BtrieveBulkRetrieveAttributesSetSkipCurrentRecord (btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, int skipCurrentRecord) |
| Set skip current record for a Btrieve bulk retrieve attributes. More... | |
| btrieve_status_code_t | BtrieveBulkRetrieveResultAllocate (btrieve_bulk_retrieve_result_t *bulkRetrieveResultPtr) |
| Allocate a Btrieve bulk retrieve result. More... | |
| btrieve_status_code_t | BtrieveBulkRetrieveResultFree (btrieve_bulk_retrieve_result_t bulkRetrieveResult) |
| Free a Btrieve bulk retrieve result. More... | |
| btrieve_status_code_t | BtrieveBulkRetrieveResultGetLastStatusCode (btrieve_bulk_retrieve_result_t bulkRetrieveResult) |
| Get last status code from a Btrieve bulk retrieve result. More... | |
| int | BtrieveBulkRetrieveResultGetRecord (btrieve_bulk_retrieve_result_t bulkRetrieveResult, int recordNumber, char *record, int recordSize) |
| Get record from a Btrieve bulk retrieve result. More... | |
| int | BtrieveBulkRetrieveResultGetRecordCount (btrieve_bulk_retrieve_result_t bulkRetrieveResult) |
| Get record count from a Btrieve bulk retrieve result. More... | |
| long long | BtrieveBulkRetrieveResultGetRecordCursorPosition (btrieve_bulk_retrieve_result_t bulkRetrieveResult, int recordNumber) |
| Get record cursor position from a Btrieve bulk retrieve result. More... | |
| int | BtrieveBulkRetrieveResultGetRecordLength (btrieve_bulk_retrieve_result_t bulkRetrieveResult, int recordNumber) |
| Get record length from a Btrieve bulk retrieve result. More... | |
| btrieve_status_code_t | BtrieveClientAllocate (btrieve_client_t *btrieveClientPtr, int serviceAgentIdentifier, int clientIdentifier) |
| Allocate a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientContinuousOperationBegin (btrieve_client_t client, const char *pathNames) |
| Continuous operation begin for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientContinuousOperationBeginW (btrieve_client_t client, const wchar_t *pathNames) |
| Continuous operation begin for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientContinuousOperationEnd (btrieve_client_t client, const char *pathNames) |
| Continuous operation end for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientContinuousOperationEndW (btrieve_client_t client, const wchar_t *pathNames) |
| Continuous operation end for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientFileClose (btrieve_client_t client, btrieve_file_t file) |
| File close for a Btrieve client. More... | |
| 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. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveClientFileDelete (btrieve_client_t client, const char *fileName) |
| File delete for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientFileDeleteW (btrieve_client_t client, const wchar_t *fileName) |
| File delete for a Btrieve client. More... | |
| 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. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveClientFileRename (btrieve_client_t client, const char *existingFileName, const char *newFileName) |
| File rename for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientFileRenameW (btrieve_client_t client, const wchar_t *existingFileName, const wchar_t *newFileName) |
| File rename for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientFree (btrieve_client_t client) |
| Free a Btrieve client. More... | |
| int | BtrieveClientGetClientIdentifier (btrieve_client_t client) |
| Get client identifier from a Btrieve client. More... | |
| 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. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveClientGetLastStatusCode (btrieve_client_t client) |
| Get last status code from a Btrieve client. More... | |
| int | BtrieveClientGetServiceAgentIdentifier (btrieve_client_t client) |
| Get service agent identifier from a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientGetVersion (btrieve_client_t client, btrieve_version_t version, btrieve_file_t file) |
| Get version from a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientLogin (btrieve_client_t client, const char *databaseURI) |
| Login for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientLoginW (btrieve_client_t client, const wchar_t *databaseURI) |
| Login for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientLogout (btrieve_client_t client, const char *databaseURI) |
| Logout for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientLogoutW (btrieve_client_t client, const wchar_t *databaseURI) |
| Logout for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientReset (btrieve_client_t client) |
| Reset for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientSetCurrentDirectory (btrieve_client_t client, const char *currentDirectory) |
| Set current directory for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientSetCurrentDirectoryW (btrieve_client_t client, const wchar_t *currentDirectory) |
| Set current directory for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientStop (btrieve_client_t client) |
| Stop for a Btrieve client. More... | |
| btrieve_status_code_t | BtrieveClientTransactionAbort (btrieve_client_t client) |
| Transaction abort for a Btrieve client. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveClientTransactionEnd (btrieve_client_t client) |
| Transaction end for a Btrieve client. More... | |
| const char * | BtrieveDataTypeToString (btrieve_data_type_t dataType) |
| Return a Btrieve data type as a string. More... | |
| const char * | BtrieveDuplicateModeToString (btrieve_duplicate_mode_t duplicateMode) |
| Return a Btrieve duplicate mode as a string. More... | |
| const char * | BtrieveEncryptionTypeToString (btrieve_encrypt_type_t encryptType) |
| Return a Btrieve encryption type as a string. More... | |
| btrieve_status_code_t | BtrieveFileAttributesAllocate (btrieve_file_attributes_t *btrieveFileAttributesPtr) |
| Allocate a Btrieve file attributes. More... | |
| btrieve_status_code_t | BtrieveFileAttributesFree (btrieve_file_attributes_t fileAttributes) |
| Free a Btrieve file attributes. More... | |
| btrieve_status_code_t | BtrieveFileAttributesSetBalancedIndexes (btrieve_file_attributes_t fileAttributes, int enableBalancedIndexes) |
| Set balanced indexes for a Btrieve file attributes. More... | |
| btrieve_status_code_t | BtrieveFileAttributesSetFileVersion (btrieve_file_attributes_t fileAttributes, btrieve_file_version_t fileVersion) |
| Set file version for a Btrieve file attributes. More... | |
| btrieve_status_code_t | BtrieveFileAttributesSetFixedRecordLength (btrieve_file_attributes_t fileAttributes, int fixedRecordLength) |
| Set fixed record length for a Btrieve file attributes. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveFileAttributesSetKeyOnly (btrieve_file_attributes_t fileAttributes, int enableKeyOnly) |
| Set key only for a Btrieve file attributes. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveFileAttributesSetPreallocatedPageCount (btrieve_file_attributes_t fileAttributes, int preallocatedPageCount) |
| Set preallocated page count for a Btrieve file attributes. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveFileAttributesSetReservedDuplicatePointerCount (btrieve_file_attributes_t fileAttributes, int reservedDuplicatePointerCount) |
| Set reserved duplicate pointer count for a Btrieve file attributes. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| long long | BtrieveFileGetCursorPosition (btrieve_file_t file) |
| Get cursor position from a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileGetInformation (btrieve_file_t file, btrieve_file_information_t fileInformation) |
| Get information from a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileGetLastStatusCode (btrieve_file_t file) |
| Get last status code from a Btrieve file. More... | |
| 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. More... | |
| int | BtrieveFileGetPercentage (btrieve_file_t file, btrieve_index_t index, const char *key, int keyLength, long long cursorPosition) |
| Get percentage from a Btrieve file. More... | |
| long long | BtrieveFileGetRecordCreateTime (btrieve_file_t file) |
| Get record create time from a Btrieve file. More... | |
| long long | BtrieveFileGetRecordUpdateTime (btrieve_file_t file) |
| Get record update time from a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileIndexCreate (btrieve_file_t file, const btrieve_index_attributes_t indexAttributes) |
| Index create for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileIndexDrop (btrieve_file_t file, btrieve_index_t index) |
| Index drop for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileInformationAllocate (btrieve_file_information_t *btrieveFileInformationPtr) |
| Allocate a Btrieve file information. More... | |
| btrieve_status_code_t | BtrieveFileInformationFree (btrieve_file_information_t fileInformation) |
| Free a Btrieve file information. More... | |
| int | BtrieveFileInformationGetBalancedIndexes (btrieve_file_information_t fileInformation) |
| Get balanced indexes from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetClientTransactions (btrieve_file_information_t fileInformation) |
| Get client transactions from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetContinuousOperation (btrieve_file_information_t fileInformation) |
| Get continuous operation from a Btrieve file information. More... | |
| long long | BtrieveFileInformationGetDuplicateRecordConflictCursorPosition (btrieve_file_information_t fileInformation) |
| Get duplicate record conflict cursor position from a Btrieve file information. More... | |
| btrieve_index_t | BtrieveFileInformationGetDuplicateRecordConflictIndex (btrieve_file_information_t fileInformation) |
| Get duplicate record conflict index from a Btrieve file information. More... | |
| btrieve_encrypt_type_t | BtrieveFileInformationGetEncryptionType (btrieve_file_information_t fileInformation) |
| Get encryption type from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetExplicitLocks (btrieve_file_information_t fileInformation) |
| Get explicit locks from a Btrieve file information. More... | |
| btrieve_file_version_t | BtrieveFileInformationGetFileVersion (btrieve_file_information_t fileInformation) |
| Get file version from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetFixedRecordLength (btrieve_file_information_t fileInformation) |
| Get fixed record length from a Btrieve file information. More... | |
| btrieve_free_space_threshold_t | BtrieveFileInformationGetFreeSpaceThreshold (btrieve_file_information_t fileInformation) |
| Get free space threshold from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetGatewayMajorVersion (btrieve_file_information_t fileInformation) |
| Get gateway major version from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetGatewayMinorVersion (btrieve_file_information_t fileInformation) |
| Get gateway minor version from a Btrieve file information. More... | |
| btrieve_status_code_t | BtrieveFileInformationGetGatewayName (btrieve_file_information_t fileInformation, char *name, int nameSize) |
| Get gateway name from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetGatewayPatchLevel (btrieve_file_information_t fileInformation) |
| Get gateway patch level from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetGatewayPlatform (btrieve_file_information_t fileInformation) |
| Get gateway platform from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetHandleCount (btrieve_file_information_t fileInformation) |
| Get handle count from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetIdentifier (btrieve_file_information_t fileInformation) |
| Get identifier from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetIndexCount (btrieve_file_information_t fileInformation) |
| Get index count from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetKeyOnly (btrieve_file_information_t fileInformation) |
| Get key only from a Btrieve file information. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveFileInformationGetLastStatusCode (btrieve_file_information_t fileInformation) |
| Get last status code from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetLockOwnerClientIdentifier (btrieve_file_information_t fileInformation) |
| Get lock owner client identifier from a Btrieve file information. More... | |
| btrieve_lock_mode_t | BtrieveFileInformationGetLockOwnerExplicitLockMode (btrieve_file_information_t fileInformation) |
| Get lock owner explicit lock mode from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetLockOwnerFileLock (btrieve_file_information_t fileInformation) |
| Get lock owner file lock from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetLockOwnerImplicitLock (btrieve_file_information_t fileInformation) |
| Get lock owner implicit lock from a Btrieve file information. More... | |
| btrieve_index_t | BtrieveFileInformationGetLockOwnerIndex (btrieve_file_information_t fileInformation) |
| Get lock owner index from a Btrieve file information. More... | |
| btrieve_status_code_t | BtrieveFileInformationGetLockOwnerName (btrieve_file_information_t fileInformation, char *name, int nameSize) |
| Get lock owner name from a Btrieve file information. More... | |
| btrieve_page_lock_type_t | BtrieveFileInformationGetLockOwnerPageLockType (btrieve_file_information_t fileInformation) |
| Get lock owner page lock type from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetLockOwnerRecordLock (btrieve_file_information_t fileInformation) |
| Get lock owner record lock from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetLockOwnerSameProcess (btrieve_file_information_t fileInformation) |
| Get lock owner same process from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetLockOwnerServiceAgentIdentifier (btrieve_file_information_t fileInformation) |
| Get lock owner service agent identifier from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetLockOwnerTimeInTransaction (btrieve_file_information_t fileInformation) |
| Get lock owner time in transaction from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetLockOwnerTransactionLevel (btrieve_file_information_t fileInformation) |
| Get lock owner transaction level from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetLockOwnerWriteHold (btrieve_file_information_t fileInformation) |
| Get lock owner write hold from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetLockOwnerWriteNoWait (btrieve_file_information_t fileInformation) |
| Get lock owner write no wait from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetLoggable (btrieve_file_information_t fileInformation) |
| Get loggable from a Btrieve file information. More... | |
| btrieve_index_t | BtrieveFileInformationGetLogIndex (btrieve_file_information_t fileInformation) |
| Get log index from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetOpenTimestamp (btrieve_file_information_t fileInformation) |
| Get open timestamp from a Btrieve file information. More... | |
| btrieve_owner_mode_t | BtrieveFileInformationGetOwnerMode (btrieve_file_information_t fileInformation) |
| Get owner mode from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetPageCompression (btrieve_file_information_t fileInformation) |
| Get page compression from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetPagePreallocation (btrieve_file_information_t fileInformation) |
| Get page preallocation from a Btrieve file information. More... | |
| btrieve_page_size_t | BtrieveFileInformationGetPageSize (btrieve_file_information_t fileInformation) |
| Get page size from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetReadOnly (btrieve_file_information_t fileInformation) |
| Get read only from a Btrieve file information. More... | |
| btrieve_record_compression_mode_t | BtrieveFileInformationGetRecordCompressionMode (btrieve_file_information_t fileInformation) |
| Get record compression mode from a Btrieve file information. More... | |
| long long | BtrieveFileInformationGetRecordCount (btrieve_file_information_t fileInformation) |
| Get record count from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetReferentialIntegrityConstraints (btrieve_file_information_t fileInformation) |
| Get referential integrity constraints from a Btrieve file information. More... | |
| long long | BtrieveFileInformationGetReferentialIntegrityCursorPosition (btrieve_file_information_t fileInformation) |
| Get referential integrity cursor position from a Btrieve file information. More... | |
| btrieve_status_code_t | BtrieveFileInformationGetReferentialIntegrityFileName (btrieve_file_information_t fileInformation, char *name, int nameSize) |
| Get referential integrity file name from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetReferentialIntegrityOperationCode (btrieve_file_information_t fileInformation) |
| Get referential integrity operation code from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabaseAuthenticationByDatabase (btrieve_file_information_t fileInformation) |
| Get security current database authentication by database from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabaseAuthorizationByDatabase (btrieve_file_information_t fileInformation) |
| Get security current database authorization by database from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabaseBtpasswd (btrieve_file_information_t fileInformation) |
| Get security current database btpasswd from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabaseExplicit (btrieve_file_information_t fileInformation) |
| Get security current database explicit from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabaseImplicit (btrieve_file_information_t fileInformation) |
| Get security current database implicit from a Btrieve file information. More... | |
| btrieve_status_code_t | BtrieveFileInformationGetSecurityCurrentDatabaseName (btrieve_file_information_t fileInformation, char *name, int nameSize) |
| Get security current database name from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabasePAM (btrieve_file_information_t fileInformation) |
| Get security current database PAM from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabaseRTSSComplete (btrieve_file_information_t fileInformation) |
| Get security current database RTSS complete from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabaseRTSSDisabled (btrieve_file_information_t fileInformation) |
| Get security current database RTSS disabled from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabaseRTSSPreauthorized (btrieve_file_information_t fileInformation) |
| Get security current database RTSS preauthorized from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabaseTrusted (btrieve_file_information_t fileInformation) |
| Get security current database trusted from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabaseWindowsNamedPipe (btrieve_file_information_t fileInformation) |
| Get security current database windows named pipe from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityCurrentDatabaseWorkgroup (btrieve_file_information_t fileInformation) |
| Get security current database workgroup from a Btrieve file information. More... | |
| btrieve_status_code_t | BtrieveFileInformationGetSecurityCurrentUserName (btrieve_file_information_t fileInformation, char *name, int nameSize) |
| Get security current user name from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandleAuthenticationByDatabase (btrieve_file_information_t fileInformation) |
| Get security handle authentication by database from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandleAuthorizationByDatabase (btrieve_file_information_t fileInformation) |
| Get security handle authorization by database from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandleBtpasswd (btrieve_file_information_t fileInformation) |
| Get security handle btpasswd from a Btrieve file information. More... | |
| btrieve_status_code_t | BtrieveFileInformationGetSecurityHandleDatabaseName (btrieve_file_information_t fileInformation, char *name, int nameSize) |
| Get security handle database name from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandleExplicit (btrieve_file_information_t fileInformation) |
| Get security handle explicit from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandleImplicit (btrieve_file_information_t fileInformation) |
| Get security handle implicit from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandlePAM (btrieve_file_information_t fileInformation) |
| Get security handle PAM from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandleRTSSComplete (btrieve_file_information_t fileInformation) |
| Get security handle RTSS complete from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandleRTSSDisabled (btrieve_file_information_t fileInformation) |
| Get security handle RTSS disabled from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandleRTSSPreauthorized (btrieve_file_information_t fileInformation) |
| Get security handle RTSS preauthorized from a Btrieve file information. More... | |
| btrieve_status_code_t | BtrieveFileInformationGetSecurityHandleTableName (btrieve_file_information_t fileInformation, char *name, int nameSize) |
| Get security handle table name from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandleTrusted (btrieve_file_information_t fileInformation) |
| Get security handle trusted from a Btrieve file information. More... | |
| btrieve_status_code_t | BtrieveFileInformationGetSecurityHandleUserName (btrieve_file_information_t fileInformation, char *name, int nameSize) |
| Get security handle user name from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandleWindowsNamedPipe (btrieve_file_information_t fileInformation) |
| Get security handle windows named pipe from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityHandleWorkgroup (btrieve_file_information_t fileInformation) |
| Get security handle workgroup from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionAlter (btrieve_file_information_t fileInformation) |
| Get security permission alter from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionCreateFile (btrieve_file_information_t fileInformation) |
| Get security permission create file from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionCreateRecord (btrieve_file_information_t fileInformation) |
| Get security permission create record from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionCreateStoredProcedure (btrieve_file_information_t fileInformation) |
| Get security permission create stored procedure from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionCreateView (btrieve_file_information_t fileInformation) |
| Get security permission create view from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionDelete (btrieve_file_information_t fileInformation) |
| Get security permission delete from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionExecute (btrieve_file_information_t fileInformation) |
| Get security permission execute from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionNoRights (btrieve_file_information_t fileInformation) |
| Get security permission no rights from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionOpen (btrieve_file_information_t fileInformation) |
| Get security permission open from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionRead (btrieve_file_information_t fileInformation) |
| Get security permission read from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionRefer (btrieve_file_information_t fileInformation) |
| Get security permission refer from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSecurityPermissionUpdate (btrieve_file_information_t fileInformation) |
| Get security permission update from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSegmentCount (btrieve_file_information_t fileInformation) |
| Get segment count from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSegmented (btrieve_file_information_t fileInformation) |
| Get segmented from a Btrieve file information. More... | |
| 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. More... | |
| int | BtrieveFileInformationGetSystemData (btrieve_file_information_t fileInformation) |
| Get system data from a Btrieve file information. More... | |
| btrieve_system_data_mode_t | BtrieveFileInformationGetSystemDataMode (btrieve_file_information_t fileInformation) |
| Get system data mode from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSystemIndex (btrieve_file_information_t fileInformation) |
| Get system index from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSystemIndexSize (btrieve_file_information_t fileInformation) |
| Get system index size from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetSystemIndexVersion (btrieve_file_information_t fileInformation) |
| Get system index version from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetUnusedDuplicatePointerCount (btrieve_file_information_t fileInformation) |
| Get unused duplicate pointer count from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetUnusedPageCount (btrieve_file_information_t fileInformation) |
| Get unused page count from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetUsageCount (btrieve_file_information_t fileInformation) |
| Get usage count from a Btrieve file information. More... | |
| btrieve_variable_length_records_mode_t | BtrieveFileInformationGetVariableLengthRecordsMode (btrieve_file_information_t fileInformation) |
| Get variable length records mode from a Btrieve file information. More... | |
| int | BtrieveFileInformationGetWrongOwner (btrieve_file_information_t fileInformation) |
| Get wrong owner from a Btrieve file information. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveFileKeyRetrieveFirst (btrieve_file_t file, btrieve_index_t index, char *key, int keySize) |
| Key retrieve first for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileKeyRetrieveLast (btrieve_file_t file, btrieve_index_t index, char *key, int keySize) |
| Key retrieve last for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileKeyRetrieveNext (btrieve_file_t file, char *key, int keySize) |
| Key retrieve next for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileKeyRetrievePrevious (btrieve_file_t file, char *key, int keySize) |
| Key retrieve previous for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileRecordAppendChunk (btrieve_file_t file, const char *chunk, int chunkLength) |
| Record append chunk for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileRecordCreate (btrieve_file_t file, char *record, int recordLength) |
| Record create for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileRecordDelete (btrieve_file_t file) |
| Record delete for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileRecordDeleteChunk (btrieve_file_t file, int offset, int chunkLength) |
| Record delete chunk for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileRecordInsertChunk (btrieve_file_t file, int offset, const char *chunk, int chunkLength) |
| Record insert chunk for a Btrieve file. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveFileRecordTruncate (btrieve_file_t file, int offset) |
| Record truncate for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileRecordUnlock (btrieve_file_t file, btrieve_unlock_mode_t unlockMode) |
| Record unlock for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileRecordUpdate (btrieve_file_t file, const char *record, int recordLength) |
| Record update for a Btrieve file. More... | |
| btrieve_status_code_t | BtrieveFileRecordUpdateChunk (btrieve_file_t file, int offset, const char *chunk, int chunkLength) |
| Record update chunk for a Btrieve file. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveFileUnlockCursorPosition (btrieve_file_t file, long long cursorPosition) |
| Unlock cursor position for a Btrieve file. More... | |
| const char * | BtrieveFileVersionToString (btrieve_file_version_t fileVersion) |
| Return a Btrieve file version as a string. More... | |
| btrieve_status_code_t | BtrieveFilterAllocate (btrieve_filter_t *btrieveFilterPtr) |
| Allocate a Btrieve filter. More... | |
| btrieve_status_code_t | BtrieveFilterFree (btrieve_filter_t filter) |
| Free a Btrieve filter. More... | |
| btrieve_status_code_t | BtrieveFilterSetACSMode (btrieve_filter_t filter, btrieve_acs_mode_t ACSMode) |
| Set ACS mode for a Btrieve filter. More... | |
| btrieve_status_code_t | BtrieveFilterSetACSName (btrieve_filter_t filter, const char *name) |
| Set ACS name for a Btrieve filter. More... | |
| btrieve_status_code_t | BtrieveFilterSetACSUserDefined (btrieve_filter_t filter, const char *name) |
| Set ACS user defined for a Btrieve filter. More... | |
| btrieve_status_code_t | BtrieveFilterSetComparison (btrieve_filter_t filter, btrieve_comparison_t comparison) |
| Set comparison for a Btrieve filter. More... | |
| btrieve_status_code_t | BtrieveFilterSetComparisonConstant (btrieve_filter_t filter, const char *constant, int constantLength) |
| Set comparison constant for a Btrieve filter. More... | |
| btrieve_status_code_t | BtrieveFilterSetComparisonField (btrieve_filter_t filter, int offset) |
| Set comparison field for a Btrieve filter. More... | |
| btrieve_status_code_t | BtrieveFilterSetConnector (btrieve_filter_t filter, btrieve_connector_t connector) |
| Set connector for a Btrieve filter. More... | |
| btrieve_status_code_t | BtrieveFilterSetField (btrieve_filter_t filter, int offset, int length, btrieve_data_type_t dataType) |
| Set field for a Btrieve filter. More... | |
| btrieve_status_code_t | BtrieveFilterSetLikeCodePageName (btrieve_filter_t filter, const char *name) |
| Set like code page name for a Btrieve filter. More... | |
| btrieve_status_code_t | BtrieveFilterSetSystemField (btrieve_filter_t filter, btrieve_system_field_t systemField) |
| Set system field for a Btrieve filter. More... | |
| const char * | BtrieveFreeSpaceThresholdToString (btrieve_free_space_threshold_t freeSpaceThreshold) |
| Return a Btrieve free space threshold as a string. More... | |
| btrieve_status_code_t | BtrieveIndexAttributesAddKeySegment (btrieve_index_attributes_t indexAttributes, btrieve_key_segment_t keySegment) |
| segment for a Btrieve index attributes Addkey More... | |
| btrieve_status_code_t | BtrieveIndexAttributesAllocate (btrieve_index_attributes_t *btrieveIndexAttributesPtr) |
| Allocate a Btrieve index attributes. More... | |
| btrieve_status_code_t | BtrieveIndexAttributesFree (btrieve_index_attributes_t indexAttributes) |
| Free a Btrieve index attributes. More... | |
| btrieve_status_code_t | BtrieveIndexAttributesSetACSMode (btrieve_index_attributes_t indexAttributes, btrieve_acs_mode_t ACSMode) |
| Set ACS mode for a Btrieve index attributes. More... | |
| btrieve_status_code_t | BtrieveIndexAttributesSetACSName (btrieve_index_attributes_t indexAttributes, const char *ACSName) |
| Set ACS name for a Btrieve index attributes. More... | |
| btrieve_status_code_t | BtrieveIndexAttributesSetACSNumber (btrieve_index_attributes_t indexAttributes, int ACSNumber) |
| Set ACS number for a Btrieve index attributes. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveIndexAttributesSetDuplicateMode (btrieve_index_attributes_t indexAttributes, btrieve_duplicate_mode_t duplicateMode) |
| Set duplicate mode for a Btrieve index attributes. More... | |
| btrieve_status_code_t | BtrieveIndexAttributesSetIndex (btrieve_index_attributes_t indexAttributes, btrieve_index_t index) |
| Set index for a Btrieve IndexAttributes. More... | |
| btrieve_status_code_t | BtrieveIndexAttributesSetModifiable (btrieve_index_attributes_t indexAttributes, int enableModifiable) |
| Set modifiable for a Btrieve index attributes. More... | |
| const char * | BtrieveIndexToString (btrieve_index_t index) |
| Return a Btrieve index as a string. More... | |
| btrieve_status_code_t | BtrieveKeySegmentAllocate (btrieve_key_segment_t *btrieveKeySegmentPtr) |
| Allocate a Btrieve key segment. More... | |
| btrieve_status_code_t | BtrieveKeySegmentFree (btrieve_key_segment_t keySegment) |
| Free a Btrieve key segment. More... | |
| btrieve_acs_mode_t | BtrieveKeySegmentGetACSMode (btrieve_key_segment_t keySegment) |
| Get ACS mode from a Btrieve key segment. More... | |
| int | BtrieveKeySegmentGetACSNumber (btrieve_key_segment_t keySegment) |
| Get ACS number from a Btrieve key segment. More... | |
| btrieve_data_type_t | BtrieveKeySegmentGetDataType (btrieve_key_segment_t keySegment) |
| Get data type from a Btrieve key segment. More... | |
| int | BtrieveKeySegmentGetDescendingSortOrder (btrieve_key_segment_t keySegment) |
| Get descending sort order from a Btrieve key segment. More... | |
| btrieve_duplicate_mode_t | BtrieveKeySegmentGetDuplicateMode (btrieve_key_segment_t keySegment) |
| Get duplicate mode from a Btrieve key segment. More... | |
| btrieve_index_t | BtrieveKeySegmentGetIndex (btrieve_key_segment_t keySegment) |
| Get index from a Btrieve key segment. More... | |
| int | BtrieveKeySegmentGetKeyContinues (btrieve_key_segment_t keySegment) |
| Get key continues from a Btrieve key segment. More... | |
| btrieve_status_code_t | BtrieveKeySegmentGetLastStatusCode (btrieve_key_segment_t keySegment) |
| Get last status code from a Btrieve key segment. More... | |
| int | BtrieveKeySegmentGetLength (btrieve_key_segment_t keySegment) |
| Get length from a Btrieve key segment. More... | |
| int | BtrieveKeySegmentGetModifiable (btrieve_key_segment_t keySegment) |
| Get modifiable from a Btrieve key segment. More... | |
| int | BtrieveKeySegmentGetNullAllSegments (btrieve_key_segment_t keySegment) |
| Get null all segments from a Btrieve key segment. More... | |
| int | BtrieveKeySegmentGetNullAnySegment (btrieve_key_segment_t keySegment) |
| Get null any segment from a Btrieve key segment. More... | |
| btrieve_null_key_mode_t | BtrieveKeySegmentGetNullKeyMode (btrieve_key_segment_t keySegment) |
| Get null key mode from a Btrieve key segment. More... | |
| int | BtrieveKeySegmentGetNullValue (btrieve_key_segment_t keySegment) |
| Get null value from a Btrieve key segment. More... | |
| int | BtrieveKeySegmentGetOffset (btrieve_key_segment_t keySegment) |
| Get offset from a Btrieve key segment. More... | |
| int | BtrieveKeySegmentGetSegmented (btrieve_key_segment_t keySegment) |
| Get segmented from a Btrieve key segment. More... | |
| long long | BtrieveKeySegmentGetUniqueValueCount (btrieve_key_segment_t keySegment) |
| Get unique value count from a Btrieve key segment. More... | |
| int | BtrieveKeySegmentGetUseNumberedACS (btrieve_key_segment_t keySegment) |
| Get use numbered ACS from a Btrieve key segment. More... | |
| btrieve_status_code_t | BtrieveKeySegmentSetDescendingSortOrder (btrieve_key_segment_t keySegment, int setDescendingSortOrder) |
| Set descending sort order for a Btrieve key segment. More... | |
| 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. More... | |
| 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. More... | |
| btrieve_status_code_t | BtrieveKeySegmentSetNullValue (btrieve_key_segment_t keySegment, int nullValue) |
| Set null value for a Btrieve key segment. More... | |
| const char * | BtrieveLockModeToString (btrieve_lock_mode_t lockMode) |
| Return a Btrieve lock mode as a string. More... | |
| const char * | BtrieveNullKeyModeToString (btrieve_null_key_mode_t nullKeyMode) |
| Return a Btrieve null key mode as a string. More... | |
| const char * | BtrieveOwnerModeToString (btrieve_owner_mode_t ownerMode) |
| Return a Btrieve owner mode as a string. More... | |
| const char * | BtrievePageLockTypeToString (btrieve_page_lock_type_t pageLockType) |
| Return a Btrieve page lock type as a string. More... | |
| const char * | BtrievePageSizeToString (btrieve_page_size_t pageSize) |
| Return a Btrieve page size as a string. More... | |
| const char * | BtrieveRecordCompressionModeToString (btrieve_record_compression_mode_t recordCompressionMode) |
| Return a Btrieve record compression mode as a string. More... | |
| const char * | BtrieveStatusCodeToString (btrieve_status_code_t statusCode) |
| Return a Btrieve status code as a string. More... | |
| const char * | BtrieveSystemDataModeToString (btrieve_system_data_mode_t systemDataMode) |
| Return a Btrieve system data mode as a string. More... | |
| const char * | BtrieveSystemFieldToString (btrieve_system_field_t systemField) |
| Return a Btrieve system field as a string. More... | |
| long long | BtrieveTimestampToUnixEpochMicroseconds (long long timestamp) |
| Convert a Btrieve TIMESTAMP to a Unix Epoch timestamp in microseconds. More... | |
| long long | BtrieveUnixEpochMicrosecondsToTimestamp (long long microseconds) |
| Convert a Unix Epoch based timestamp in microseconds to a Btrieve TIMESTAMP. More... | |
| const char * | BtrieveVariableLengthRecordsModeToString (btrieve_variable_length_records_mode_t variableLengthRecordsMode) |
| Return a Btrieve variable length records mode as a string. More... | |
| btrieve_status_code_t | BtrieveVersionAllocate (btrieve_version_t *btrieveVersionPtr) |
| Allocate a Btrieve version. More... | |
| btrieve_status_code_t | BtrieveVersionFree (btrieve_version_t version) |
| Free a Btrieve version. More... | |
| int | BtrieveVersionGetClientRevisionNumber (btrieve_version_t version) |
| Get client revision number from a Btrieve version. More... | |
| int | BtrieveVersionGetClientVersionNumber (btrieve_version_t version) |
| Get client version number from a Btrieve version. More... | |
| btrieve_version_type_t | BtrieveVersionGetClientVersionType (btrieve_version_t version) |
| Get client version type from a Btrieve version. More... | |
| btrieve_status_code_t | BtrieveVersionGetLastStatusCode (btrieve_version_t version) |
| Get last status code from a Btrieve version. More... | |
| int | BtrieveVersionGetLocalRevisionNumber (btrieve_version_t version) |
| Get local revision number from a Btrieve version. More... | |
| int | BtrieveVersionGetLocalVersionNumber (btrieve_version_t version) |
| Get local version number from a Btrieve version. More... | |
| btrieve_version_type_t | BtrieveVersionGetLocalVersionType (btrieve_version_t version) |
| Get local version type from a Btrieve version. More... | |
| int | BtrieveVersionGetRemoteRevisionNumber (btrieve_version_t version) |
| Get remote revision number from a Btrieve version. More... | |
| int | BtrieveVersionGetRemoteVersionNumber (btrieve_version_t version) |
| Get remote version number from a Btrieve version. More... | |
| btrieve_version_type_t | BtrieveVersionGetRemoteVersionType (btrieve_version_t version) |
| Get remote version type from a Btrieve version. More... | |
| const char * | BtrieveVersionTypeToString (btrieve_version_type_t versionType) |
| Return a Btrieve version type as a string. More... | |
| #define BTRIEVE_MAXIMUM_BULK_RECORD_COUNT 25804 |
The Btrieve maximum bulk record count.
| #define BTRIEVE_MAXIMUM_KEY_LENGTH 255 |
The Btrieve maximum key segment length.
| #define BTRIEVE_MAXIMUM_RECORD_LENGTH (64 * 1024 - 1) |
The Btrieve maximum record length.
| 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 |
| 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.
| enum btrieve_acs_mode_t |
The Btrieve alternate collation sequence modes.
| enum btrieve_comparison_t |
The Btrieve comparisons.
| enum btrieve_connector_t |
The Btrieve create modes.
| Enumerator | |
|---|---|
| BTRIEVE_CREATE_MODE_OVERWRITE | Overwrite. |
| BTRIEVE_CREATE_MODE_NO_OVERWRITE | No overwrite. |
| BTRIEVE_CREATE_MODE_UNKNOWN | Unknown. |
| enum btrieve_data_type_t |
The Btrieve data types.
| enum btrieve_disk_drive_t |
The Btrieve disk drives.
The Btrieve duplicate modes.
The Btrieve file encryption types.
The Btrieve file versions.
The Btrieve free space thresholds.
| enum btrieve_index_t |
The Btrieve indexes.
The Btrieve location modes.
| 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. |
| enum btrieve_lock_mode_t |
The Btrieve lock modes.
The Btrieve null key modes.
| 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. |
| enum btrieve_open_mode_t |
The Btrieve open modes.
| enum btrieve_owner_mode_t |
The Btrieve file owner modes.
The Btrieve page lock type.
| enum btrieve_page_size_t |
The Btrieve page sizes.
The Btrieve status codes.
The Btrieve system data modes.
The Btrieve system fields.
| Enumerator | |
|---|---|
| BTRIEVE_SYSTEM_FIELD_CREATE_TIME | Create time. |
| BTRIEVE_SYSTEM_FIELD_UPDATE_TIME | Update time. |
| BTRIEVE_SYSTEM_FIELD_UNKNOWN | Unknown. |
The Btrieve version types.
| const char* BtrieveACSModeToString | ( | btrieve_acs_mode_t | ACSMode | ) |
Return a Btrieve ACS mode as a string.
| [in] | ACSMode | The ACS mode. |
| 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.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkCreatePayloadAllocate | ( | btrieve_bulk_create_payload_t * | btrieveBulkCreatePayloadPtr | ) |
Allocate a Btrieve bulk create payload.
| [out] | btrieveBulkCreatePayloadPtr | The Btrieve bulk create payload pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkCreatePayloadFree | ( | btrieve_bulk_create_payload_t | bulkCreatePayload | ) |
Free a Btrieve bulk create payload.
| [in] | bulkCreatePayload | The bulk create payload. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkCreateResultAllocate | ( | btrieve_bulk_create_result_t * | btrieveBulkCreateResultPtr | ) |
Allocate a Btrieve bulk create result.
| [out] | btrieveBulkCreateResultPtr | The Btrieve bulk create result pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkCreateResultFree | ( | btrieve_bulk_create_result_t | bulkCreateResult | ) |
Free a Btrieve bulk create result.
| [in] | bulkCreateResult | The bulk create result. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkCreateResultGetLastStatusCode | ( | btrieve_bulk_create_result_t | bulkCreateResult | ) |
Get last status code from a Btrieve bulk create result.
| [in] | bulkCreateResult | The bulk create result. See BtrieveFileBulkCreate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveBulkCreateResultGetRecordCount | ( | btrieve_bulk_create_result_t | bulkCreateResult | ) |
Get record count from a Btrieve bulk create result.
| [in] | bulkCreateResult | The bulk create result. See BtrieveFileBulkCreate(). |
| >= 0 | The record count. |
| -1 | An error has occurred. Use BtrieveBulkCreateResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| long long BtrieveBulkCreateResultGetRecordCursorPosition | ( | btrieve_bulk_create_result_t | bulkCreateResult, |
| int | recordNumber | ||
| ) |
Get record cursor position from a Btrieve bulk create result.
| [in] | bulkCreateResult | The bulk create result. See BtrieveFileBulkCreate(). |
| [in] | recordNumber | The record number. |
| >= 0 | The record cursor position . |
| -1 | An error has occurred. Use BtrieveBulkCreateResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_status_code_t BtrieveBulkDeleteAttributesAddFilter | ( | btrieve_bulk_delete_attributes_t | bulkDeleteAttributes, |
| btrieve_filter_t | filter | ||
| ) |
Add a filter to a Btrieve bulk delete attributes.
| [in] | bulkDeleteAttributes | The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate(). |
| [in] | filter | The filter. See BtrieveFilterAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkDeleteAttributesAllocate | ( | btrieve_bulk_delete_attributes_t * | bulkDeleteAttributesPtr | ) |
Allocate a Btrieve bulk delete attributes.
| [out] | bulkDeleteAttributesPtr | The Btrieve bulk delete attributes pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkDeleteAttributesFree | ( | btrieve_bulk_delete_attributes_t | bulkDeleteAttributes | ) |
Free a Btrieve bulk delete attributes.
| [in] | bulkDeleteAttributes | The bulk delete attributes. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkDeleteAttributesSetMaximumRecordCount | ( | btrieve_bulk_delete_attributes_t | bulkDeleteAttributes, |
| int | maximumRecordCount | ||
| ) |
Set maximum record count for a Btrieve bulk delete attributes.
| [in] | bulkDeleteAttributes | The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate(). |
| [in] | maximumRecordCount | The maximum record count. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkDeleteAttributesSetMaximumRejectCount | ( | btrieve_bulk_delete_attributes_t | bulkDeleteAttributes, |
| int | maximumRejectCount | ||
| ) |
Set maximum reject count for a Btrieve bulk delete attributes.
| [in] | bulkDeleteAttributes | The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate(). |
| [in] | maximumRejectCount | The maximum reject count. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkDeleteAttributesSetSkipCurrentRecord | ( | btrieve_bulk_delete_attributes_t | bulkDeleteAttributes, |
| int | skipCurrentRecord | ||
| ) |
Set skip current record for a Btrieve bulk delete attributes.
| [in] | bulkDeleteAttributes | The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate(). |
| [in] | skipCurrentRecord | Skip current record? |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkDeleteResultAllocate | ( | btrieve_bulk_delete_result_t * | bulkDeleteResultPtr | ) |
Allocate a Btrieve bulk delete result.
| [out] | bulkDeleteResultPtr | The Btrieve bulk delete results pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkDeleteResultFree | ( | btrieve_bulk_delete_result_t | bulkDeleteResult | ) |
Free a Btrieve bulk delete result.
| [in] | bulkDeleteResult | The bulk delete result. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkDeleteResultGetLastStatusCode | ( | btrieve_bulk_delete_result_t | bulkDeleteResult | ) |
Get last status code from a Btrieve bulk delete result.
| [in] | bulkDeleteResult | The bulk delete result. See BtrieveFileBulkDeleteNext() and BtrieveFileBulkDeletePrevious(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveBulkDeleteResultGetRecordCount | ( | btrieve_bulk_delete_result_t | bulkDeleteResult | ) |
Get record count from a Btrieve bulk delete result.
| [in] | bulkDeleteResult | The bulk delete result. See BtrieveFileBulkDeleteNext() and BtrieveFileBulkDeletePrevious(). |
| >= 0 | The record count. |
| -1 | An error has occurred. Use BtrieveBulkDeleteResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| long long BtrieveBulkDeleteResultGetRecordCursorPosition | ( | btrieve_bulk_delete_result_t | bulkDeleteResult, |
| int | recordNumber | ||
| ) |
Get record cursor position from a Btrieve bulk delete result.
| [in] | bulkDeleteResult | The bulk delete result. See BtrieveFileBulkDeleteNext() and BtrieveFileBulkDeletePrevious(). |
| [in] | recordNumber | The record number. |
| >= 0 | The record cursor position . |
| -1 | An error has occurred. Use BtrieveBulkDeleteResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_status_code_t BtrieveBulkRetrieveAttributesAddField | ( | btrieve_bulk_retrieve_attributes_t | bulkRetrieveAttributes, |
| int | offset, | ||
| int | length | ||
| ) |
Add a field to a Btrieve bulk retrieve attributes.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkRetrieveAttributesAddFilter | ( | btrieve_bulk_retrieve_attributes_t | bulkRetrieveAttributes, |
| btrieve_filter_t | filter | ||
| ) |
Add a filter to a Btrieve bulk retrieve attributes.
| [in] | bulkRetrieveAttributes | The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate(). |
| [in] | filter | The filter. See BtrieveFilterAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkRetrieveAttributesAllocate | ( | btrieve_bulk_retrieve_attributes_t * | bulkRetrieveAttributesPtr | ) |
Allocate a Btrieve bulk retrieve attributes.
| [out] | bulkRetrieveAttributesPtr | The Btrieve bulk retrieve attributes pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkRetrieveAttributesFree | ( | btrieve_bulk_retrieve_attributes_t | bulkRetrieveAttributes | ) |
Free a Btrieve bulk retrieve attributes.
| [in] | bulkRetrieveAttributes | The bulk retrieve attributes. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkRetrieveAttributesSetMaximumRecordCount | ( | btrieve_bulk_retrieve_attributes_t | bulkRetrieveAttributes, |
| int | maximumRecordCount | ||
| ) |
Set maximum record count for a Btrieve bulk retrieve attributes.
| [in] | bulkRetrieveAttributes | The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate(). |
| [in] | maximumRecordCount | The maximum record count. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkRetrieveAttributesSetMaximumRejectCount | ( | btrieve_bulk_retrieve_attributes_t | bulkRetrieveAttributes, |
| int | maximumRejectCount | ||
| ) |
Set maximum reject count for a Btrieve bulk retrieve attributes.
| [in] | bulkRetrieveAttributes | The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate(). |
| [in] | maximumRejectCount | The maximum reject count. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkRetrieveAttributesSetSkipCurrentRecord | ( | btrieve_bulk_retrieve_attributes_t | bulkRetrieveAttributes, |
| int | skipCurrentRecord | ||
| ) |
Set skip current record for a Btrieve bulk retrieve attributes.
| [in] | bulkRetrieveAttributes | The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate(). |
| [in] | skipCurrentRecord | Skip current record? |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkRetrieveResultAllocate | ( | btrieve_bulk_retrieve_result_t * | bulkRetrieveResultPtr | ) |
Allocate a Btrieve bulk retrieve result.
| [out] | bulkRetrieveResultPtr | The Btrieve bulk retrieve results pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkRetrieveResultFree | ( | btrieve_bulk_retrieve_result_t | bulkRetrieveResult | ) |
Free a Btrieve bulk retrieve result.
| [in] | bulkRetrieveResult | The bulk retrieve result. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveBulkRetrieveResultGetLastStatusCode | ( | btrieve_bulk_retrieve_result_t | bulkRetrieveResult | ) |
Get last status code from a Btrieve bulk retrieve result.
| [in] | bulkRetrieveResult | The bulk retrieve result. See BtrieveFileBulkRetrieveNext() and BtrieveFileBulkRetrievePrevious(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveBulkRetrieveResultGetRecord | ( | btrieve_bulk_retrieve_result_t | bulkRetrieveResult, |
| int | recordNumber, | ||
| char * | record, | ||
| int | recordSize | ||
| ) |
Get record from a Btrieve bulk retrieve result.
| [in] | bulkRetrieveResult | The bulk retrieve result. See BtrieveFileBulkRetrieveNext() and BtrieveFileBulkRetrievePrevious(). |
| [in] | recordNumber | The record number. |
| [out] | record | The record. |
| [in] | recordSize | The record size. |
| >= 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. |
| int BtrieveBulkRetrieveResultGetRecordCount | ( | btrieve_bulk_retrieve_result_t | bulkRetrieveResult | ) |
Get record count from a Btrieve bulk retrieve result.
| [in] | bulkRetrieveResult | The bulk retrieve result. See BtrieveFileBulkRetrieveNext() and BtrieveFileBulkRetrievePrevious(). |
| >= 0 | The record count. |
| -1 | An error has occurred. Use BtrieveBulkRetrieveResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| long long BtrieveBulkRetrieveResultGetRecordCursorPosition | ( | btrieve_bulk_retrieve_result_t | bulkRetrieveResult, |
| int | recordNumber | ||
| ) |
Get record cursor position from a Btrieve bulk retrieve result.
| [in] | bulkRetrieveResult | The bulk retrieve result. See BtrieveFileBulkRetrieveNext() and BtrieveFileBulkRetrievePrevious(). |
| [in] | recordNumber | The record number. |
| >= 0 | The record cursor position . |
| -1 | An error has occurred. Use BtrieveBulkRetrieveResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveBulkRetrieveResultGetRecordLength | ( | btrieve_bulk_retrieve_result_t | bulkRetrieveResult, |
| int | recordNumber | ||
| ) |
Get record length from a Btrieve bulk retrieve result.
| [in] | bulkRetrieveResult | The bulk retrieve result. See BtrieveFileBulkRetrieveNext() and BtrieveFileBulkRetrievePrevious(). |
| [in] | recordNumber | The record number. |
| >= 0 | The record length. |
| -1 | An error has occurred. Use BtrieveBulkRetrieveResultGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_status_code_t BtrieveClientAllocate | ( | btrieve_client_t * | btrieveClientPtr, |
| int | serviceAgentIdentifier, | ||
| int | clientIdentifier | ||
| ) |
Allocate a Btrieve client.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientContinuousOperationBegin | ( | btrieve_client_t | client, |
| const char * | pathNames | ||
| ) |
Continuous operation begin for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | pathNames | The path names. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientContinuousOperationBeginW | ( | btrieve_client_t | client, |
| const wchar_t * | pathNames | ||
| ) |
Continuous operation begin for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | pathNames | The path names. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientContinuousOperationEnd | ( | btrieve_client_t | client, |
| const char * | pathNames | ||
| ) |
Continuous operation end for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | pathNames | The path names. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientContinuousOperationEndW | ( | btrieve_client_t | client, |
| const wchar_t * | pathNames | ||
| ) |
Continuous operation end for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | pathNames | The path names. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientFileClose | ( | btrieve_client_t | client, |
| btrieve_file_t | file | ||
| ) |
File close for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | file | The file. See BtrieveClientFileOpen(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientFileDelete | ( | btrieve_client_t | client, |
| const char * | fileName | ||
| ) |
File delete for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | fileName | The file name. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientFileDeleteW | ( | btrieve_client_t | client, |
| const wchar_t * | fileName | ||
| ) |
File delete for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | fileName | The file name. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientFileRename | ( | btrieve_client_t | client, |
| const char * | existingFileName, | ||
| const char * | newFileName | ||
| ) |
File rename for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | existingFileName | The existing file name. |
| [in] | newFileName | The new file name. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientFileRenameW | ( | btrieve_client_t | client, |
| const wchar_t * | existingFileName, | ||
| const wchar_t * | newFileName | ||
| ) |
File rename for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | existingFileName | The existing file name. |
| [in] | newFileName | The new file name. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientFree | ( | btrieve_client_t | client | ) |
Free a Btrieve client.
| [in] | client | The client. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveClientGetClientIdentifier | ( | btrieve_client_t | client | ) |
Get client identifier from a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| >= 0 | The client identifier. |
| -1 | An error has occurred. Use BtrieveClientGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| 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.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientGetLastStatusCode | ( | btrieve_client_t | client | ) |
Get last status code from a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveClientGetServiceAgentIdentifier | ( | btrieve_client_t | client | ) |
Get service agent identifier from a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| >= 0 | The service agent identifier. |
| -1 | An error has occurred. Use BtrieveClientGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_status_code_t BtrieveClientGetVersion | ( | btrieve_client_t | client, |
| btrieve_version_t | version, | ||
| btrieve_file_t | file | ||
| ) |
Get version from a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [out] | version | The version. See BtrieveVersionAllocate(). |
| [in] | file | The file. See BtrieveClientFileOpen(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientLogin | ( | btrieve_client_t | client, |
| const char * | databaseURI | ||
| ) |
Login for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | databaseURI | The database URI. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientLoginW | ( | btrieve_client_t | client, |
| const wchar_t * | databaseURI | ||
| ) |
Login for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | databaseURI | The database URI. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientLogout | ( | btrieve_client_t | client, |
| const char * | databaseURI | ||
| ) |
Logout for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | databaseURI | The database URI. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientLogoutW | ( | btrieve_client_t | client, |
| const wchar_t * | databaseURI | ||
| ) |
Logout for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | databaseURI | The database URI. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientReset | ( | btrieve_client_t | client | ) |
Reset for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientSetCurrentDirectory | ( | btrieve_client_t | client, |
| const char * | currentDirectory | ||
| ) |
Set current directory for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | currentDirectory | The current directory. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientSetCurrentDirectoryW | ( | btrieve_client_t | client, |
| const wchar_t * | currentDirectory | ||
| ) |
Set current directory for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | currentDirectory | The current directory. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientStop | ( | btrieve_client_t | client | ) |
Stop for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientTransactionAbort | ( | btrieve_client_t | client | ) |
Transaction abort for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [in] | client | The client. See BtrieveClientAllocate(). |
| [in] | transactionMode | The transaction mode. |
| [in] | lockMode | The lock mode. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveClientTransactionEnd | ( | btrieve_client_t | client | ) |
Transaction end for a Btrieve client.
| [in] | client | The client. See BtrieveClientAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| const char* BtrieveDataTypeToString | ( | btrieve_data_type_t | dataType | ) |
Return a Btrieve data type as a string.
| [in] | dataType | The data type. |
| const char* BtrieveDuplicateModeToString | ( | btrieve_duplicate_mode_t | duplicateMode | ) |
Return a Btrieve duplicate mode as a string.
| [in] | duplicateMode | The duplicate mode. |
| const char* BtrieveEncryptionTypeToString | ( | btrieve_encrypt_type_t | encryptType | ) |
Return a Btrieve encryption type as a string.
| [in] | encryptType | The encrypt type. |
| btrieve_status_code_t BtrieveFileAttributesAllocate | ( | btrieve_file_attributes_t * | btrieveFileAttributesPtr | ) |
Allocate a Btrieve file attributes.
| [out] | btrieveFileAttributesPtr | The Btrieve file attributes pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileAttributesFree | ( | btrieve_file_attributes_t | fileAttributes | ) |
Free a Btrieve file attributes.
| [in] | fileAttributes | The file attributes. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileAttributesSetBalancedIndexes | ( | btrieve_file_attributes_t | fileAttributes, |
| int | enableBalancedIndexes | ||
| ) |
Set balanced indexes for a Btrieve file attributes.
| [in] | fileAttributes | The file attributes. See BtrieveFileAttributesAllocate(). |
| [in] | enableBalancedIndexes | Enable balanced indexes? |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileAttributesSetFileVersion | ( | btrieve_file_attributes_t | fileAttributes, |
| btrieve_file_version_t | fileVersion | ||
| ) |
Set file version for a Btrieve file attributes.
| [in] | fileAttributes | The file attributes. See BtrieveFileAttributesAllocate(). |
| [in] | fileVersion | The file version. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileAttributesSetFixedRecordLength | ( | btrieve_file_attributes_t | fileAttributes, |
| int | fixedRecordLength | ||
| ) |
Set fixed record length for a Btrieve file attributes.
| [in] | fileAttributes | The file attributes. See BtrieveFileAttributesAllocate(). |
| [in] | fixedRecordLength | The fixed record length. The fixed record length must be between 1 and BTRIEVE_MAXIMUM_RECORD_LENGTH, inclusive. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [in] | fileAttributes | The file attributes. See BtrieveFileAttributesAllocate(). |
| [in] | freeSpaceThreshold | The free space threshold. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileAttributesSetKeyOnly | ( | btrieve_file_attributes_t | fileAttributes, |
| int | enableKeyOnly | ||
| ) |
Set key only for a Btrieve file attributes.
| [in] | fileAttributes | The file attributes. See BtrieveFileAttributesAllocate(). |
| [in] | enableKeyOnly | Enable key only? |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [in] | fileAttributes | The file attributes. See BtrieveFileAttributesAllocate(). |
| [in] | pageSize | The page size. |
| [in] | enablePageCompression | Enable page compression? |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileAttributesSetPreallocatedPageCount | ( | btrieve_file_attributes_t | fileAttributes, |
| int | preallocatedPageCount | ||
| ) |
Set preallocated page count for a Btrieve file attributes.
| [in] | fileAttributes | The file attributes. See BtrieveFileAttributesAllocate(). |
| [in] | preallocatedPageCount | The preallocated page count. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [in] | fileAttributes | The file attributes. See BtrieveFileAttributesAllocate(). |
| [in] | recordCompressionMode | The record compression mode. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileAttributesSetReservedDuplicatePointerCount | ( | btrieve_file_attributes_t | fileAttributes, |
| int | reservedDuplicatePointerCount | ||
| ) |
Set reserved duplicate pointer count for a Btrieve file attributes.
| [in] | fileAttributes | The file attributes. See BtrieveFileAttributesAllocate(). |
| [in] | reservedDuplicatePointerCount | The reserved duplicate pointer count. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [in] | fileAttributes | The file attributes. See BtrieveFileAttributesAllocate(). |
| [in] | systemDataMode | The system data mode. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [in] | fileAttributes | The file attributes. See BtrieveFileAttributesAllocate(). |
| [in] | variableLengthRecordsMode | The variable length records mode. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | bulkCreatePayload | The bulk create payload. See BtrieveBulkCreatePayloadAllocate(). |
| [out] | bulkCreateResult | The bulk create result. See BtrieveBulkCreateResultAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | bulkDeleteAttributes | The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate(). |
| [out] | bulkDeleteResult | The bulk delete result. See BtrieveBulkDeleteResultAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | bulkDeleteAttributes | The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate(). |
| [out] | bulkDeleteResult | The bulk delete result. See BtrieveBulkDeleteResultAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| long long BtrieveFileGetCursorPosition | ( | btrieve_file_t | file | ) |
Get cursor position from a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| >= 0 | The cursor position. |
| -1 | An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_status_code_t BtrieveFileGetInformation | ( | btrieve_file_t | file, |
| btrieve_file_information_t | fileInformation | ||
| ) |
Get information from a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [out] | fileInformation | The file information. See BtrieveFileInformationAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileGetLastStatusCode | ( | btrieve_file_t | file | ) |
Get last status code from a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [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. |
| >= 0 | The numerator. |
| -1 | An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileGetPercentage | ( | btrieve_file_t | file, |
| btrieve_index_t | index, | ||
| const char * | key, | ||
| int | keyLength, | ||
| long long | cursorPosition | ||
| ) |
Get percentage from a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | index | The index. |
| [in] | key | The key. |
| [in] | keyLength | The key length. |
| [in] | cursorPosition | The cursor position. |
| >= 0 | The percentage. |
| -1 | An error has occurred. Use BtrieveFileGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| long long BtrieveFileGetRecordCreateTime | ( | btrieve_file_t | file | ) |
Get record create time from a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| > 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. |
| long long BtrieveFileGetRecordUpdateTime | ( | btrieve_file_t | file | ) |
Get record update time from a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| > 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. |
| btrieve_status_code_t BtrieveFileIndexCreate | ( | btrieve_file_t | file, |
| const btrieve_index_attributes_t | indexAttributes | ||
| ) |
Index create for a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | indexAttributes | The index attributes. See BtrieveIndexAttributesAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileIndexDrop | ( | btrieve_file_t | file, |
| btrieve_index_t | index | ||
| ) |
Index drop for a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | index | The index. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileInformationAllocate | ( | btrieve_file_information_t * | btrieveFileInformationPtr | ) |
Allocate a Btrieve file information.
| [out] | btrieveFileInformationPtr | The Btrieve file information pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileInformationFree | ( | btrieve_file_information_t | fileInformation | ) |
Free a Btrieve file information.
| [in] | fileInformation | The file information. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveFileInformationGetBalancedIndexes | ( | btrieve_file_information_t | fileInformation | ) |
Get balanced indexes from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetClientTransactions | ( | btrieve_file_information_t | fileInformation | ) |
Get client transactions from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetContinuousOperation | ( | btrieve_file_information_t | fileInformation | ) |
Get continuous operation from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| long long BtrieveFileInformationGetDuplicateRecordConflictCursorPosition | ( | btrieve_file_information_t | fileInformation | ) |
Get duplicate record conflict cursor position from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 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. |
| btrieve_index_t BtrieveFileInformationGetDuplicateRecordConflictIndex | ( | btrieve_file_information_t | fileInformation | ) |
Get duplicate record conflict index from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| btrieve_encrypt_type_t BtrieveFileInformationGetEncryptionType | ( | btrieve_file_information_t | fileInformation | ) |
Get encryption type from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| int BtrieveFileInformationGetExplicitLocks | ( | btrieve_file_information_t | fileInformation | ) |
Get explicit locks from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| btrieve_file_version_t BtrieveFileInformationGetFileVersion | ( | btrieve_file_information_t | fileInformation | ) |
Get file version from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| int BtrieveFileInformationGetFixedRecordLength | ( | btrieve_file_information_t | fileInformation | ) |
Get fixed record length from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The fixed record length. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_free_space_threshold_t BtrieveFileInformationGetFreeSpaceThreshold | ( | btrieve_file_information_t | fileInformation | ) |
Get free space threshold from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| int BtrieveFileInformationGetGatewayMajorVersion | ( | btrieve_file_information_t | fileInformation | ) |
Get gateway major version from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The gateway major version. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetGatewayMinorVersion | ( | btrieve_file_information_t | fileInformation | ) |
Get gateway minor version from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The gateway minor version. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_status_code_t BtrieveFileInformationGetGatewayName | ( | btrieve_file_information_t | fileInformation, |
| char * | name, | ||
| int | nameSize | ||
| ) |
Get gateway name from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| [out] | name | The name. |
| [in] | nameSize | The name size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveFileInformationGetGatewayPatchLevel | ( | btrieve_file_information_t | fileInformation | ) |
Get gateway patch level from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The gateway patch level. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetGatewayPlatform | ( | btrieve_file_information_t | fileInformation | ) |
Get gateway platform from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The gateway platform. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetHandleCount | ( | btrieve_file_information_t | fileInformation | ) |
Get handle count from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The handle count. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetIdentifier | ( | btrieve_file_information_t | fileInformation | ) |
Get identifier from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The identifier. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetIndexCount | ( | btrieve_file_information_t | fileInformation | ) |
Get index count from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The index count. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetKeyOnly | ( | btrieve_file_information_t | fileInformation | ) |
Get key only from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| 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.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| [out] | keySegment | The key segment. See BtrieveKeySegmentAllocate(). |
| [in] | keySegmentNumber | The key segment number. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileInformationGetLastStatusCode | ( | btrieve_file_information_t | fileInformation | ) |
Get last status code from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveFileInformationGetLockOwnerClientIdentifier | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner client identifier from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The lock owner client identifier. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_lock_mode_t BtrieveFileInformationGetLockOwnerExplicitLockMode | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner explicit lock mode from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| int BtrieveFileInformationGetLockOwnerFileLock | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner file lock from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetLockOwnerImplicitLock | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner implicit lock from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| btrieve_index_t BtrieveFileInformationGetLockOwnerIndex | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner index from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| btrieve_status_code_t BtrieveFileInformationGetLockOwnerName | ( | btrieve_file_information_t | fileInformation, |
| char * | name, | ||
| int | nameSize | ||
| ) |
Get lock owner name from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| [out] | name | The name. |
| [in] | nameSize | The name size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_page_lock_type_t BtrieveFileInformationGetLockOwnerPageLockType | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner page lock type from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| int BtrieveFileInformationGetLockOwnerRecordLock | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner record lock from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetLockOwnerSameProcess | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner same process from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetLockOwnerServiceAgentIdentifier | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner service agent identifier from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 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. |
| int BtrieveFileInformationGetLockOwnerTimeInTransaction | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner time in transaction from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 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. |
| int BtrieveFileInformationGetLockOwnerTransactionLevel | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner transaction level from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The lock owner transaction level. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetLockOwnerWriteHold | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner write hold from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetLockOwnerWriteNoWait | ( | btrieve_file_information_t | fileInformation | ) |
Get lock owner write no wait from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetLoggable | ( | btrieve_file_information_t | fileInformation | ) |
Get loggable from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| btrieve_index_t BtrieveFileInformationGetLogIndex | ( | btrieve_file_information_t | fileInformation | ) |
Get log index from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| int BtrieveFileInformationGetOpenTimestamp | ( | btrieve_file_information_t | fileInformation | ) |
Get open timestamp from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The open timestamp. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_owner_mode_t BtrieveFileInformationGetOwnerMode | ( | btrieve_file_information_t | fileInformation | ) |
Get owner mode from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| int BtrieveFileInformationGetPageCompression | ( | btrieve_file_information_t | fileInformation | ) |
Get page compression from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetPagePreallocation | ( | btrieve_file_information_t | fileInformation | ) |
Get page preallocation from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| btrieve_page_size_t BtrieveFileInformationGetPageSize | ( | btrieve_file_information_t | fileInformation | ) |
Get page size from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| int BtrieveFileInformationGetReadOnly | ( | btrieve_file_information_t | fileInformation | ) |
Get read only from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| btrieve_record_compression_mode_t BtrieveFileInformationGetRecordCompressionMode | ( | btrieve_file_information_t | fileInformation | ) |
Get record compression mode from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| long long BtrieveFileInformationGetRecordCount | ( | btrieve_file_information_t | fileInformation | ) |
Get record count from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The record count. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetReferentialIntegrityConstraints | ( | btrieve_file_information_t | fileInformation | ) |
Get referential integrity constraints from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| long long BtrieveFileInformationGetReferentialIntegrityCursorPosition | ( | btrieve_file_information_t | fileInformation | ) |
Get referential integrity cursor position from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The referential integrity cursor position. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_status_code_t BtrieveFileInformationGetReferentialIntegrityFileName | ( | btrieve_file_information_t | fileInformation, |
| char * | name, | ||
| int | nameSize | ||
| ) |
Get referential integrity file name from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| [out] | name | The name. |
| [in] | nameSize | The name size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveFileInformationGetReferentialIntegrityOperationCode | ( | btrieve_file_information_t | fileInformation | ) |
Get referential integrity operation code from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The referential integrity operation code. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetSecurityCurrentDatabaseAuthenticationByDatabase | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database authentication by database from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityCurrentDatabaseAuthorizationByDatabase | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database authorization by database from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityCurrentDatabaseBtpasswd | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database btpasswd from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityCurrentDatabaseExplicit | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database explicit from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityCurrentDatabaseImplicit | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database implicit from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| btrieve_status_code_t BtrieveFileInformationGetSecurityCurrentDatabaseName | ( | btrieve_file_information_t | fileInformation, |
| char * | name, | ||
| int | nameSize | ||
| ) |
Get security current database name from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| [out] | name | The name. |
| [in] | nameSize | The name size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveFileInformationGetSecurityCurrentDatabasePAM | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database PAM from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityCurrentDatabaseRTSSComplete | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database RTSS complete from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityCurrentDatabaseRTSSDisabled | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database RTSS disabled from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityCurrentDatabaseRTSSPreauthorized | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database RTSS preauthorized from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityCurrentDatabaseTrusted | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database trusted from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityCurrentDatabaseWindowsNamedPipe | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database windows named pipe from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityCurrentDatabaseWorkgroup | ( | btrieve_file_information_t | fileInformation | ) |
Get security current database workgroup from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| btrieve_status_code_t BtrieveFileInformationGetSecurityCurrentUserName | ( | btrieve_file_information_t | fileInformation, |
| char * | name, | ||
| int | nameSize | ||
| ) |
Get security current user name from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| [out] | name | The name. |
| [in] | nameSize | The name size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveFileInformationGetSecurityHandleAuthenticationByDatabase | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle authentication by database from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityHandleAuthorizationByDatabase | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle authorization by database from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityHandleBtpasswd | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle btpasswd from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| btrieve_status_code_t BtrieveFileInformationGetSecurityHandleDatabaseName | ( | btrieve_file_information_t | fileInformation, |
| char * | name, | ||
| int | nameSize | ||
| ) |
Get security handle database name from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| [out] | name | The name. |
| [in] | nameSize | The name size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveFileInformationGetSecurityHandleExplicit | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle explicit from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityHandleImplicit | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle implicit from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityHandlePAM | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle PAM from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityHandleRTSSComplete | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle RTSS complete from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityHandleRTSSDisabled | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle RTSS disabled from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityHandleRTSSPreauthorized | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle RTSS preauthorized from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| btrieve_status_code_t BtrieveFileInformationGetSecurityHandleTableName | ( | btrieve_file_information_t | fileInformation, |
| char * | name, | ||
| int | nameSize | ||
| ) |
Get security handle table name from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| [out] | name | The name. |
| [in] | nameSize | The name size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveFileInformationGetSecurityHandleTrusted | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle trusted from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| btrieve_status_code_t BtrieveFileInformationGetSecurityHandleUserName | ( | btrieve_file_information_t | fileInformation, |
| char * | name, | ||
| int | nameSize | ||
| ) |
Get security handle user name from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| [out] | name | The name. |
| [in] | nameSize | The name size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveFileInformationGetSecurityHandleWindowsNamedPipe | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle windows named pipe from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityHandleWorkgroup | ( | btrieve_file_information_t | fileInformation | ) |
Get security handle workgroup from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionAlter | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission alter from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionCreateFile | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission create file from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionCreateRecord | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission create record from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionCreateStoredProcedure | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission create stored procedure from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionCreateView | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission create view from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionDelete | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission delete from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionExecute | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission execute from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionNoRights | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission no rights from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionOpen | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission open from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionRead | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission read from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionRefer | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission refer from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSecurityPermissionUpdate | ( | btrieve_file_information_t | fileInformation | ) |
Get security permission update from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| int BtrieveFileInformationGetSegmentCount | ( | btrieve_file_information_t | fileInformation | ) |
Get segment count from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The segment count. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetSegmented | ( | btrieve_file_information_t | fileInformation | ) |
Get segmented from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| 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.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| [in] | segmentFileNumber | The segment file number. |
| [out] | name | The name. |
| [in] | nameSize | The name size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveFileInformationGetSystemData | ( | btrieve_file_information_t | fileInformation | ) |
Get system data from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| 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. |
| btrieve_system_data_mode_t BtrieveFileInformationGetSystemDataMode | ( | btrieve_file_information_t | fileInformation | ) |
Get system data mode from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| int BtrieveFileInformationGetSystemIndex | ( | btrieve_file_information_t | fileInformation | ) |
Get system index from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| 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. |
| int BtrieveFileInformationGetSystemIndexSize | ( | btrieve_file_information_t | fileInformation | ) |
Get system index size from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The system index size. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetSystemIndexVersion | ( | btrieve_file_information_t | fileInformation | ) |
Get system index version from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The system index version. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetUnusedDuplicatePointerCount | ( | btrieve_file_information_t | fileInformation | ) |
Get unused duplicate pointer count from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The unused duplicate pointer count. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetUnusedPageCount | ( | btrieve_file_information_t | fileInformation | ) |
Get unused page count from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The unused page count. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveFileInformationGetUsageCount | ( | btrieve_file_information_t | fileInformation | ) |
Get usage count from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| >= 0 | The usage count. |
| -1 | An error has occurred. Use BtrieveFileInformationGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_variable_length_records_mode_t BtrieveFileInformationGetVariableLengthRecordsMode | ( | btrieve_file_information_t | fileInformation | ) |
Get variable length records mode from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| != 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. |
| int BtrieveFileInformationGetWrongOwner | ( | btrieve_file_information_t | fileInformation | ) |
Get wrong owner from a Btrieve file information.
| [in] | fileInformation | The file information. See BtrieveFileGetInformation(). |
| > 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. |
| 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.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | comparison | The comparison. |
| [in] | index | The index. |
| [out] | key | The key. |
| [in] | keyLength | The key length. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileKeyRetrieveFirst | ( | btrieve_file_t | file, |
| btrieve_index_t | index, | ||
| char * | key, | ||
| int | keySize | ||
| ) |
Key retrieve first for a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | index | The index. |
| [out] | key | The key. |
| [in] | keySize | The key size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileKeyRetrieveLast | ( | btrieve_file_t | file, |
| btrieve_index_t | index, | ||
| char * | key, | ||
| int | keySize | ||
| ) |
Key retrieve last for a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | index | The index. |
| [out] | key | The key. |
| [in] | keySize | The key size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileKeyRetrieveNext | ( | btrieve_file_t | file, |
| char * | key, | ||
| int | keySize | ||
| ) |
Key retrieve next for a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [out] | key | The key. |
| [in] | keySize | The key size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileKeyRetrievePrevious | ( | btrieve_file_t | file, |
| char * | key, | ||
| int | keySize | ||
| ) |
Key retrieve previous for a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [out] | key | The key. |
| [in] | keySize | The key size. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileRecordAppendChunk | ( | btrieve_file_t | file, |
| const char * | chunk, | ||
| int | chunkLength | ||
| ) |
Record append chunk for a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | chunk | The chunk. |
| [in] | chunkLength | The chunk length. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileRecordCreate | ( | btrieve_file_t | file, |
| char * | record, | ||
| int | recordLength | ||
| ) |
Record create for a Btrieve file.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileRecordDelete | ( | btrieve_file_t | file | ) |
Record delete for a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileRecordDeleteChunk | ( | btrieve_file_t | file, |
| int | offset, | ||
| int | chunkLength | ||
| ) |
Record delete chunk for a Btrieve file.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileRecordInsertChunk | ( | btrieve_file_t | file, |
| int | offset, | ||
| const char * | chunk, | ||
| int | chunkLength | ||
| ) |
Record insert chunk for a Btrieve file.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [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. |
| >= 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. |
| 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.
| [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. |
| >= 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. |
| 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.
| [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. |
| >= 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. |
| 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.
| [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. |
| >= 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. |
| 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.
| [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. |
| >= 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. |
| 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.
| [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. |
| >= 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. |
| 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.
| [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. |
| >= 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. |
| 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.
| [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. |
| >= 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. |
| 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.
| [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. |
| >= 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. |
| btrieve_status_code_t BtrieveFileRecordTruncate | ( | btrieve_file_t | file, |
| int | offset | ||
| ) |
Record truncate for a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | offset | The offset. If offset is -1, then the current offset is used. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileRecordUnlock | ( | btrieve_file_t | file, |
| btrieve_unlock_mode_t | unlockMode | ||
| ) |
Record unlock for a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | unlockMode | The unlock mode. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileRecordUpdate | ( | btrieve_file_t | file, |
| const char * | record, | ||
| int | recordLength | ||
| ) |
Record update for a Btrieve file.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileRecordUpdateChunk | ( | btrieve_file_t | file, |
| int | offset, | ||
| const char * | chunk, | ||
| int | chunkLength | ||
| ) |
Record update chunk for a Btrieve file.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [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? |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFileUnlockCursorPosition | ( | btrieve_file_t | file, |
| long long | cursorPosition | ||
| ) |
Unlock cursor position for a Btrieve file.
| [in] | file | The file. See BtrieveClientFileOpen(). |
| [in] | cursorPosition | The cursor position. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| const char* BtrieveFileVersionToString | ( | btrieve_file_version_t | fileVersion | ) |
Return a Btrieve file version as a string.
| [in] | fileVersion | The file version. |
| btrieve_status_code_t BtrieveFilterAllocate | ( | btrieve_filter_t * | btrieveFilterPtr | ) |
Allocate a Btrieve filter.
| [out] | btrieveFilterPtr | The Btrieve filter pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFilterFree | ( | btrieve_filter_t | filter | ) |
Free a Btrieve filter.
| [in] | filter | The filter. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFilterSetACSMode | ( | btrieve_filter_t | filter, |
| btrieve_acs_mode_t | ACSMode | ||
| ) |
Set ACS mode for a Btrieve filter.
| [in] | filter | The filter. See BtrieveFilterAllocate(). |
| [in] | ACSMode | The ACS mode. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFilterSetACSName | ( | btrieve_filter_t | filter, |
| const char * | name | ||
| ) |
Set ACS name for a Btrieve filter.
| [in] | filter | The filter. See BtrieveFilterAllocate(). |
| [in] | name | The name. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFilterSetACSUserDefined | ( | btrieve_filter_t | filter, |
| const char * | name | ||
| ) |
Set ACS user defined for a Btrieve filter.
| [in] | filter | The filter. See BtrieveFilterAllocate(). |
| [in] | name | The name. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFilterSetComparison | ( | btrieve_filter_t | filter, |
| btrieve_comparison_t | comparison | ||
| ) |
Set comparison for a Btrieve filter.
| [in] | filter | The filter. See BtrieveFilterAllocate(). |
| [in] | comparison | The comparison. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFilterSetComparisonConstant | ( | btrieve_filter_t | filter, |
| const char * | constant, | ||
| int | constantLength | ||
| ) |
Set comparison constant for a Btrieve filter.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFilterSetComparisonField | ( | btrieve_filter_t | filter, |
| int | offset | ||
| ) |
Set comparison field for a Btrieve filter.
| [in] | filter | The filter. See BtrieveFilterAllocate(). |
| [in] | offset | The comparison field offset. Offset must be less than BTRIEVE_MAXIMUM_RECORD_LENGTH. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFilterSetConnector | ( | btrieve_filter_t | filter, |
| btrieve_connector_t | connector | ||
| ) |
Set connector for a Btrieve filter.
| [in] | filter | The filter. See BtrieveFilterAllocate(). |
| [in] | connector | The connector. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFilterSetField | ( | btrieve_filter_t | filter, |
| int | offset, | ||
| int | length, | ||
| btrieve_data_type_t | dataType | ||
| ) |
Set field for a Btrieve filter.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFilterSetLikeCodePageName | ( | btrieve_filter_t | filter, |
| const char * | name | ||
| ) |
Set like code page name for a Btrieve filter.
| [in] | filter | The filter. See BtrieveFilterAllocate(). |
| [in] | name | The name. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveFilterSetSystemField | ( | btrieve_filter_t | filter, |
| btrieve_system_field_t | systemField | ||
| ) |
Set system field for a Btrieve filter.
| [in] | filter | The filter. See BtrieveFilterAllocate(). |
| [in] | systemField | The system field. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| const char* BtrieveFreeSpaceThresholdToString | ( | btrieve_free_space_threshold_t | freeSpaceThreshold | ) |
Return a Btrieve free space threshold as a string.
| [in] | freeSpaceThreshold | The free space threshold. |
| btrieve_status_code_t BtrieveIndexAttributesAddKeySegment | ( | btrieve_index_attributes_t | indexAttributes, |
| btrieve_key_segment_t | keySegment | ||
| ) |
segment for a Btrieve index attributes Addkey
| [in] | indexAttributes | The index attributes. See BtrieveIndexAttributesAllocate(). |
| [in] | keySegment | The key segment. See BtrieveKeySegmentAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveIndexAttributesAllocate | ( | btrieve_index_attributes_t * | btrieveIndexAttributesPtr | ) |
Allocate a Btrieve index attributes.
| [out] | btrieveIndexAttributesPtr | The Btrieve index attributes pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveIndexAttributesFree | ( | btrieve_index_attributes_t | indexAttributes | ) |
Free a Btrieve index attributes.
| [in] | indexAttributes | The index attributes. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveIndexAttributesSetACSMode | ( | btrieve_index_attributes_t | indexAttributes, |
| btrieve_acs_mode_t | ACSMode | ||
| ) |
Set ACS mode for a Btrieve index attributes.
| [in] | indexAttributes | The index attributes. See BtrieveIndexAttributesAllocate(). |
| [in] | ACSMode | The ACS mode. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveIndexAttributesSetACSName | ( | btrieve_index_attributes_t | indexAttributes, |
| const char * | ACSName | ||
| ) |
Set ACS name for a Btrieve index attributes.
| [in] | indexAttributes | The index attributes. See BtrieveIndexAttributesAllocate(). |
| [in] | ACSName | The ACS name. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveIndexAttributesSetACSNumber | ( | btrieve_index_attributes_t | indexAttributes, |
| int | ACSNumber | ||
| ) |
Set ACS number for a Btrieve index attributes.
| [in] | indexAttributes | The index attributes. See BtrieveIndexAttributesAllocate(). |
| [in] | ACSNumber | The ACS number. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [in] | indexAttributes | The index attributes. See BtrieveIndexAttributesAllocate(). |
| [in] | ACSName | The ACS name. |
| [in] | ACSMap | The ACS map. |
| [in] | ACSMapLength | The ACS map length. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveIndexAttributesSetDuplicateMode | ( | btrieve_index_attributes_t | indexAttributes, |
| btrieve_duplicate_mode_t | duplicateMode | ||
| ) |
Set duplicate mode for a Btrieve index attributes.
| [in] | indexAttributes | The index attributes. See BtrieveIndexAttributesAllocate(). |
| [in] | duplicateMode | The duplicate mode. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveIndexAttributesSetIndex | ( | btrieve_index_attributes_t | indexAttributes, |
| btrieve_index_t | index | ||
| ) |
Set index for a Btrieve IndexAttributes.
| [in] | index | The index. |
| [in] | indexAttributes | The index attributes. See BtrieveIndexAttributesAllocate(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveIndexAttributesSetModifiable | ( | btrieve_index_attributes_t | indexAttributes, |
| int | enableModifiable | ||
| ) |
Set modifiable for a Btrieve index attributes.
| [in] | indexAttributes | The index attributes. See BtrieveIndexAttributesAllocate(). |
| [in] | enableModifiable | Enable modifiable? |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| const char* BtrieveIndexToString | ( | btrieve_index_t | index | ) |
Return a Btrieve index as a string.
| [in] | index | The index. |
| btrieve_status_code_t BtrieveKeySegmentAllocate | ( | btrieve_key_segment_t * | btrieveKeySegmentPtr | ) |
Allocate a Btrieve key segment.
| [out] | btrieveKeySegmentPtr | The Btrieve key segment pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveKeySegmentFree | ( | btrieve_key_segment_t | keySegment | ) |
Free a Btrieve key segment.
| [in] | keySegment | The key segment. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_acs_mode_t BtrieveKeySegmentGetACSMode | ( | btrieve_key_segment_t | keySegment | ) |
Get ACS mode from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| != 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. |
| int BtrieveKeySegmentGetACSNumber | ( | btrieve_key_segment_t | keySegment | ) |
Get ACS number from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| >= 0 | The ACS number. |
| -1 | An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_data_type_t BtrieveKeySegmentGetDataType | ( | btrieve_key_segment_t | keySegment | ) |
Get data type from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| != 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. |
| int BtrieveKeySegmentGetDescendingSortOrder | ( | btrieve_key_segment_t | keySegment | ) |
Get descending sort order from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| > 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. |
| btrieve_duplicate_mode_t BtrieveKeySegmentGetDuplicateMode | ( | btrieve_key_segment_t | keySegment | ) |
Get duplicate mode from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| != 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. |
| btrieve_index_t BtrieveKeySegmentGetIndex | ( | btrieve_key_segment_t | keySegment | ) |
Get index from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| != 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. |
| int BtrieveKeySegmentGetKeyContinues | ( | btrieve_key_segment_t | keySegment | ) |
Get key continues from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| > 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. |
| btrieve_status_code_t BtrieveKeySegmentGetLastStatusCode | ( | btrieve_key_segment_t | keySegment | ) |
Get last status code from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveKeySegmentGetLength | ( | btrieve_key_segment_t | keySegment | ) |
Get length from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| >= 0 | The length. |
| -1 | An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveKeySegmentGetModifiable | ( | btrieve_key_segment_t | keySegment | ) |
Get modifiable from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| > 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. |
| int BtrieveKeySegmentGetNullAllSegments | ( | btrieve_key_segment_t | keySegment | ) |
Get null all segments from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| >= 0 | The null all segments. |
| -1 | An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveKeySegmentGetNullAnySegment | ( | btrieve_key_segment_t | keySegment | ) |
Get null any segment from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| >= 0 | The null any segment. |
| -1 | An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_null_key_mode_t BtrieveKeySegmentGetNullKeyMode | ( | btrieve_key_segment_t | keySegment | ) |
Get null key mode from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| != 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. |
| int BtrieveKeySegmentGetNullValue | ( | btrieve_key_segment_t | keySegment | ) |
Get null value from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| >= 0 | The null value. |
| -1 | An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveKeySegmentGetOffset | ( | btrieve_key_segment_t | keySegment | ) |
Get offset from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| >= 0 | The offset. |
| -1 | An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveKeySegmentGetSegmented | ( | btrieve_key_segment_t | keySegment | ) |
Get segmented from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| >= 0 | The segmented. |
| -1 | An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| long long BtrieveKeySegmentGetUniqueValueCount | ( | btrieve_key_segment_t | keySegment | ) |
Get unique value count from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| >= 0 | The unique value count. |
| -1 | An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveKeySegmentGetUseNumberedACS | ( | btrieve_key_segment_t | keySegment | ) |
Get use numbered ACS from a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveFileInformationGetKeySegment(). |
| >= 0 | The use numbered ACS. |
| -1 | An error has occurred. Use BtrieveKeySegmentGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_status_code_t BtrieveKeySegmentSetDescendingSortOrder | ( | btrieve_key_segment_t | keySegment, |
| int | setDescendingSortOrder | ||
| ) |
Set descending sort order for a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveKeySegmentAllocate(). |
| [in] | setDescendingSortOrder | Enable descending sort order? |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [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. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| 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.
| [in] | keySegment | The key segment. See BtrieveKeySegmentAllocate(). |
| [in] | nullKeyMode | The null key mode. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveKeySegmentSetNullValue | ( | btrieve_key_segment_t | keySegment, |
| int | nullValue | ||
| ) |
Set null value for a Btrieve key segment.
| [in] | keySegment | The key segment. See BtrieveKeySegmentAllocate(). |
| [in] | nullValue | The null value. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| const char* BtrieveLockModeToString | ( | btrieve_lock_mode_t | lockMode | ) |
Return a Btrieve lock mode as a string.
| [in] | lockMode | The lock mode. |
| const char* BtrieveNullKeyModeToString | ( | btrieve_null_key_mode_t | nullKeyMode | ) |
Return a Btrieve null key mode as a string.
| [in] | nullKeyMode | The null key mode. |
| const char* BtrieveOwnerModeToString | ( | btrieve_owner_mode_t | ownerMode | ) |
Return a Btrieve owner mode as a string.
| [in] | ownerMode | The owner mode. |
| const char* BtrievePageLockTypeToString | ( | btrieve_page_lock_type_t | pageLockType | ) |
Return a Btrieve page lock type as a string.
| [in] | pageLockType | The page lock type. |
| const char* BtrievePageSizeToString | ( | btrieve_page_size_t | pageSize | ) |
Return a Btrieve page size as a string.
| [in] | pageSize | The page size. |
| const char* BtrieveRecordCompressionModeToString | ( | btrieve_record_compression_mode_t | recordCompressionMode | ) |
Return a Btrieve record compression mode as a string.
| [in] | recordCompressionMode | The record compression mode. |
| const char* BtrieveStatusCodeToString | ( | btrieve_status_code_t | statusCode | ) |
Return a Btrieve status code as a string.
| [in] | statusCode | The status code. |
| const char* BtrieveSystemDataModeToString | ( | btrieve_system_data_mode_t | systemDataMode | ) |
Return a Btrieve system data mode as a string.
| [in] | systemDataMode | The system data mode. |
| const char* BtrieveSystemFieldToString | ( | btrieve_system_field_t | systemField | ) |
Return a Btrieve system field as a string.
| [in] | systemField | The system field. |
| long long BtrieveTimestampToUnixEpochMicroseconds | ( | long long | timestamp | ) |
Convert a Btrieve TIMESTAMP to a Unix Epoch timestamp in microseconds.
| [in] | timestamp | The Btrieve TIMESTAMP. |
| long long BtrieveUnixEpochMicrosecondsToTimestamp | ( | long long | microseconds | ) |
Convert a Unix Epoch based timestamp in microseconds to a Btrieve TIMESTAMP.
| [in] | microseconds | The Unix Epoch timestamp in microseconds granularity. |
| const char* BtrieveVariableLengthRecordsModeToString | ( | btrieve_variable_length_records_mode_t | variableLengthRecordsMode | ) |
Return a Btrieve variable length records mode as a string.
| [in] | variableLengthRecordsMode | The variable length records mode. |
| btrieve_status_code_t BtrieveVersionAllocate | ( | btrieve_version_t * | btrieveVersionPtr | ) |
Allocate a Btrieve version.
| [out] | btrieveVersionPtr | The Btrieve version pointer. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| btrieve_status_code_t BtrieveVersionFree | ( | btrieve_version_t | version | ) |
Free a Btrieve version.
| [in] | version | The version. |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveVersionGetClientRevisionNumber | ( | btrieve_version_t | version | ) |
Get client revision number from a Btrieve version.
| [in] | version | The version. See BtrieveClientGetVersion(). |
| >= 0 | The client revision number. |
| -1 | An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveVersionGetClientVersionNumber | ( | btrieve_version_t | version | ) |
Get client version number from a Btrieve version.
| [in] | version | The version. See BtrieveClientGetVersion(). |
| >= 0 | The client version number. |
| -1 | An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_version_type_t BtrieveVersionGetClientVersionType | ( | btrieve_version_t | version | ) |
Get client version type from a Btrieve version.
| [in] | version | The version. See BtrieveClientGetVersion(). |
| != 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. |
| btrieve_status_code_t BtrieveVersionGetLastStatusCode | ( | btrieve_version_t | version | ) |
Get last status code from a Btrieve version.
| [in] | version | The version. See BtrieveClientGetVersion(). |
| = BTRIEVE_STATUS_CODE_NO_ERROR | Success. |
| != BTRIEVE_STATUS_CODE_NO_ERROR | An error has occurred. |
| int BtrieveVersionGetLocalRevisionNumber | ( | btrieve_version_t | version | ) |
Get local revision number from a Btrieve version.
| [in] | version | The version. See BtrieveClientGetVersion(). |
| >= 0 | The local revision number. |
| -1 | An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveVersionGetLocalVersionNumber | ( | btrieve_version_t | version | ) |
Get local version number from a Btrieve version.
| [in] | version | The version. See BtrieveClientGetVersion(). |
| >= 0 | The local version number. |
| -1 | An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_version_type_t BtrieveVersionGetLocalVersionType | ( | btrieve_version_t | version | ) |
Get local version type from a Btrieve version.
| [in] | version | The version. See BtrieveClientGetVersion(). |
| != 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. |
| int BtrieveVersionGetRemoteRevisionNumber | ( | btrieve_version_t | version | ) |
Get remote revision number from a Btrieve version.
| [in] | version | The version. See BtrieveClientGetVersion(). |
| >= 0 | The remote revision number. |
| -1 | An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| int BtrieveVersionGetRemoteVersionNumber | ( | btrieve_version_t | version | ) |
Get remote version number from a Btrieve version.
| [in] | version | The version. See BtrieveClientGetVersion(). |
| >= 0 | The remote version number. |
| -1 | An error has occurred. Use BtrieveVersionGetLastStatusCode() to determine the btrieve_status_code_t associated with any error. |
| btrieve_version_type_t BtrieveVersionGetRemoteVersionType | ( | btrieve_version_t | version | ) |
Get remote version type from a Btrieve version.
| [in] | version | The version. See BtrieveClientGetVersion(). |
| != 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. |
| const char* BtrieveVersionTypeToString | ( | btrieve_version_type_t | versionType | ) |
Return a Btrieve version type as a string.
| [in] | versionType | The version type. See BtrieveClientGetVersion(). |
1.8.13