xHarbour Reference Documentation > Function Reference

DbRecordInfo()

Queries and/or changes information about a record of an open database file.

Syntax

DbRecordInfo( <nDefine>, [<nRecord>], [<xNewSetting>] ) --> xOldSetting

Arguments

<nDefine>

This is a numeric parameter for which #define constants exist in the file DbInfo.ch. They identify the individual data that can be queried for a single record.

<nRecord>

The parameter identifies the record in a database to query data for. It defaults to the return value of Recno(), the current record.

<xNewSetting>

This parameter is reserved for RDDs that allow the record information to be changed.

Return

DbRecordInfo() returns the queried record information as supplied by the replaceable database driver (RDD).

Description

DbRecordInfo() queries detailed record information from the replaceable database driver (RDD). Depending on database and RDD used, different information may be available. The type of information to retrieve is specified with #define constants available in the DBINFO.CH header file.

Constants for DbRecordInfo()

Constant	Return value
DBRI_DELETED	The Deleted() flag of a record as a logical value
DBRI_ENCRYPTED	The encrypted flag of a record as a logical value
DBRI_LOCKED	The write lock status of a record as a logical value
DBRI_RAWDATA	The raw data of a record as a character string
DBRI_RAWMEMOS	The raw memo field data of a record as a character string
DBRI_RAWRECORD	The raw data of a record except memo fields as a character string
DBRI_RECNO	The numeric relative record position, see OrdKeyNo()
DBRI_RECSIZE	The numeric size of a record, see RecSize()
DBRI_UPDATED	The updated flag of a record as a logical value

By default, DbRecordInfo() operates in the current work area. Use an aliased expression to query field information in different work areas.

Info

See also:	Alias(), DbInfo(), DbFieldInfo(), DbOrderInfo(), DbUseArea(), Deleted(), OrdKeyNo(), RecSize(), RLock(), Select()
Category:	Database functions , Info functions
Header:	Dbinfo.ch
Source:	rdd\dbcmd.c
LIB:	xhb.lib
DLL:	xhbdll.dll