IStructuralComparable.CompareTo Method (F#)

  • Article

Determines whether the current object precedes, occurs in the same position as, or follows another object in the sort order.

Namespace/Module Path: System.Collections

Assembly: FSharp.Core (in FSharp.Core.dll)

// Signature:
abstract this.CompareTo : obj * IComparer -> int

// Usage:
iStructuralComparable.CompareTo (obj, comparer)

Parameters

  • obj
    Type: obj

    The object to compare with the current instance.

  • comparer
    Type: IComparer

    An object that performs comparisons.

Return Value

An integer that indicates the relationship of the current object to the target object.

Remarks

This API is provided for use only with the F# Runtime that targets .NET Framework 2.0. If you are using .NET Framework 4, use the .NET Framework 4 API with the same name, CompareTo.

Platforms

Windows 7, Windows Vista SP2, Windows XP SP3, Windows XP x64 SP2, Windows Server 2008 R2, Windows Server 2008 SP2, Windows Server 2003 SP2

Version Information

F# Runtime

Supported in: 2.0

Silverlight

Supported in: 3

See Also

Reference

Collections.IStructuralComparable Interface (F#)

System.Collections Namespace (F#)