DbServer Methods |
The DbServer type exposes the following members.
Name | Description | |
---|---|---|
Append |
Append a blank record to the end of this data server (the new record becomes the current position and is ready for assignment of data values).
(Inherited from DataServer.) | |
Append(Usual) |
Append a blank record to the table; this blank record becomes the current position and is ready for assignment of data values. The record is automatically locked if the Append() method returns TRUE.
| |
AppendDB |
Append new records to the table from another DBF file.
| |
AppendDelimited |
Append new records to the table from a delimited file, such as the "comma-separated-value" (CSV) file format.
| |
AppendSDF |
Append new records to the table from an SDF-formatted file.
| |
AsString |
Return the descriptive label defined for this data server.
(Inherited from DataServer.) | |
Average |
Calculate the average of a series of numeric expressions, based on the number of actual records involved.
| |
BLOBDirectExport |
Export the contents of a binary large object (BLOB) pointer to a file.
| |
BLOBDirectGet |
Retrieve data stored in a BLOB file without referencing a specific field.
| |
BLOBDirectImport |
Import a file into a BLOB file and return a pointer to the data.
| |
BLOBDirectPut |
Put data in a BLOB file without referencing a specific field.
| |
BLOBExport |
Copy the contents of a BLOB, identified by its memo field number, to a file.
| |
BLOBGet |
Get the contents of a BLOB, identified by its memo field number.
| |
BLOBImport |
Read the contents of a file as a BLOB, identified by a memo field number.
| |
BLOBRootGet |
Retrieve the data from the root area of a BLOB file.
| |
BLOBRootLock |
Obtain a lock on the root area of a BLOB file.
| |
BLOBRootPut |
Store data in the root area of a BLOB file.
| |
BLOBRootUnlock |
Release the lock on a BLOB file's root area.
| |
ClearFilter |
Clear a filter condition specified with the DBServer:SetFilter() method.
| |
ClearIndex |
Clear all indexes currently associated with the server.
| |
ClearLocate |
Clear the LOCATE condition of the server, if any.
| |
ClearOrderScope |
Set or clear the boundaries for scoping key values in the controlling order.
| |
ClearRelation |
Clear all active relations held by this server to other servers.
| |
ClearScope |
Clear the settings that define the default scope for multi-record operations.
| |
Close |
Close the database file and its associated index files.
(Overrides Close.) | |
Commit |
Commit all changes to disk from the buffer, ensuring that all buffers are flushed.
(Overrides Commit.) | |
ConstructUniqueAlias | Create a unique alias based on the filename and an optional numeric suffix | |
Continue |
Resume a pending DBServer:Locate() operation, searching for the next record that matches (like the DBContinue() function).
| |
CopyDB |
Copy records to another DBF file.
| |
CopyDelimited |
Copy records to a delimited file.
| |
CopySDF |
Copy records to an SDF file.
| |
CopyStructure |
Create a DBF file with the same record layout as the server object to which the message is sent.
| |
Count |
Return the number of records that match a specified scope.
| |
CreateIndex |
Create an index file with an order in it.
| |
CreateOrder |
Create an order within an existing index file. The behavior depends on which driver is used.
| |
DataField |
Retrieve the data field object at the specified field position.
(Overrides DataField(Usual).) | |
Delete |
Delete the current record in this data server.
(Inherited from DataServer.) | |
Delete(Usual, Usual, Usual) |
Delete the current record or the records specified with the scoping parameters.
| |
DeleteAll |
Delete all records of the table.
| |
DeleteOrder |
Delete an order from an index file.
| |
Error |
Provide a method for handling error conditions raised during database processing.
| |
Eval |
Evaluate a code block for each record matching a scope and condition. If neither conditions nor scope is passed to the method, it is subject to the general server scope.
| |
FIELDGET |
Get the contents of a field that is identified by its position.
(Overrides FIELDGET(Usual).) | |
FieldGetBytes |
Read an array of bytes direct from the workarea buffer.
| |
FieldGetFormatted |
Return the contents of a specified field according to the formatting specifications of its FieldSpec object.
(Overrides FieldGetFormatted(Usual).) | |
FieldHyperLabel |
Return the hyperlabel of a specified field.
(Overrides FieldHyperLabel(Usual).) | |
FieldInfo |
Return and optionally change information about a field.
| |
FieldName |
Return the name of a specified field as a string.
(Overrides FieldName(Usual).) | |
FieldPos |
Return the position of a specified field within the data server, as a number starting with 1.
(Overrides FieldPos(Usual).) | |
FIELDPUT |
Set the value of a field identified by its position.
(Overrides FIELDPUT(Usual, Usual).) | |
FieldPutBytes | Write an array of bytes direct to the workarea buffer. | |
FieldSpec |
Return the FieldSpec object in the specified field.
(Overrides FieldSpec(Usual).) | |
FieldStatus |
Return the status of a field after the last operation.
(Overrides FieldStatus(Usual).) | |
FieldSym |
Return the name of a specified field.
(Overrides FieldSym(Usual).) | |
FieldValidate |
Perform all the validations defined to the FieldSpec object of a field (for example, required, maximum and minimum digits, maximum and minimum value, validation rule) and return the result of the test.
(Overrides FieldValidate(Usual, Usual).) | |
FLOCK |
Lock the table used by this server for exclusive access.
(Overrides FLOCK.) | |
GetArray |
Retrieve an array of values from a field in the server, subject to the currently active selection, if any.
| |
GetLocate |
Retrieve the code block of the current LOCATE condition, or NIL if no code block is set.
| |
GetLookupTable |
Retrieve a two-column array of values from two fields in the server, subject to the currently active selection, if any.
| |
GoBottom |
Position the data server at the last record.
(Overrides GoBottom.) | |
GoTo |
Position the data server at a specified record number.
(Overrides GoTo(Usual).) | |
GoTop |
Position the data server at the first record.
(Overrides GoTop.) | |
INDEXKEY |
Return the key expression of a specified single-order index.
| |
INDEXORD |
Return the ordinal position of the controlling order in the order list. (Similar to the IndexOrd() function.)
| |
Info |
Return and optionally change information about a data server.
| |
Join |
Join this DBServer object with another DBServer object and place the results in the file specified.
| |
Locate |
Search sequentially for a record matching a condition. If neither conditions nor scope is passed to the method, it is subject to the general server scope.
| |
LockCurrentRecord |
Lock the current record. This method is identical to invoking RLock() with the current record number as a parameter.
| |
LockSelection |
Lock all the records in the currently active selection.
| |
NoIVarGet |
Provide a general error interception that is automatically called (in any class) whenever an access reference is made to a non-existent exported instance variable. In the DBServer class, it is used to implement the virtual field variable.
(Overrides NoIVarGet(Usual).)Important! NoIVarGet() should not be called directly; it is called by the system for handling invalid references. | |
NoIVarPut |
Provide a general error interception that is automatically called (in any class) whenever an assignment reference is made to a non-existent exported instance variable. In the DBServer class, it is used to implement the virtual field variable.
(Overrides NoIVarPut(Usual, Usual).)Important! NoIVarPut() should not be called directly; it is called by the system for handling invalid references. | |
Notify |
An event handler that responds to events that have occurred in methods of this server, or in other servers that are linked to this server in some way. The standard implementation notifies all the server's clients of the event.
(Overrides Notify(Usual, Usual).)Important! This method is automatically called by the various action methods of the data server, and should normally not be called by application code. | |
OrderDescend |
Return and optionally change the descending flag of an order.
| |
OrderInfo |
Return and optionally change information about orders and index files.
| |
OrderIsUnique |
Return the status of the unique flag for a given order.
| |
OrderKeyAdd |
Add a key to a custom built order.
| |
OrderKeyCount |
Return the number of keys in an order.
| |
OrderKeyDel |
Delete a key from a custom built order.
| |
OrderKeyGoTo |
Move to a record specified by its logical record number in the controlling order.
| |
OrderKeyNo |
Get the logical record number of the current record.
| |
OrderScope |
Set the boundaries for scoping key values in the controlling order.
| |
OrderSkipUnique |
Move the record pointer to the next or previous unique key in the controlling order.
| |
Pack |
Remove deleted records from a database file.
| |
PostInit |
Implement customized initialization code for the window.
(Inherited from DataServer.) | |
PreInit |
Implement customized initialization code for the server.
(Inherited from DataServer.) | |
RDDINFO |
Return and optionally change settings controlled directly by the RDD.
| |
Recall |
Recall those deleted records indicated by a specified scope.
| |
RecallAll |
Recall all deleted records in the table.
| |
RecordInfo |
Retrieve information about the indicated record.
| |
Refresh |
Reread the current record from the database, discarding any changes that have been made.
| |
RegisterClient |
Register an object as a client of this data server, so that it receives notification messages from the server about certain actions.
(Inherited from DataServer.) | |
Reindex |
Recreate all active indexes for this server.
| |
Relation |
Return the linking expression of a specified relation.
| |
Replace |
Replace one or several fields with a new expression, for all records that match a specified scope.
| |
ResetNotification |
Resume the broadcasting of Notify messages to the server's attached clients (after DBServer:SuspendNotification() has been called).
(Overrides ResetNotification.) | |
RLOCK |
Lock a record for exclusive write access; other users can still make read-only reference to the record.
(Overrides RLOCK(Usual).) | |
RLockVerify |
Determine if the current record in this data server has any pending updates and lock it for exclusive write access if there are none.
(Overrides RLockVerify.) | |
Rollback |
Undo the changes made to this data server within the current transaction.
(Inherited from DataServer.) | |
Seek(Usual) |
Move to the next record having a specified key value in the controlling order.
(Inherited from DataServer.) | |
Seek(Usual, Usual, Usual) |
Move to the record having the specified key value in the controlling order.
| |
SELECT | Select the workarea that the DbServer uses. | |
SetDataField |
Assign a DataField object to a specified field.
(Overrides SetDataField(Usual, Usual).) | |
SetFilter |
Set a filter condition.
| |
SetIndex |
Open an index file and select its order as the controlling order, if this is the first index being opened.
| |
SetOrder |
Select an order from one of the open index files as the controlling order.
| |
SetOrderCondition |
Set conditions that is applied to index and order creation. If SetOrderCondition() has not been called, order creation is subject to the general server scope. If neither has been set, orders are not conditional.
| |
SetRelation |
Set a relation from this server to the child server.
| |
SetSelectiveRelation |
Set a selective relation from this server to the child server; standard database operations are restricted to those records that match the relation.
| |
Skip |
Move the record pointer forward or backward a specified number of records.
(Overrides Skip(Usual).) | |
Sort |
Copy records to another database file in sorted order. If neither conditions nor scope is passed to the method, it is subject to the general server scope.
| |
Sum |
Calculate the sum of a series of numeric expressions.
| |
SuspendNotification |
Suspend the broadcasting of Notify messages to the server's attached clients.
(Overrides SuspendNotification.) | |
Total |
Aggregate records by key value, producing grouped summarizations, and write the aggregate records to another database.
| |
UnLock |
Remove all locks held on this data server.
(Inherited from DataServer.) | |
UnLock(Usual) |
Release a specified lock or all locks.
| |
UnRegisterClient |
Remove the registration of an object as a client of this data server, so that it no longer receives notification messages from the server about certain actions.
(Inherited from DataServer.) | |
Update |
Update this server with data from another server or table.
(Inherited from DataServer.) | |
Update(Usual, Usual, Usual, Usual) |
Update this server with data from another server or table.
| |
Zap |
Permanently remove all records from the server and release the disk space.
|