FireDAC.Comp.DataSet.TFDDataSet.GetGroupState

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetGroupState(ALevel: Integer): TGroupPosInds;

C++

Data::Db::TGroupPosInds __fastcall GetGroupState(int ALevel);

Properties

Type Visibility Source Unit Parent
function public
FireDAC.Comp.DataSet.pas
FireDAC.Comp.DataSet.hpp
FireDAC.Comp.DataSet TFDDataSet

Description

Indicates where the current record is positions in a specified group of records.

Call GetGroupState to determine where the current record falls in the group of records specified by the ALevel parameter.  ALevel identifies a group by its grouping level on the current index. Grouping level 1 is the set of records with the same value on the first field in the index. Grouping level 2 is the set of records with the same values on the first two fields in the index, and so on.  GetGroupState returns one of the following values:

Value 

Meaning 

[gbMiddle]

 

The current record is neither the first, nor the last in the group. 

[gbFirst] 

The current record is the first in the group that contains at least two records. 

[gbLast] 

The current record is the last in the group that contains at least two records. 

[gbFirstgbLast] 

The current record is the only record in the group. 

[] 

  • ALevel specifies a grouping level greater than the GroupingLevel property.
  • Dataset is in one of the following states: dsInactive, dsOpening, dsInsert, dsSetKey.
  • AggregatesActive is set to False.
  • IndexName is empty.

See Also