PSObject.CompareTo(Object) Method

  • Reference

Definition

Namespace:
System.Management.Automation
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Compares the current instance with another object of the same type.

public:
 virtual int CompareTo(System::Object ^ obj);
public:
 int CompareTo(Platform::Object ^ obj);
int CompareTo(winrt::Windows::Foundation::IInspectable const & obj);
public int CompareTo (object obj);
abstract member CompareTo : obj -> int
override this.CompareTo : obj -> int
Public Function CompareTo (obj As Object) As Integer

Parameters

obj
Object

An object to compare with this instance.

Returns

Int32

A 32-bit signed integer that indicates the relative order of the comparands. The return value has these meanings: Value Meaning Less than zero This instance is less than obj. Zero This instance is equal to obj. Greater than zero This instance is greater than obj.

Implements

CompareTo(Object)

Exceptions

ExtendedTypeSystemException

If obj has a different type than this instance's BaseObject or if the BaseObject does not implement IComparable.

Applies to