CRaPI - Correct Robust and Perfect API

Flag.IComparable.CompareTo Method

Compares the current instance with another flag.

int IComparable.CompareTo(
object pFlag
);

Parameters

pFlag: The flag to compare with.

Return Value

A 32-bit signed integer that indicates the relative order of the flags. The return value has these meanings:

Less than zero : The distance to this flag i less than to pFlag.
Zero : The distance to the flags are equal.
Greater than zero : The distance to this flag is greater than to pFlag.

Implements

IComparable.CompareTo

Exceptions

Exception Type	Condition
ArgumentException	`pFlag` is not a `Flag`.

See Also

Flag Class | TeamYaffa.CRaPI.World Namespace