C5 Database Functions

AFIELDS() :

Fill arrays with the structure of the current database file

AFIELDS([<aFieldNames>],
    [<aTypes>],
    [<aWidths>],
    [<aDecimals>]) --> nFields

ALIAS() :

Return a specified work area alias

ALIAS([<nWorkArea>]) --> cAlias

BOF() :

Determine when beginning of file is encountered

BOF() --> lBoundary

DBAPPEND() :

Add a new record

DBAPPEND() --> NIL

DBCLEARFILTER() :

Clear a filter condition

DBCLEARFILTER() –> NIL

DBCLEARIND() : Close all indexes for the current work area

    DBCLEARINDEX() --> NIL

DBCLEARREL() :

Clear active relations

DBCLEARRELATION() --> NIL

DBCLOSEALL() :

Close all occupied workareas

DBCLOSEALL() --> NIL

DBCLOSEAREA() :

Close a workarea

DBCLOSEAREA() --> NIL

DBCOMMIT() :

Flush pending updates

DBCOMMIT() --> NIL

DBCOMMITALL() :

Flush pending updates in all workareas

DBCOMMITALL() --> NIL

DBCREATE() :

Create a database file from a database structure array

DBCREATE(<cDatabase>, <aStruct> [, <cDriver> ] ) --> NIL

DBCREATEIND() :

Create an Index

   DBCREATEINDEX(<cIndexName>, <cKeyExpr>,
        [<bKeyExpr>], [<lUnique>]) --> NIL

DBDELETE() :

Mark a record for deletion

DBDELETE() --> NIL

DBEDIT() :

Browse records in a table layout

    DBEDIT([<nTop>], [<nLeft>],
        [<nBottom>], <nRight>],
        [<acColumns>],
        [<cUserFunction>],
        [<acColumnSayPictures> | <cColumnSayPicture>],
        [<acColumnHeaders> | <cColumnHeader>],
        [<acHeadingSeparators> | <cHeadingSeparator>],
        [<acColumnSeparators> | <cColumnSeparator>],
        [<acFootingSeparators> | <cFootingSeparator>],
        [<acColumnFootings> | <cColumnFooting>]) --> NIL

DBEVAL() :

Evaluate a code block for each record

DBEVAL(<bBlock>,
    [<bForCondition>],
    [<bWhileCondition>],
    [<nNextRecords>],
    [<nRecord>],
    [<lRest>]) --> NIL

**DBF()* :**

Return current alias name

DBF() --> cAlias

DBFIELDINFO() :

Return and optionally change information about a field

DBFIELDINFO(<nInfoType>,

        <nFieldPos>,
        [<expNewSetting>]) --> uCurrentSetting

DBFILEGET() :

Insert the contents of a field into a file

     DBFILEGET(<nFieldPos>, <cTargetFile>, <nMode>)
        --> lSuccess

DBFILEPUT() :

Insert the contents of a file into a field

     DBFILEPUT(<nFieldPos>, <cSourceFile>)
        --> lSuccess

DBFILTER() :

Return the current filter expression as a character string

DBFILTER() --> cFilter

DBGOBOTTOM() :

Move to the last logical record

DBGOBOTTOM() --> NIL

DBGOTO() :

Move to a particular record

DBGOTO(<nRecordNumber>) --> NIL

DBGOTOP() :

Move to the first logical record

DBGOTOP() --> NIL

DBINFO() :

Return and optionally change database file information

    DBINFO(<nInfoType>, [<expNewSetting>])
        --> uCurrentSetting

DBORDERINFO() : Return and optionally change information about orders and index files

    DBORDERINFO(<nInfoType>,   [<cIndexFile>],
        [<cOrder> | <nPosition>],
        [<expNewSetting>]) --> uCurrentSetting

DBRECALL() :

Reinstate a record marked for deletion

DBRECALL() --> NIL

DBRECORDINFO() :

Return and optionally change information about a record

    DBRECORDINFO(<nInfoType>,
        [<nRecord>],
        [<expNewSetting>]) --> uCurrentSetting

