NullableTypes Class Library

NullableString.CompareOrdinal Method (NullableString, Int32, NullableString, Int32, Int32)

Compares substrings of the two specified NullableString structures ,without considering the local national language or culture.

[Visual Basic]
Overloads Public Shared Function CompareOrdinal( _
   ByVal a As NullableString, _
   ByVal indexA As Integer, _
   ByVal b As NullableString, _
   ByVal indexB As Integer, _
   ByVal length As Integer _
) As Integer
[C#]
public static int CompareOrdinal(
   NullableString a,
   int indexA,
   NullableString b,
   int indexB,
   int length
);

Parameters

a
A NullableString structure.
indexA
The position of the substring within a.
b
A NullableString structure.
indexB
The position of the substring within b.
length
The maximum number of characters in the substrings to compare.

Return Value

A 32-bit signed integer indicating the lexical relationship between the two comparands.

ValueDescription
A negative integer the substring in a is less than the substring in b.
Zero the substring in a is equal to the substring in b.
A positive integer the substring in a is greater than the substring in b.

-or-

b is Null.

Remarks

By definition, any NullableString, including the Empty string, compares greater than Null; and two Null compare equal to each other. indexA and indexB are zero-based. length cannot be negative. If length is zero, then zero is returned. The number of characters compared is the lesser of the length of a less indexA, the length of b less indexB, and length.

Exceptions

Exception TypeCondition
ArgumentOutOfRangeException The sum of indexA and length is greater than a.

-or-

The sum of indexB and length is greater than b.

-or-

indexA, indexB or length is negative.

See Also

NullableString Class | NullableTypes Namespace | NullableString.CompareOrdinal Overload List