Functions.DbRecordInfo Method |  |
Retrieve field definition information about a record.
Namespace:
XSharp.RT
Assembly:
XSharp.RT (in XSharp.RT.dll) Version: 2.16
Syntax FUNCTION DbRecordInfo(
kInfoType,
uRecId,
uNewValue
) AS USUAL CLIPPER
[ClipperCallingConventionAttribute(new string[] { ... })]
public static Usual DbRecordInfo(
Usual kInfoType = default,
Usual uRecId = default,
Usual uNewValue = default
)
Request Example
View SourceParameters
- kInfoType (Optional)
- Type: Usual
Determines what type of information is retrieved.
The constants are listed below.
- uRecId (Optional)
- Type: Usual
- uNewValue (Optional)
- Type: Usual
This parameter is reserved for RDDs that allow you to change the information rather than just retrieve it. None of the supplied RDDs support this argument. Either omit the argument or specify it as NIL.
Return Value
Type:
Usual
Remarks
DBRecordInfo() retrieves information about the state of a record (row).
The type of information retrieved is specified as kInfoType:
Constant Return Value
DBRI_BUFFPTR Pointer to current record buffer
DBRI_DELETED Get deleted flag of record
DBRI_LOCKED Is given record locked ?
DBRI_RECSIZE Length of record
DBRI_RECNO Get records position
DBRI_UPDATED Force to rewrite buffer
Important! DBRI_USER is a constant that returns the minimum value that third-party RDD developers can use for defining new kInfoType parameters. Values less than DBRI_USER are reserved for Computer Associates development.
Examples
The following examples retrieve record information:
1DBRecordInfo(DBRI_RECSIZE)
2
3DBRecordInfo(DBRI_LOCKED, 200)
4
5DBRecordInfo(DBRI_DELETED, 201)
6
7DBRecordInfo(DBRI_FORCEREFRESH)
8
9DBRecordInfo(DBRI_RECNO, 230)
10
11
12
13
14DBRecordInfo(DBRI_BUFFPTR)
15
See Also