IResultDataCompareEx::Compare method

The IResultDataCompareEx::Compare method provides a way for a primary snap-in to compare items for the purpose of sorting the scope and result items that it inserts in the result pane.

Syntax


HRESULT Compare(
  [in]  RDCOMPARE *prdc,
  [out] int       *pnResult
);

Parameters

prdc [in]

A pointer to an RDCOMPARE structure that holds information about the items being compared and which column in the result pane list view is being sorted.

pnResult [out]

The snap-in should set pnResult to the result of the comparison:

  • Any negative integer if item 1 < item 2
  • Zero (0) if item 1 == item 2
  • Any positive integer if item 1 > item 2

Return value

This method can return one of these values.

S_OK

The comparison was successful.

Any error code

The comparison was unsuccessful.

Remarks

Compare provides a mechanism for determining the sort order of scope and result item objects appearing in the result pane. The built-in sort provided by MMC only uses the C run-time library's string-compare function to compare the data. If this interface is implemented, it is used for all comparisons.

The comparison should be based on an ascending sort order. If the user toggles the standard result view header, the console complements the compare results, which results in a descending sort order.

The IResultDataCompareEx interface is not called for virtual list sorting. This is because the snap-in maintains all the item data storage for a virtual list, the snap-in must sort the items itself. A snap-in must implement the IResultOwnerData interface to provide sorting for virtual lists.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Mmc.h

 

 

Show: