FolderCompareRelativeIds Method |
Determines the relative order of two file objects or folders, in this folder, given their item identifier.
Namespace:
ShellBoost.Core.WindowsShell
Assembly:
ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
Syntax public int CompareRelativeIds(
ShellItemIdList relativeIdList1,
ShellItemIdList relativeIdList2,
SHCIDS comparison = SHCIDS.SHCIDS_NONE,
bool throwOnError = true
)
Parameters
- relativeIdList1
- Type: ShellBoost.CoreShellItemIdList
The first relative pidl. - relativeIdList2
- Type: ShellBoost.CoreShellItemIdList
The second relative pidl. - comparison (Optional)
- Type: ShellBoost.Core.WindowsShellSHCIDS
Specifies how the comparison should be performed. - throwOnError (Optional)
- Type: SystemBoolean
true to throw error; otherwise false.
Return Value
Type:
Int32A negative return value indicates that the first item should precede the second (relativeIdList1 < relativeIdList2).
A positive return value indicates that the first item should follow the second (relativeIdList1 > relativeIdList2).
A return value of zero indicates that the two items are the same (relativeIdList1 = relativeIdList2).
See Also