c-treeDB API for C# - Developers Guide
CTRecord Methods
Constructor / Destructor
- CTRecord(): Creates a CTRecord object
- Dispose(): Destroys a CTRecord object and resets all the dependent objects
Record Search
- First(): Moves to the first record in the table
- Last(): Moves to the last record in the table.
- Next(): Moves to the next record in the table.
- Prev(): Moves to the previous record in the table.
- Find(): Looks for the record in the table.
- FindRowid(): Verifies if a record at a given ROWID exist.
- FindTarget(): Looks for one specified record in the table.
- GetRecordCount(): Retrieves the number of records in table
- GetRowid(): Retrieves the record’s ROWID value
- BuildTargetKey(): Build a target key based on data in record buffer
Record Buffers
- AtPercentile(): Retrieve the record located at about the given percentile of the current index
- LockRecord(): Locks the current record.
- UnlockRecord(): Unlocks the current record.
- Clear(): Clears the record buffer
- Read(): Reads the current record
- Write(): Writes the record buffer to disk
- Delete(): Deletes the current record from table
- Reset(): Resets the record buffer to its initial condition
- IsNew(): Indicates if a record buffer is cleared
- IsEdited(): Indicates if a record buffer has been modified
- SetNew(): Sets the new record flag
- SetEdited(): Sets the change record flag
- GetRecordBuffer(): Retrieves the record buffer object
- GetRecordPos(): Retrieves the current record offset position
- EstimateSpan(): Estimate the approximate number of records between two key values
- SetRecordPos(): Sets the current record offset position.
- SetRecordOffset(): Updates the record offset.
- SeekRecord(): Moves the record to position pointed by offset
- GetRecordLength(): Retrieves the record length.
- GetRecordSize(): Retrieves the allocated record size.
- GetRecordLock(): Retrieve information if the record is locked or not.
- Compare(): Compares two CTRecord objects
- CopyBuffer(): Copy the contents of the record buffer
- SwitchContext(): Forces a c-tree ISAM context switch
Record Sets
- RecordSetOn(): Activates record sets.
- RecordSetOff(): Deactivates record sets.
Ranges
- RangeOn(): Establish a new range based on the key segment values
- RangeOff(): Terminate a range operation
- IsRangeOn(): Indicate if a range is active
Field Handling
- IsNullField(): Indicates if the field pointed by field number or name is a null field.
- IsVariableField(): Indicates if a field is in the variable portion of a record
- ClearField(): Clears the contents of a field
- GetFieldName(): Retrieves the field name based on the field number
- GetFieldType(): Retrieves the field type based on the field number or name
- GetFieldValue(): Retrieves the field contents as any value
- GetFieldAsString(): Retrieves the field contents as a string object - depricated: use SetFieldValue()
- GetFieldLength(): Retrieves the actual field data length
- GetFieldSize(): Retrieves the defined field size
- GetFieldOffset(): Retrieves the field offset in the record
- GetFieldAddress(): Retrieves the field address in the record buffer
- GetFieldByName(): Retrieves the field number based on the field name
- ClearField(): Clears the contents of a field.
- GetFieldValue(): Retrieves the field contents as any value
- GetFieldAsString(): Retrieves the field contents as a string object - deprecated: use SetFieldValue()
- SetFieldValue(): Sets the field contents
- SetFieldAsString(): Sets the field contents as a string object - deprecated: use SetFieldValue()
Alternative GetFieldAs and SetFieldAs Methods
The GetFieldAs... and SetFieldAs... methods listed below have been deprecated and replaced by GetFieldValue and SetFieldValue.
- GetFieldAsBool(): Retrieves the field contents as a boolean value
- GetFieldAsSigned(): Retrieves the field contents as a signed value
- GetFieldAsUnsigned(): Retrieves the field contents as an unsigned value
- GetFieldAsDate(): Retrieves the field contents as a date object
- GetFieldAsTime(): Retrieves the field contents as a time object
- GetFieldAsDateTime(): Retrieves the field contents as a date and time object
- GetFieldAsMoney(): Retrieves the field contents as a money object
- GetFieldAsFloat(): Retrieves the field contents as a float value
- GetFieldAsBlob(): Retrieves the field contents as a blob object
- GetFieldAsBigint(): Retrieves the field contents as a big integer (64-bit)
- GetFieldAsCurrency(): Retrieves the field contents as a CTCurrency object (64-bit)
- GetFieldAsNumber(): Retrieves the field contents as a CTNumber object
- SetFieldAsBool(): Sets the field contents as a boolean value
- SetFieldAsSigned(): Sets the field contents as a signed value
- SetFieldAsUnsigned(): Sets the field contents as an unsigned value
- SetFieldAsDate(): Sets the field contents as a date object
- SetFieldAsTime(): Sets the field contents as a time object
- SetFieldAsDateTime(): Sets the field contents as a date and time object
- SetFieldAsMoney(): Sets the field contents as a money object
- SetFieldAsFloat(): Sets the field contents as a float value
- SetFieldAsBlob(): Sets the field contents as a blob object
- SetFieldAsBigint(): Sets the field contents as a big integer (64-bit)
- SetFieldAsCurrency(): Sets the field contents as a CTCurrency object (64-bit)
- SetFieldAsNumber(): Sets the field contents as a CTNumber object
- GetFieldAsChar(): Retrieves the field contents as a char value
- GetFieldAsByte(): Retrieves the field contents as a byte (one-byte unsigned int) value
- GetFieldAsShort(): Retrieves the field contents as a COUNT (two-bytes signed int) value
- GetFieldAsWord(): Retrieves the field contents as a UCOUNT (unsigned two-byte integer) value
- SetFieldAsChar(): Sets the field contents as a char value
- SetFieldAsByte(): Sets the field contents as a byte (one-byte unsigned int) value
- SetFieldAsShort(): Sets the field contents as a COUNT (two-bytes signed int) value
- SetFieldAsWord(): Sets the field contents as a UCOUNT (unsigned two-byte integer) value
Index Handling
- GetDefaultIndex(): Retrieves the record default index number
- GetDefaultIndexName(): Retrieves the default record index name.
- SetDefaultIndex(): Sets the new record default index number.
Conditional Expression
- CndxEval(): Evaluates the compiled conditional expression
- CndxFree(): Releases any resource allocated by the conditional expression parser
- CndxCompile(): Initializes the conditional expression parser and compiles the expression
- CndxGetExpression(): Retrieves the last compiled expression
Filter Handling
- FilterRecord(): Sets the filtering for a record.
- GetFilter(): Retrieves the filter that is filtering the record.
- IsFilteredRecord(): Indicates if the record is being filtered or not
