[^^Up^^]
[Menu]
[About The Guide]
Data Structures
AREA Information to administrate the work area
DBEVALINFO Information needed for code block evaluation on each row
DBFIELDINFO Information needed to define a column to the work area
DBFILTERINFO Specifies filter condition to hide specified rows
DBLOCKINFO Information necessary to lock a row or table for exclusive access
DBOPENINFO Information about a data store to be opened in work area
DBORDERCONDINFO Information needed for the creation of a conditional order
DBORDERCREATEINFO Information needed to create a new order for the work area
DBORDERINFO Information needed to open/address an order in work area
DBRELINFO List of relational information
DBSCOPEINFO References to all CA-Clipper Xbase-style scope clause
DBSORTINFO Information needed to perform a physical sort on work area
DBSORTITEM Array of items indicating key values to use when sorting
DBTRANSINFO Define global transfer of data items
DBTRANSITEM Define single transfer item from one work area to another
FIELD Field (column) definitions
RDDFUNCS The virtual method table for the work area
-------------------------------------------------------------------------------
Work Area Methods
bof() Determine logical beginning of file
eof() Determine logical end of file
found() Determine outcome of the last search operation
go() Position cursor at a specific physical identity (record)
goBottom() Position cursor at the last logical identity (record)
goToId() Position the cursor to a specific, physical identity
goTop() Position cursor at the first logical identity (record)
seek() Position cursor at first row with matching key value
skip() Reposition cursor relative to current position
skipFilter() Reposition cursor respecting any filter setting
skipRaw() Reposition cursor, regardless of filter
-------------------------------------------------------------------------------
Data Management Methods
addField() Add a column (field) to the work area
append() Append a row (record) to the work area
createFields() Add all columns defined in an array to the work area
delete() Mark a row (record) for deletion
deleted() Determine deleted status for a row (record)
fieldCount() Determine the number of columns (fields) in the work area
fieldDisplay() This method is reserved for future use
fieldInfo() Retrieve information about a column
fieldName() Determine the name associated with a column (field) number
flush() Write data buffer to the data store
getRec() Retrieve the pointer to the RDD's record data buffer
getValue() Obtain the current value of a column (field)
getVarLen() Obtain the length of a column (field) value
goCold() Perform a write of work area memory to the data store
goHot() Mark the work area data buffer as hot
putRec() Replace the current row (record)
putValue() Assign a value to the current column (field)
recall() Undelete the current row (record)
reccount() Obtain number of rows (records) in work area's table
recInfo() Retrieve the information about a row
recno() Get row number at current work area cursor position
setFieldExtent() Establish extent of the array of fields for a work area
-------------------------------------------------------------------------------
Work Area/Database Management Methods
alias() Obtain the alias of the work area
close() Close the table in the work area
create() Create a data store (table) in the specified work area
dbEval() Evaluate code block for each row (record) in work area
info() Retrieve information about the current driver
new() Clear the work area for use
open() Open a data store (table) in the work area
pack() Remove rows (records) marked for deletion from a database
packRec() Copy a single row back to the current work area
readDBHeader() Read the database file header record in the work area
release() Release all references to a work area
sort() Physically reorder a database
structSize() Retrieve the size of the work area structure
sysName() Obtain name of replaceable database driver (RDD) subsystem
trans() Copy one or more rows from one work area to another
transRec() Copy a single row (record) to another work area
writeDBHeader() Write database file header record in work area back to disk
zap() Physically remove all rows from data store
-------------------------------------------------------------------------------
Relational Operation Methods
childEnd() Report end of relation
childStart() Report initialization of a relation
childSync() Post a pending relational movement
clearRel() Clear all relations in the specified work area
forceRel() Force relational seeks in the specified work area
relArea() Obtain the logical number of the specified work area
relEval() Evaluate block against relation in specified work area
relText() Obtain the character expression of the specified relation
setRel() Set a relation in the parent file
syncChildren() Force relational movement in child work areas
-------------------------------------------------------------------------------
Order Management Methods
orderCondition() Set or delete a condition for subsequent order creation
orderCreate() Create new order
orderInfo() Provides information about order management
orderListAdd() Opens an order bag in the indicated work area
orderListClear() Clear the current order list
orderListFocus() Select the controlling order
orderListRebuild() Rebuild all orders in the specified work area
-------------------------------------------------------------------------------
Filter and Scoping Methods
clearFilter() Clear the active filter expression
clearLocate() Clear the active locate expression
clearScope() Clear the scope setting for the specified work area
filterText() Return filter condition of the specified work area
setFilter() Set the filter condition for the specified work area
setLocate() Set the locate scope for the specified work area
-------------------------------------------------------------------------------
Network Operation Methods
lock() Perform a network lock in the specified work area
rawLock() Perform various locks and unlocks
unlock() Release network locks in the specified work area
-------------------------------------------------------------------------------
Memo File Management Methods
blobInfo() Retrieve information about a memo column
closeMemFile() Close a memo file in the specified work area
createMemFile() Create a memo file in the work area
getValueFile() Retrieve current value of column and put it into a file
openMemFile() Open a memo file in the specified work area
putValueFile() Assign value to specified column at cursor position
-------------------------------------------------------------------------------
Miscellaneous Methods
compile() Compile a character expression
error() Raise a runtime error
evalBlock() Evaluate a code block
whoCares() A user-defined slot within function table reserved
This page created by ng2html v1.05, the Norton guide to HTML conversion utility.
Written by Dave Pearson