IixssoQuery::GroupBy property

[Indexing Service is no longer supported as of Windows XP and is unavailable for use as of Windows 8. Instead, use Windows Search for client side search and Microsoft Search Server Express for server side search.]

Groups search results by value within a column. For example, searches could group, in the result table, all documents written by one author.

This property is read/write.


HRESULT put_GroupBy(
  [in]          BSTR val

HRESULT get_GroupBy(
  [out, retval] BSTR *val

Property value

A grouping specification made up of a type (currently only [unique] is supported), a property name, and a sort order ([a] for ascending or [d] for descending). In unique grouping, unique values of the column set form the individual categories. The syntax for the unique grouping term is:

unique fname [ {[a]|[d]} ] [ , fname2 {[a]|[d]} ... ]

where fname, or fname2, is the friendly name assigned by the DefineColumn method.

Because the initial default value for a type is also unique, you can omit this term. Column names separated by a plus sign (+) are grouped in individual categories, and column names following a comma (,) are grouped together into subgroups of the previous grouping.


For Web clients, the query string variables in URLs associated with this property are gr (group) and gd (group in descending order).


Minimum supported client
Windows 2000 Professional [desktop apps only]
Minimum supported server
Windows 2000 Server [desktop apps only]
End of client support
Windows 7
End of server support
Windows Server 2008 R2

See also