Sandcastle Help File Builder Documentation
Api
Compares this instance to another instance and returns an indication of their relative values
Definition
Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.9.12.0
Returns -1 if this instance is less than the value, 0 if they are equal, or 1 if this instance is greater than the value or the value is null.
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.9.12.0
C#
public int CompareTo(
ApiFilter other
)VB
Public Function CompareTo (
other As ApiFilter
) As IntegerC++
public:
virtual int CompareTo(
ApiFilter^ other
) sealedF#
abstract CompareTo :
other : ApiFilter -> int
override CompareTo :
other : ApiFilter -> int Parameters
- other ApiFilter
- An ApiFilter object to compare
Return Value
Int32Returns -1 if this instance is less than the value, 0 if they are equal, or 1 if this instance is greater than the value or the value is null.
Implements
IComparableTCompareTo(T)Remarks
Entries are sorted by API entry type and full name