Apollo VCL Components > Apollo VCL Component Reference > TApolloTable

See Also: TApolloTable Methods (Alphabetical Listing)

TApolloTable is a TDataSet descendant so by default it supports all of the standard TDataSet properties and methods. Since you typically would not use a TDataSet object itself, and may be more familiar with its descendants, TTable and TQuery. Both of these objects add additional properties and methods, many specific to the BDE and the functionality found therein. Therefore, since TApolloTable inherits directly from TDataSet and not from TTable, it is important not to assume that a property or method found on TTable will be available in TApolloTable. TApolloTable does not inherit from TTable because TTable is bound to the BDE and that would mean your application would require the BDE.

In addition to supporting TDataSet methods, the following TTable methods are currently emulated under TApolloTable:

AddIndex

ApplyRange

CancelRange

CloseIndexFile

CreateTable

DeleteTable

DeleteIndex

EditKey

EditRangeEnd

EditRangeStart

EmptyTable

FindKey

FindNearest

GetIndexNames

GotoCurrent

GotoKey

GotoNearest

OpenIndexFile

SetKey

SetRange

SetRangeEnd

SetRangeStart

The following is a list of the additional, altered, or enhanced methods found in TApolloTable.

$image\tip.gif$ Standard TDataSet methods where TApolloTable may not alter or enhance the usual behavior are not documented here, and the documentation for those can be found in the standard Delphi or C++Builder help files under the TDataSet reference.

Table/Structure Creation

CopyFile	Copies the current table to another file.
CopyFileText	Copy the current table to an ASCII text file.
CopyStructure	Creates a table that has the same structure as the current table.
CopyStructureExtended	Creates a table that holds the record structure of the currently selected file.
CreateExec	Creates a table in the work area set up via CreateNew and according to the field specifications defined with CreateField.
CreateField	Defines a field to be included in a new table.
CreateFrom	Creates a new file from the specified structure extended file.
CreateNew	Initializes a new work area.

Table Data Updates / Modifications

Append	Places a new, empty record buffer in Edit mode.
AppendBlank	Places a new, empty record buffer in Edit mode.
AppendFrom	Appends data from a source table to the current table.
ApolloDelete	Flags the current record for deletion (for SpeedMode).
Commit	Writes the contents of the record buffer to the current file position.
DBFDecrypt	Decrypts a table that has been encrypted at the file level.
DBFEncrypt	Encrypts all records in a table.
Delete	Flags the current record for deletion.
Pack	Removes all records marked for deletion from a table.
PutBinary	Stores a binary value in a memo field of a table.
PutBlob	Stores a BLOB in a memo field.
PutRecord	Replaces an entire record with the contents of a defined record structure or character buffer.
Recall	Recalls a record that has been logically deleted.
Replace	Replaces the named field's contents in the record buffer with the given data value.
Zap	Remove all records from the table.

Data Retrieval

ApolloGetRecord	Fills a defined and initialized buffer or record structure with the contents of the current record buffer.
BlobToFile	Writes a BLOB stored in a memo file directly to a new disk file.
GetBinary	Extracts a binary value from a memo field in a table.
GetBlob	Retrieves a BLOB that was stored in a memo field.
GetByte	Extracts the first character of a field.
GetDate	Extracts the contents of a date field as a TDateTime type.
GetDateJulian	Extracts the contents of a date field as a Julian number.
GetDateString	Extracts the contents of a date field as a string formatted according to the date mask specified by SetDateFormat and the setting of SetCentury.
GetDouble	Extracts the contents of a numeric field and convert to a double value.
GetInteger	Extracts the contents of a numeric field as a signed integer value.
GetLogical	Determines whether a logical field contains a True or False value.
GetLong	Extracts the contents of a numeric field as a signed long integer value.
GetMemo	Extracts the contents of a memo field as a PChar and optionally format the memo with hard carriage returns and line feeds for printing.
GetRecord	See the Delphi/C++Builder VCL help for TDataSet.GetRecord. To avoid this naming conflict, the old TApollo.GetRecord method has been renamed to ApolloGetRecord in this release.
GetString	Extracts the contents of any field (less than 256 bytes wide) as a string value.
GetStringEx	Extracts the contents of a character field as a PChar value.
GetTrimString	Extracts the contents of any field as a string and trim trailing spaces.

General Table / Workarea Information

Alias	Retrieves the table alias name assigned to the current work area when the table was opened.
ApolloFieldCount	Extracts the number of fields in the current table.
BaseDate	Retrieves the date on which the table was last opened for read/write access.
BaseName	Extracts the DOS path and file name attached to the current work area.
DBFilter	Extracts the current filter conditional expression.
FieldDecimals	Extracts the number of decimals defined for a numeric field.
FieldName	Extracts the name of the nth field.
FieldNum	Gets number of named field in field array (relative to 1).
FieldOffset	Gets offset of named field in record buffer (relative to 1).
FieldType	Reports the type of the named field.
FieldWidth	Extracts the width of the named field.
GetBlobLength	Retrieves the length of a BLOB that was stored in a memo field.
GetScope	Gets the original value of a scoping string passed to SetScope.
IsEncrypted	Determines whether the current record or file is encrypted.
RecSize	Extracts the size of a record in the current table in number of bytes.
SetPassword	Defines an encoding key to be used in encrypting and decrypting data records in the current table.
SetTurboRead	SetTurboRead is used to speed up TApolloTable record i/o methods (specifically Skip and Seek).

