TcxCustomDataSource.GetRecordId(TcxDataRecordHandle) Method

Returns a value uniquely identifying a record.

Declaration

function GetRecordId(ARecordHandle: TcxDataRecordHandle): Variant; virtual;

Parameters

Name	Type
ARecordHandle	TcxDataRecordHandle

Returns

Type
Variant

Remarks

Use the GetRecordId method to obtain the unique identifier for a dataset record. The ARecordHandle parameter specifies the handle of a dataset record whose identifier is obtained.

The return value of this method is used when saving or restoring the expansion and selection state of the records (see the SaveKeys and RestoreKeys methods descriptions). The record identifiers, unlike the record handles and indexes, are not changed when the number and order of records within the data set changes (see the TcxCustomDataSource class description for information on record indexes and record handles).

Override the IsRecordIdSupported and GetRecordId methods when implementing custom datasource (provider mode of the Express DataController).