NullableTypes Class Library

NullableString.CompareTo Method (NullableString)

Compares this NullableString structure to a specified object and returns an indication of their relative values.

[Visual Basic]
Overloads Public Function CompareTo( _
   ByVal value As NullableString _
) As Integer
[C#]
public int CompareTo(
   NullableString value
);

Parameters

value
A NullableString to compare.

Return Value

A signed number indicating the relative values of the instance and value.

ValueDescription
A negative integer This instance is less than value.
Zero This instance is equal to value.
A positive integer This instance is greater than value.

-or-

value is Null.

Remarks

Any instance of NullableString including the Empty string, regardless of its value, is considered greater than Null; and two Null compare equal to each other.

Exceptions

Exception TypeCondition
ArgumentException The value is not of type NullableString.

See Also

NullableString Class | NullableTypes Namespace | NullableString.CompareTo Overload List