DBREINDEX() :

Recreate all active indexes for the current work area

    DBREINDEX() --> NIL

DBRELATION() :

Return the linking expression of a specified relation

DBRELATION( <nRelation> ) --> cLinkExp

DBRLOCK() :

Lock the record at the current or specified identity

    DBRLOCK([<xIdentity>]) --> lSuccess

DBRLOCKLIST() Return an array of the current lock list

   DBRLOCKLIST() --> aRecordLocks

DBRSELECT() :

Return the target workarea number of a relation

DBRSELECT( <nRelation> ) --> nWorkArea

DBRUNLOCK()

Release all or specified record locks

    DBRUNLOCK([<xIdentity>]) --> NIL

DBSEEK() :

Search for a key value

DBSEEK(<expKey>, [<lSoftSeek>]) --> lFound

DBSELECTAR() :

Change the current workarea

DBSELECTAREA(<nArea> | <cAlias>) --> NIL

DBSETDRIVER() :

Set the default database driver

DBSETDRIVER([<cDriver>]) --> cCurrentDriver

DBSETFILTER() :

Set a filter condition

DBSETFILTER(<bCondition>, [<cCondition>]) --> NIL

DBSETINDEX()

Empty orders from an order bag into the order list

    DBSETINDEX(<cOrderBagName>) --> NIL

DBSETORDER()

Set the controlling order

    DBSETORDER(<nOrderNum>) --> NIL

DBSETRELAT() :

Relate two workareas

DBSETRELATION( <nArea> | <cAlias>, <bExpr>, [<cExpr>]) --> NIL

DBSKIP() :

Move relative to the current record

DBSKIP([<nRecords>]) --> NIL

DBSTRUCT() :

Create an array containing the structure of a database file

DBSTRUCT() --> aStruct

DBUNLOCK()

Release all locks for the current work area

    DBUNLOCK() --> NIL

DBUNLOCKALL()

Release all locks for all work areas

    DBUNLOCKALL() --> NIL

DBUSEAREA() :

Use a database file in a workarea

DBUSEAREA( [<lNewArea>],
    [<cDriver>],
    <cName>,
    [<xcAlias>],
    [<lShared>],
    [<lReadonly>]) --> NIL

DELETED() :

Return the deleted status of the current record

DELETED() --> lDeleted

EOF() :

Determine when end of file is encountered

EOF() --> lBoundary

FCOUNT() :

Return the number of fields in the current (.dbf) file

FCOUNT() --> nFields

FIELD() :

Return a field name from the current (.dbf) file

    FIELD/FIELD(<nPosition>) --> cFieldName

FIELDBLOCK() :

Return a set-get code block for a field variable

FIELDBLOCK(<cFieldName>) --> bFieldBlock

FIELDGET() :

Retrieve the value of a field using the ordinal position of the field in the database structure

FIELDGET(<nField>) --> ValueField

FIELDNAME() :

Return a field name from the current (.dbf) file

FIELDNAME/FIELD(<nPosition>) --> cFieldName

FIELDPOS() :

Return the position of a field in a workarea

FIELDPOS(<cFieldName>) --> nFieldPos

FIELDPUT() :

Set the value of a field variable using the ordinal position of the field in the database structure

FIELDPUT(<nField>, <expAssign>) --> ValueAssigned

FIELDWBLOCK() :

Return a set-get block for a field in a given workarea

FIELDWBLOCK(<cFieldName>, <nWorkArea>) --> bFieldWBlock

FLOCK() :

Lock an open and shared database file

FLOCK() –> lSuccess

FOUND() :

Determine if the previous search operation succeeded

FOUND() --> lSuccess

HEADER() :

Return the current database file header length

HEADER() --> nBytes

LASTREC() :

Determine the number of records in the current (.dbf) file

LASTREC() | RECCOUNT()* --> nRecords

LUPDATE() :

Return the last modification date of a (.dbf) file

LUPDATE() --> dModification

**RECCOUNT()* :**