TArrayBufIndex class

In unit BufDataset

Implements an index using an array of record buffers.

Declaration

pascal

TArrayBufIndex = class(TBufIndex)

Inheritance

TArrayBufIndex
TBufIndex
TObject

Description

TArrayBufIndex is a TBufIndex descendant that implements an index using an array of record buffers. TArrayBufIndex uses an internal member with an array of pointers to the TRecordBuffer data type used for record buffers in the index. TArrayBufIndex provides support for Bookmarks in the dataset using TBufBookmark.

Methods

`GetBookmarkSize`	protected	Gets the value for the BookmarkSize property.
`GetCurrentBuffer`	protected	Gets the value for the CurrentBuffer property.
`GetCurrentRecord`	protected	Gets the value for the CurrentRecord property.
`GetIsInitialized`	protected	Gets the value for the IsInitialized property.
`GetSpareBuffer`	protected	Gets the value for the SpareBuffer property.
`GetSpareRecord`	protected	Gets the value for the SpareRecord property.
`GetRecNo`	protected	Gets the value for the RecNo property.
`SetRecNo`	protected	Sets the value for the RecNo property.
`Create`	public	Constructor for the class instance.
`ScrollBackward`	public	Moves to the prior record in the index.
`ScrollForward`	public	Moves to the next record in the index.
`GetCurrent`	public	Gets the record buffer for the current record in the dataset.
`ScrollFirst`	public	Moves to the first record in the index.
`ScrollLast`	public	Moves to the last record in the index.
`SetToFirstRecord`	public	Sets the index to the first record in the index order.
`SetToLastRecord`	public	Sets the index to the last record in the index order.
`StoreCurrentRecord`	public	Stores the record buffer for the current record.
`RestoreCurrentRecord`	public	Restores the stored record buiffer to the current record.
`CanScrollForward`	public	Indicates if the index can be scrolled forward.
`DoScrollForward`	public	Implements actions need to scroll forward in the index.
`StoreCurrentRecIntoBookmark`	public
`StoreSpareRecIntoBookmark`	public
`GotoBookmark`	public	Moves the index position to the specified Bookmark.
`InitialiseIndex`	public	Initializes the index.
`InitialiseSpareRecord`	public	Initializes values in the spare record for the index.
`ReleaseSpareRecord`	public	Releases resources allocated to the spare record for the index.
`BeginUpdate`	public
`AddRecord`	public	Adds a record to the index.
`InsertRecordBeforeCurrentRecord`	public	Inserts a record before the current record in the index order.
`RemoveRecordFromIndex`	public	Remove the record at the specified bookmark from the index.
`EndUpdate`	public

Fields

`FRecordArray`	public
`FCurrentRecInd`	public
`FLastRecInd`	public
`FNeedScroll`	public

Inherited

From TBufIndex (12)

BookmarkSize BookmarkValid CompareBookmarks CurrentBuffer CurrentRecord GetRecord IsInitialized OrderCurrentRecord RecNo SameBookmarks SpareBuffer SpareRecord

From TObject (41)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Destroy Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.