Documentation
This is an on-line version of the printed C-Index/II User Guide provided with the product. The information provided on-line is the same as the printed manual with the exception that the extensive index is not provided. A companion Reference Guide supplied in printed form with the product contains detailed descriptions of each function. The Reference Guide is not provided on-line at this web site.
Table of Contents
MSDOS Installation
Non-MSDOS Installation
ISAM Concepts
C-Index/II Source Code
Interfacing with C-Index/II
Specifying Compiler and Operating System
Include Files
Communicating with C-Index/II
Calling C-Index/II from C++
Linking C-Index/II with Applications
Opening a File
Calling C-Index/II Functions
Closing Files
Which Function Group to Use
The Multi-key Functions
The Single-Key Functions
Description of the Multi-Key Functions
An Example of Usage: A Name and Phone List
The Datalist
Creating a Datalist
Initializing the Datalist
How C-Index/II Uses The Datalist
The Data Record Buffer
The Example main Function
Using the Functions
Creating, Opening and Closing a File
Adding Records
Finding Records
Reading Records
Deleting Records
Updating Records
Advanced Usage
Accessing the Parameter Structure
Examining the Current Record Number
Examining the Current Key
Binary Fields
Multiple Datalists
Auto Initialization of the Datalist
Example Program for the Multi-key Functions
Supplied Files for Example Program
Datalist Variables Reference
Description of Single-Key Functions
C-Index/II Filing Structure
Key Indexes
Entries
The Parameter Structure
Parameter Structure Members
Record Length Information
Duplicate and Unique Keys
Record Numbers
File Operations
Current Entry Pointer
Creating a New Index File
Opening an Existing Index File
Closing an Open Index File
Adding and Updating Entries
Add a New Unique Entry
Add a New Duplicate Entry
Change an Entry
Change the Current Entry
Save an Entry
Finding Entries
Find an Entry by Key Value
Find the Next Entry
Find the Previous Entry
Find the First Entry
Find the Last Entry
Find the Current Entry
Deleting Keys and Data
Delete Entry by Key Value
Delete Current Entry
Tutorial Program for Single-Key Functions
Starting the Tutorial
Compilation Issues
Required Compilation Definitions
Code Size
Protecting Data
PARMERR Using Multi-Key Routines
Compatibility with Other Libraries
Datalist Problems
Unexplainable Error Conditions
Buffer Control Features
Integrity Level 4
Image Backup
Grouping Multiple C-Index Operations
Transaction Logging
Software-Based File Mirroring
File Rebuild Functions
Using bbuild
Using ccheck
Using dbuild
Using bcheck
Using dcheck
Using clrwrit
Utility Programs for Rebuilding Files
Features
Multi-User Create/Open/Close Functions
Exclusive, Deny-Write and Shared Use
Read-Write and Read-Only Use
Share-Bytes
Non-Concurrent File Reads
Concurrent File Reads: ReadShare
Continuous Buffering
Record Locking
Semaphore Locking Functions
The Semaphore Physical Entry
Semaphore Abnormal Termination
Single-Key Entry Locking Functions
Application Notes
Multi-Key Record Locking Functions
Multi-User Error Codes
Disabling Required Record Locking
Intermixing Single and Multi-key Functions
Using Single-Key Functions for Secondary-Key Access
Full Tree Deletion
Byte Flipping
Faster Addition of Pre-Sorted keys
Record Counting Primitives
Setting the Multi-Key Record Number
Multiple Root Nodes
Fast Next Key Retrieval
Write Queue File Locking
User Defined Header Area
Maximum Number of Users
Node Size
Fixed Binary Data Type
ReadShare
SpeedRead
Relative Key Positioning
Deleting Fields in a Datalist
Cross-Platform Files
Block File Extend Feature
Supported Key Types
Specifying Key Type
Key Pointer
String Keys
Variable Length Binary Keys
Fixed Length Binary Keys
Numeric Keys
Integer Key Example
Segmented Keys
Key Segment List
Segmented Key Format
Single-Key Segmented Keys
Multi-Key Segmented Keys
Installing Source Files
File I/O Library Usage
Multi-User Considerations
Compiler Specific Additions
Making a Single-User Version
Batch Files
Make Files
C-Index/II Application Header File
Compiler Specific Header and Source Code Files
Testing Procedures
Tailoring the Source Code
New Features in C-Index/II
Changes Required When Converting
Rebuild
Dump
Compact
Bcheck
Bclear
Convert
Header Convert
www.triosystems.com © Copyright 1996 - 1999 Trio Systems LLC
C-Index/II User Guide © Copyright 1983-1997 Trio Systems LLC
User Guide Revision Date: 5/2/96
All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Trio Systems LLC.
Trio Systems is a registered trademark of Trio Systems LLC. C-Index, C-Index/II, SpeedRead, ReadShare and PowerFail Protection are exclusive trademarks of Trio Systems LLC.
|
