Library Function Table
From Recital Documentation Wiki
Revision as of 13:50, 31 March 2009 by Yvonnemilne (Talk | contribs)
The following table is a quick reference to all of the functions available in the RECITAL/Library. The file column lists the type of RECITAL files that the function works with, that is .DBF, .DBT, .NDX and/or .DBX files.
| FUNCTION | FILE | DESCRIPTION |
| dbakey() | ndx | Add key to index file |
| dbappend() | dbf | Append record to end of database file |
| dbatofld() | dbf | Convert ASCII to numeric field |
| dbatokey() | ndx | Convert ASCII to numeric/date key |
| dbckey() | ndx | Obtain current key from index file |
| dbclose() | dbf | Close a database |
| dbcreat() | dbf | Create a new database |
| dbcreatx() | dbf | Create a new database with field descriptions |
| dbdcache() | dbf | Specify database cache size |
| dbdelete() | dbf | Mark a data record deleted |
| dbdo() | Execute a RECITAL program | |
| dbfield() | dbf | Extract field value |
| dbfilemode() | dbf/ndx | Specify file operation mode |
| dbfldtoa() | dbf | Convert numeric field to ASCII |
| dbflush() | dbf | Flush I/O buffer cache for a database file |
| dbfwd() | ndx | Position access pointer to the end of index file |
| dbgather() | dbf | Returns field buffer data to the record buffer |
| dbgcache() | dbf | Enables the distributed cache manager on OpenVMS |
| dbgetf() | dbf | Obtain database information |
| dbgetfx() | dbf | Obtain extra database information |
| dbgetm() | dbt | Get memo from memo file |
| dbgetnr() | dbf/ndx | Retrieve next data record by key |
| dbgetpr() | dbf/ndx | Retrieve previous data record by key |
| dbgetr() | dbf | Retrieve a data record |
| dbgetrk() | dbf/ndx | Retrieve data record by key |
| dbgetseqno() | dbf | Return the next sequence number |
| dbicache() | ndx | Specify index cache |
| dbiclose() | ndx | Close index file |
| dbicreat() | ndx | Create an index file |
| dbiflsh() | ndx | Flush I/O buffer cache for an index file |
| dbiopen() | ndx | Open an existing index file |
| dbkexpr() | ndx | Obtain index file information |
| dbkeytoa() | ndx | Convert numeric/data key to ASCII |
| dblockf() | dbf | Lock database file |
| dblocki() | ndx | Lock index file |
| dblockr() | dbf | Lock a record in a database file |
| dbmclose() | dbt | Close memo file |
| dbmcreat() | dbt | Create a memo file |
| dbmemoformat() | dbt | Toggles memo input formatting |
| dbmopen() | dbt | Open an existing memo file |
| dbnkey() | ndx | Obtain next key |
| dbonerror() | Enable/disable recovery from I/O errors | |
| dbopen() | dbf | Open an existing database |
| dbpkey() | ndx | Obtain previous key |
| dbputm() | dbt | Put memo in a memo file |
| dbputr() | dbf | Insert record in database file |
| dbputrk() | dbf/ndx | Add key to index file and insert record into database file |
| dbrecall() | dbf | Recall deleted data record |
| dbrecin() | dbf | Place contents of fields into buffers |
| dbrecout() | dbf | Place contents of buffers into fields |
| dbrewind() | ndx | Position access pointer to the top of index file |
| dbrmvkey() | ndx | Remove key from index file |
| dbrmvr() | dbf | Physically remove a data record |
| dbrun() | Run an operating system command | |
| dbscatter() | dbf | Splits the record buffer into individual field buffers |
| dbset() | Issues a Recital SET COMMAND | |
| dbsetseqno() | dbf | Set the sequence number in a table |
| dbsize() | dbf | Obtain number of records in a database |
| dbstrcpy() | Format string for fields and keys | |
| dbstring() | Convert non 'C' string to a 'C' null terminated string | |
| dbtkey() | ndx | Translate key to record number |
| dbtlockf() | dbf | Test to see if a database is locked by another user |
| dbtlockr() | dbf | Test to see if a record is locked by another user |
| dbunlockf() | dbf | Unlock a database file |
| dbunlocki() | ndx | Unlock a index file |
| dbunlockr() | dbf | Unlock a record in a database |
| dbupdm() | dbt | Update a memo in a memo file |
| dbupdr() | dbf | Update a data record |
| dbxakey() | dbx | Add keys to all tags in a tagged index file |
| dbxckey() | dbx | Read current key |
| dbxclose() | dbx | Close an open tagged index file |
| dbxcreate() | dbx | Create a tag in a tagged index file |
| dbxdroptag() | dbx | Drop the specified tag from a tagged index file |
| dbxflsh() | dbx | Flush I/O buffer cache for a tagged index file |
| dbxfwd() | dbx | Position access pointer to end of active tag |
| dbxgetnr() | dbx | Get next data record by key in active tag |
| dbxgetpr() | dbx | Get previous data record by key in active tag |
| dbxgetrk() | dbx | Get data record by key in active tag |
| dbxgoto() | dbx | Go to specified record number and reposition keys in tag |
| dbxkexpr() | dbx | Get the key expression for a specified tag |
| dbxlocki() | dbx | Lock tagged index file |
| dbxnkey() | dbx | Read next key in active tag |
| dbxnotags() | dbx | Return the number of tags in a tagged index file |
| dbxopen() | dbx | Open a dbx index file |
| dbxpkey() | dbx | Read previous key in active tag |
| dbxrewind() | dbx | Position access pointer to beginning of active tag |
| dbxrmvkey() | dbx | Remove key from all tags in tagged index file |
| dbxtag() | dbx | Change the active tag |
| dbxtkey() | dbx | Translate tag key to record number |
| dbxunlocki() | dbx | Unlock tagged index file |
| dbxupd() | dbx | Update all tags in the tagged index file for the specified record |
