Back to Devexpress

TcxCustomDataSource.GetRecordHandle(Integer) Method

vcl-cxcustomdata-dot-tcxcustomdatasource-dot-getrecordhandle-x28-system-dot-integer-x29.md

latest1.5 KB
Original Source

TcxCustomDataSource.GetRecordHandle(Integer) Method

Returns the record handle for a specific record’s index before the data controller retrieves data from the data source for the first time.

Declaration

delphi
function GetRecordHandle(ARecordIndex: Integer): TcxDataRecordHandle; virtual;

Parameters

NameType
ARecordIndexInteger

Returns

Type
TcxDataRecordHandle

Remarks

By default, the GetRecordHandle method retrieves the same value as the ARecordIndex parameter. The GetRecordHandle method is called for every record in the data source before the data controller retrieves data from it. The number of records is determined by the GetRecordCount function. See the TcxCustomDataSource class to learn more about record indexes and handles.

Record handles retrieved by this method are stored in an internal array along with record indexes. When displaying data, record handles are retrieved from this array for specific record indexes by the GetRecordHandleByIndex method.

See Also

TcxCustomDataSource Class

TcxCustomDataSource Members

cxCustomData Unit