Table Navigation

Go	Goes to a physical record that occupies the nth position in the table.
GoBottom	Moves the record pointer to the last record in the file.
GoTop	Go to the first record in the file.
SetRelation	Defines a relationship between the current table and another table.
Skip	Skips forwards or backwards a specified number of records.

Index Creation / Manipulation

CloseIndexes	Closes all open index files attached to the current table object.
Index	Creates a new single-order (.NTX or .IDX) index file and make it the active order.
IndexClose	Closes the current index file.
IndexCondition	Extracts the conditional expression from the current index.
IndexFileName	Extracts the DOS file name and path of the defined index.
IndexFlip	Dynamically toggles the Ascending/Descending status of the active index order.
IndexKey	Extracts the contents of the xBase key construction expression used by the current index as a string.
IndexKeyField	Extracts the name of the first field in an index key expression.
IndexName	See the Delphi/C++Builder VCL help for TDataSet.IndexName. To avoid this naming conflict, the old TApollo.IndexName method has been renamed to IndexFileName in this release.
IndexOpen	Opens an index file.
IndexOrd	Gets the current order number identifying the order work area.
IndexTag	Creates a new tag in the compound .CDX or .NSX index.
IndexType	Gets the current index or Tag type.
KeyAdd	Adds a key to the specified index order.
KeyData	Extracts the key data from the current index key in the current index and returns it as a string.
KeyDrop	Removes a key from the specified index order.
OrderPosGet	Retrieves the relative position of the key in the current active order.
OrderPosSet	Sets the relative position of the key in the current active order.
OrderRecNo	Retrieves the logical record number according to the position of the key in the current active order.
Reindex	Rebuilds all active orders attached to the current work area.
RYOKeyAdd	Adds a key to an existing sxChar RYO index tag that points to the current table record.
RYOKeyDrop	Searches the current order for a supplied key. The key may contain binary zeroes.
SetOrder	Selects an existing order as the controlling index order.
TagArea	Retrieves the index select area of the named tag within a compound index.
TagName	Retrieves the name of the tag associated with the passed tag area number.

Querying Data / Expressions

ApolloLocate	Initializes or continues a record location command. (Same as old TApollo.Locate)
Count	Extracts the number of records in the table, respecting any active filter.
Empty	Determines whether or not the named field is empty.
EvalLogical	Evaluates a logical xBase expression and retrieves a True or False value depending upon the outcome.
EvalNumeric	Evaluates an xBase expression that returns a numeric value and convert the result to a double precision number.
EvalString	Evaluates an xBase expression and retrieves the result as a string.
EvalTest	Tests the validity of an xBase expression.
FilterAlias	Assigns an alias name to a field name in the table to be used in an upcoming FilterDlg call.
FilterDlg	Displays a modal dialog box that allows the user to create a custom filter expression visually.
Found	Queries the result of the last index seek made on the current work area.
GetQueryBit	Get the setting of a bit that maps to a record number in an existing bitmap.
Locate	Searches the dataset for a specified record and makes that record the current record.
Query	Sets an ultra high speed filter.
QueryRecCount	Extracts the number of records contained in the current query subset.
QueryTest	Tests if a given xBase expression will result in an optimized query set or not.
RYOFilterActivate	Activate an existing filter bitmap and either make it the filter bitmap of record or combine it with the current active bitmap.
RYOFilterCopy	Copies the existing filter bitmap to the linked list of RYOFilter bitmaps.
RYOFilterCreate	Creates an empty bitmap to be used in subsequent RYOFilter functions.
RYOFilterDestroy	Destroys a bitmap created by RYOFilterCreate or RYOFilterCopy.
RYOFilterSave	Saves the defined bitmap in a disk file.
RYOFilterRestore	Sets or resets the active bitmap to one saved to disk by RYOFilterSave.
RYOFilterSetBit	Sets or resets a bit corresponding to the specified table record.
RYOKeyAdd	Adds a key to an existing sxChar RYO index tag that points to the current table record.
RYOKeyDrop	Searches the current order for a supplied key. The key may contain binary zeroes.
SetFilter	Defines a subset of the current table according to the condition passed.
SetQueryBit	Sets a bit (on or off) in a query bitmap for the specified record number.
SetScope	Sets formal scope based on current index order expression.

Record / File Locking

Flock	Locks the current table.
Locked	Determines the lock status of a record or a file.
RLock	Locks the defined record.
Unlock	Removes record and/or file locks from the current work area.

Conversion

Descend	Converts a key string into a 2s complement representation.
OEMTranslate	Automatically translates record buffers stored in the OEM character set to Windows ANSI.

Miscellaneous

Decrypt	Decrypts an encrypted string using the specified password.
Encrypt	Encrypts a string using the specified password.
MemDealloc	Deallocate memory allocated by GetMemo.
SetGaugeHook	Defines a window that time consuming operations may communicate with in order to inform the user as to the progress of the operation.
SysProp	Sets or Retrieves Apollo global system information.

TApolloTable Methods (By Category)

TApolloTable Methods (By Category)