[<<Previous Entry]
[^^Up^^]
[Next Entry>>]
[Menu]
[About The Guide]
recInfo()
Retrieve the information about a row
------------------------------------------------------------------------------
Prototype
ERRCODE recInfo(
AREAP wa,
ITEM itmRecID,
USHORT uiInfoType,
ITEM itmInfo
)
Arguments
wa is a pointer to self.
itmRecID is a pointer to an item that determines the current row
identifier and will normally be a number indicating the row number.
uiInfoType is a value that determines the type of the
information to be provided.
itmInfo is a pointer to a CA-Clipper item which will contain the
required information. The data type of itmInfo depends on the value of
uiInfoType.
Description
recInfo() retrieves information about the state of a record
(row). The information requested is defined by the value passed in
uiInfoType. The record information that is available is defined by the
RDD. Some suggested values for uiInfoType (constants with "DBRI_"
prefix) and their associated meanings are provided in the header file
Rdd.api.
Default Behavior
recInfo() is used to implement the DBRecInfo() function and
is called any time information about the row is needed to perform an
operation. In the default implementation there are five properties
(shown in the following table) defined for each row (the constants are
defined in Rdd.api).
recInfo() Information types
------------------------------------------------------------------------
Constant Meaning
------------------------------------------------------------------------
DBRI_DELETED Check the 'deleted' status of the row
DBRI_LOCKED Check if the row is locked
DBRI_RECNO Get the row position number
DBRI_RECSIZE Get the record size
DBRI_UPDATED Check if the row was updated
------------------------------------------------------------------------
Warning! itmInfo must be a valid item.
Implementation Notes
. You must implement new behavior for this method only if your
driver requires properties in addition to those listed in
the previous table.
. If your implementation of recInfo() cannot determine the
return value based on the value of uiInfoType, you should allow the
work area default implementation to attempt it by calling
SUPER_RECINFO().
. If itmInfo contains a value other than NIL, it is the new
value for the property. If your implementation warrants, you can
change itmInfo by assigning the new value to it.
. The first 1000 possible values for uiInfoType are reserved by
CA-Clipper.
Files Header file is Rdd.api.
See Also:
AREA
fieldInfo()
info()
orderInfo()
This page created by ng2html v1.05, the Norton guide to HTML conversion utility.
Written by Dave Pearson