IPropertyDescription::GetGroupingRange method (propsys.h)

Gets the grouping method to be used when a view is grouped by a property, and retrieves the grouping type.

Syntax

HRESULT GetGroupingRange(
  [out] PROPDESC_GROUPING_RANGE *pgr
);

Parameters

[out] pgr

Type: PROPDESC_GROUPING_RANGE*

Receives a pointer to a flag value that indicates the grouping type. The possible values are:

PDGR_DISCRETE

Displays individual values.

PDGR_ALPHANUMERIC

Displays static alphanumeric ranges.

PDGR_SIZE

Displays static size ranges.

PDGR_DYNAMIC

Displays dynamically created ranges.

PDGR_DATE

Displays month and year groups.

PDGR_PERCENT

Displays percent groups.

PDGR_ENUMERATED

Displays percent groups returned by IPropertyDescription::GetEnumTypeList.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The information retrieved by this method comes from the groupingRange attribute of the typeInfo element in the property's .propdesc file.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header propsys.h

See also

IPropertyDescription

Property Description Schema