IShellFolderCompareIDs Method

[PreserveSigAttribute]
HResult CompareIDs(
	IntPtr lParam,
	PIDL pidl1,
	PIDL pidl2
)

<PreserveSigAttribute>
Function CompareIDs ( 
	lParam As IntPtr,
	pidl1 As PIDL,
	pidl2 As PIDL
) As HResult

Dim instance As IShellFolder
Dim lParam As IntPtr
Dim pidl1 As PIDL
Dim pidl2 As PIDL

Dim returnValue As HResult

returnValue = instance.CompareIDs(lParam, 
	pidl1, pidl2)

[PreserveSigAttribute]
HResult CompareIDs(
	IntPtr lParam, 
	[InAttribute] PIDL^ pidl1, 
	[InAttribute] PIDL^ pidl2
)

[<PreserveSigAttribute>]
abstract CompareIDs : 
        lParam : IntPtr * 
        pidl1 : PIDL * 
        pidl2 : PIDL -> HResult 

No code example is currently available or this language may not be supported.

Parameters

lParam  IntPtr

A value that specifies how the comparison should be performed.

The lower sixteen bits of lParam define the sorting rule.

Most applications set the sorting rule to the default value of zero, indicating that the two items should be compared by name. The system does not define any other sorting rules.

Some folder objects might allow calling applications to use the lower sixteen bits of lParam to specify folder-specific sorting rules. The rules and their associated lParam values are defined by the folder.

When the system folder view object calls CompareIDs(IntPtr, PIDL, PIDL), the lower sixteen bits of lParam are used to specify the column to be used for the comparison.

The upper sixteen bits of lParam are used for flags that modify the sorting rule. The system currently defines these modifier flags.

pidl1  PIDL

A pointer to the first item's ITEMIDLIST structure. It will be relative to the folder.

This ITEMIDLIST structure can contain more than one element; therefore, the entire structure must be compared, not just the first element.

pidl2  PIDL

A pointer to the second item's ITEMIDLIST structure. It will be relative to the folder.

This ITEMIDLIST structure can contain more than one element; therefore, the entire structure must be compared, not just the first element.

Return Value

If this method is unsuccessful, it returns a COM error code.

Reference