Click or drag to resize

DbServer Methods

The DbServer type exposes the following members.

Methods
  NameDescription
Public methodAppend
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.
Public methodAppendDB
Append new records to the table from another DBF file.
Public methodAppendDelimited
Append new records to the table from a delimited file, such as the "comma-separated-value" (CSV) file format.
Public methodAppendSDF
Append new records to the table from an SDF-formatted file.
Public methodAverage
Calculate the average of a series of numeric expressions, based on the number of actual records involved.
Public methodCode exampleBLOBDirectExport
Export the contents of a binary large object (BLOB) pointer to a file.
Public methodCode exampleBLOBDirectGet
Retrieve data stored in a BLOB file without referencing a specific field.
Public methodCode exampleBLOBDirectImport
Import a file into a BLOB file and return a pointer to the data.
Public methodCode exampleBLOBDirectPut
Put data in a BLOB file without referencing a specific field.
Public methodCode exampleBLOBExport
Copy the contents of a BLOB, identified by its memo field number, to a file.
Public methodCode exampleBLOBGet
Get the contents of a BLOB, identified by its memo field number.
Public methodCode exampleBLOBImport
Read the contents of a file as a BLOB, identified by a memo field number.
Public methodCode exampleBLOBRootGet
Retrieve the data from the root area of a BLOB file.
Public methodCode exampleBLOBRootLock
Obtain a lock on the root area of a BLOB file.
Public methodCode exampleBLOBRootPut
Store data in the root area of a BLOB file.
Public methodCode exampleBLOBRootUnlock
Release the lock on a BLOB file's root area.
Public methodClearFilter
Clear a filter condition specified with the DBServer:SetFilter() method.
Public methodClearIndex
Clear all indexes currently associated with the server.
Public methodClearLocate
Clear the LOCATE condition of the server, if any.
Public methodClearOrderScope
Set or clear the boundaries for scoping key values in the controlling order.
Public methodClearRelation
Clear all active relations held by this server to other servers.
Public methodClearScope
Clear the settings that define the default scope for multi-record operations.
Public methodClose
Close the database file and its associated index files.
(Overrides Close.)
Public methodCommit
Commit all changes to disk from the buffer, ensuring that all buffers are flushed.
(Overrides Commit.)
Public methodConstructUniqueAlias
**Missing documentation **
Public methodContinue
Resume a pending DBServer:Locate() operation, searching for the next record that matches (like the DBContinue() function).
Public methodCode exampleCopyDB
Copy records to another DBF file.
Public methodCopyDelimited
Copy records to a delimited file.
Public methodCopySDF
Copy records to an SDF file.
Public methodCode exampleCopyStructure
Create a DBF file with the same record layout as the server object to which the message is sent.
Public methodCode exampleCount
Return the number of records that match a specified scope.
Public methodCreateIndex
Create an index file with an order in it.
Public methodCreateOrder
Create an order within an existing index file.  The behavior depends on which driver is used.
Public methodDataField
Retrieve the data field object at the specified field position.
(Overrides DataField(Usual).)
Public methodDelete
Delete the current record or the records specified with the scoping parameters.
Public methodDeleteAll
Delete all records of the table.
Public methodDeleteOrder
Delete an order from an index file.
Public methodCode exampleError
Provide a method for handling error conditions raised during database processing.
Public methodEval
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.
Public methodCode exampleFIELDGET
Get the contents of a field that is identified by its position.
(Overrides FIELDGET(Usual).)
Public methodFieldGetBytes
Read an array of bytes direct from the workarea buffer.
Public methodFieldGetFormatted
Return the contents of a specified field according to the formatting specifications of its FieldSpec object.
(Overrides FieldGetFormatted(Usual).)
Public methodFieldHyperLabel
Return the hyperlabel of a specified field.
(Overrides FieldHyperLabel(Usual).)
Public methodCode exampleFieldInfo
Return and optionally change information about a field.
Public methodFieldName
Return the name of a specified field as a string.
(Overrides FieldName(Usual).)
Public methodFieldPos
Return the position of a specified field within the data server, as a number starting with 1.
(Overrides FieldPos(Usual).)
Public methodCode exampleFIELDPUT
Set the value of a field identified by its position.
(Overrides FIELDPUT(Usual, Usual).)
Public methodFieldPutBytes
Write an array of bytes direct to the workarea buffer.
Public methodFieldSpec
Return the FieldSpec object in the specified field.
(Overrides FieldSpec(Usual).)
Public methodFieldStatus
Return the status of a field after the last operation.
(Overrides FieldStatus(Usual).)
Public methodFieldSym
Return the name of a specified field.
(Overrides FieldSym(Usual).)
Public methodFieldValidate
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).)
Public methodFLOCK
Lock the table used by this server for exclusive access.
(Overrides FLOCK.)
Public methodCode exampleGetArray
Retrieve an array of values from a field in the server, subject to the currently active selection, if any.
Public methodGetLocate
Retrieve the code block of the current LOCATE condition, or NIL if no code block is set.
Public methodCode exampleGetLookupTable
Retrieve a two-column array of values from two fields in the server, subject to the currently active selection, if any.
Public methodGoBottom
Position the data server at the last record.
(Overrides GoBottom.)
Public methodGoTo
Position the data server at a specified record number.
(Overrides GoTo(Usual).)
Public methodGoTop
Position the data server at the first record.
(Overrides GoTop.)
Public methodINDEXKEY
Return the key expression of a specified single-order index.
Public methodINDEXORD
Return the ordinal position of the controlling order in the order list.  (Similar to the IndexOrd() function.)
Public methodCode exampleInfo
Return and optionally change information about a data server.
Public methodJoin
Join this DBServer object with another DBServer object and place the results in the file specified.
Public methodLocate
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.
Public methodLockCurrentRecord
Lock the current record.  This method is identical to invoking RLock() with the current record number as a parameter.
Public methodCode exampleLockSelection
Lock all the records in the currently active selection.
Public methodNoIVarGet
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.
Important!  NoIVarGet() should not be called directly; it is called by the system for handling invalid references.
(Overrides NoIVarGet(Usual).)
Public methodNoIVarPut
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.
Important!  NoIVarPut() should not be called directly; it is called by the system for handling invalid references.
(Overrides NoIVarPut(Usual, Usual).)
Public methodNotify
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.
Important!  This method is automatically called by the various action methods of the data server, and should normally not be called by application code.
(Overrides Notify(Usual, Usual).)
Public methodCode exampleOrderDescend
Return and optionally change the descending flag of an order.
Public methodCode exampleOrderInfo
Return and optionally change information about orders and index files.
Public methodCode exampleOrderIsUnique
Return the status of the unique flag for a given order.
Public methodCode exampleOrderKeyAdd
Add a key to a custom built order.
Public methodCode exampleOrderKeyCount
Return the number of keys in an order.
Public methodCode exampleOrderKeyDel
Delete a key from a custom built order.
Public methodCode exampleOrderKeyGoTo
Move to a record specified by its logical record number in the controlling order.
Public methodCode exampleOrderKeyNo
Get the logical record number of the current record.
Public methodCode exampleOrderScope
Set the boundaries for scoping key values in the controlling order.
Public methodCode exampleOrderSkipUnique
Move the record pointer to the next or previous unique key in the controlling order.
Public methodPack
Remove deleted records from a database file.
Public methodRDDINFO
Return and optionally change settings controlled directly by the RDD.
Public methodRecall
Recall those deleted records indicated by a specified scope.
Public methodRecallAll
Recall all deleted records in the table.
Public methodRecordInfo
Retrieve information about the indicated record.
Public methodRefresh
Reread the current record from the database, discarding any changes that have been made.
Public methodReindex
Recreate all active indexes for this server.
Public methodRelation
Return the linking expression of a specified relation.
Public methodCode exampleReplace
Replace one or several fields with a new expression, for all records that match a specified scope.
Public methodResetNotification
Resume the broadcasting of Notify messages to the server's attached clients (after DBServer:SuspendNotification() has been called).
(Overrides ResetNotification.)
Public methodRLOCK
Lock a record for exclusive write access; other users can still make read-only reference to the record.
(Overrides RLOCK(Usual).)
Public methodRLockVerify
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.)
Public methodCode exampleSeek
Move to the record having the specified key value in the controlling order.
Public methodSELECT
**Missing documentation **
Public methodSetDataField
Assign a DataField object to a specified field.
(Overrides SetDataField(Usual, Usual).)
Public methodCode exampleSetFilter
Set a filter condition.
Public methodCode exampleSetIndex
Open an index file and select its order as the controlling order, if this is the first index being opened.
Public methodSetOrder
Select an order from one of the open index files as the controlling order.
Public methodSetOrderCondition
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.
Public methodCode exampleSetRelation
Set a relation from this server to the child server.
Public methodCode exampleSetSelectiveRelation
Set a selective relation from this server to the child server; standard database operations are restricted to those records that match the relation.
Public methodSkip
Move the record pointer forward or backward a specified number of records.
(Overrides Skip(Usual).)
Public methodSort
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.
Public methodCode exampleSum
Calculate the sum of a series of numeric expressions.
Public methodSuspendNotification
Suspend the broadcasting of Notify messages to the server's attached clients.
(Overrides SuspendNotification.)
Public methodCode exampleTotal
Aggregate records by key value, producing grouped summarizations, and write the aggregate records to another database.
Public methodUnLock
Release a specified lock or all locks.
Public methodUpdate
Update this server with data from another server or table.
Public methodZap
Permanently remove all records from the server and release the disk space.
Top
See Also