Version.CompareTo Method (Object)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Compares the current Version object to a specified object and returns an indication of their relative values.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

Syntax

Public Function CompareTo ( _
    version As Object _
) As Integer
public int CompareTo(
    Object version
)

Parameters

  • version
    Type: System..::.Object
    An object to compare, or nullNothingnullptra null reference (Nothing in Visual Basic).

Return Value

Type: System..::.Int32

Return Value

Description

Less than zero

The current Version object is a version before version.

Zero

The current Version object is the same version as version.

Greater than zero

The current Version object is a version subsequent to version.

-or-

version is nullNothingnullptra null reference (Nothing in Visual Basic).

Implements

IComparable..::.CompareTo(Object)

Exceptions

Exception Condition
ArgumentException

version is not of type Version.

Remarks

The components of Version in decreasing order of importance are: major, minor, build, and revision. An unknown component is assumed to be older than any known component.

For example:

  • version 1.1 is older than version 1.1.0

  • version 1.1 is older than version 1.1.1

  • version 1.1 is older than version 1.1.2.3

  • version 1.1.2 is older than version 1.1.2.4

  • version 1.2.5 is newer than version 1.2.3.4

Version Notes

Windows Phone

If you pass a string to CompareTo, the method throws InvalidCastException instead of ArgumentException.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

Version Class

CompareTo Overload

System Namespace

CompareTo

Equals