Product Documentation

c-treeDB API for C++ - Developers Guide

Previous Topic

Next Topic

CTRecord Methods

Constructor / Destructor

  • CTRecord() Creates a CTRecord object
  • ~CTRecord() 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

Record Buffers

  • 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
  • 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.
  • AtPercentile(): Find a record located at about a given percentile value.
  • EstimateSpan(): Estimate the approximate number of records between two key values.

Record Sets

  • RecordSetOn(): Activates record sets.
  • RecordSetOff(): Disactivates record sets.

Field Handling

  • IsNullField(): Indicates if the field pointed by field number or name is a null field.
  • GetFieldName(): Retrieves the field name based on the field number
  • GetFieldType(): Retrieves the field type based on the field number or name
  • 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
  • GetFieldAsString(): Retrieves the field contents as a string object
  • 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
  • SetFieldAsString(): Sets the field contents as a string object
  • 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
  • GetFieldAsBytes(): Retrieves the field contents as a byte (one-byte unsigned NINT) value
  • GetFieldAsShort(): Retrieves the field contents as a COUNT (two-bytes signed NINT) 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 NINT) value
  • SetFieldAsShort(): Sets the field contents as a COUNT (two-bytes signed NINT) value
  • SetFieldAsWord(): Sets the field contents as a UCOUNT (unsigned two-byte integer) value
  • IsVariableField(): Indicates if a field is in the variable portion of a record
  • 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.

Index Handling

  • GetDefaultIndex(): Retrieves the record default index number
  • GetDefaultIndexName(): Retrieves the default record index name.
  • SetDefaultIndex(): Sets the new record default index number.

Other Handling

  • SwitchContext(): Force a c-tree Plus ISAM context switch.

See also Locking.

In This Section

CTRecord::AtPercentile

CTRecord::BatchLoaded

CTRecord::BatchLocked

CTRecord::BatchMode

CTRecord::BatchTotal

CTRecord::BuildTargetKey

CTRecord::Clear

CTRecord::ClearField

CTRecord::CTRecord

CTRecord::Delete

CTRecord::EndBatch

CTRecord::EstimateSpan

CTRecord::Find

CTRecord::FindRowid

CTRecord::FindTarget

CTRecord::First

CTRecord::FullTextSearchOff

CTRecord::FullTextSearchOn

CTRecord::GetDefaultIndex

CTRecord::GetDefaultIndexName

CTRecord::GetErrorIndex

CTRecord::GetFieldAddress

CTRecord::GetFieldAsBigint

CTRecord::GetFieldAsBlob

CTRecord::GetFieldAsBool

CTRecord::GetFieldAsBytes

CTRecord::GetFieldAsCurrency

CTRecord::GetFieldAsDate

CTRecord::GetFieldAsDateTime

CTRecord::GetFieldAsFloat

CTRecord::GetFieldAsMoney

CTRecord::GetFieldAsNumber

CTRecord::GetFieldAsShort

CTRecord::GetFieldAsSigned

CTRecord::GetFieldAsString

CTRecord::GetFieldAsString

CTRecord::GetFieldAsTime

CTRecord::GetFieldAsUnsigned

CTRecord::GetFieldAsUTF16

CTRecord::GetFieldAsWord

CTRecord::GetFieldByName

CTRecord::GetFieldLength

CTRecord::GetFieldName

CTRecord::GetFieldOffset

CTRecord::GetFieldSize

CTRecord::GetFieldType

CTRecord::GetFilter

CTRecord::GetFullTextSearchErrorDetails

CTRecord::GetRecordBuffer

CTRecord::GetRecordCount

CTRecord::GetRecordKeyPos

CTRecord::GetRecordLength

CTRecord::GetRecordPos

CTRecord::GetRecordSize

CTRecord::GetRowid

CTRecord::InsertBatch

CTRecord::IsBatchActive

CTRecord::IsEdited

CTRecord::IsFiltered

CTRecord::IsFullTextSearchOn

CTRecord::IsNew

CTRecord::IsNullField

CTRecord::IsRangeOn

CTRecord::IsRecordSetOn

CTRecord::IsVariableField

CTRecord::Last

CTRecord::LockRecord

CTRecord::Next

CTRecord::NextBatch

CTRecord::NextInBatch

CTRecord::NumberOfKeyEntries

CTRecord::Prev

CTRecord::RangeOff

CTRecord::RangeOn

CTRecord::Read

CTRecord::RecordSetOff

CTRecord::RecordSetOn

CTRecord::Reset

CTRecord::SeekRecord

CTRecord::SetBatch

CTRecord::SetDefaultFullTextIndex

CTRecord::SetDefaultIndex

CTRecord::SetEdited

CTRecord::SetFieldAsBigint

CTRecord::SetFieldAsBlob

CTRecord::SetFieldAsBool

CTRecord::SetFieldAsByte

CTRecord::SetFieldAsChar

CTRecord::SetFieldAsCurrency

CTRecord::SetFieldAsDate

CTRecord::SetFieldAsDateTime

CTRecord::SetFieldAsFloat

CTRecord::SetFieldAsMoney

CTRecord::SetFieldAsNumber

CTRecord::SetFieldAsShort

CTRecord::SetFieldAsSigned

CTRecord::SetFieldAsString

CTRecord::SetFieldAsTime

CTRecord::SetFieldAsUnsigned

CTRecord::SetFieldAsUTF16

CTRecord::SetFieldAsWord

CTRecord::SetFilter

CTRecord::SetNew

CTRecord::SetRecordOffset

CTRecord::SetRecordPos

CTRecord::SwitchContext

CTRecord::UnlockRecord

CTRecord::Write

CTRecord::~CTRecord

TOCIndex