ApiFilter.CompareTo Method

ApiFilterCompareTo Method

Compares this instance to another instance and returns an indication of their relative values

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public int CompareTo(
	ApiFilter other
)

Public Function CompareTo ( 
	other As ApiFilter
) As Integer

public:
virtual int CompareTo(
	ApiFilter^ other
) sealed

abstract CompareTo : 
        other : ApiFilter -> int 
override CompareTo : 
        other : ApiFilter -> int

Parameters

other: Type: SandcastleBuilder.UtilsApiFilter
An ApiFilter object to compare

Return Value

Type: Int32
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.

Implements

IComparableTCompareTo(T)

Remarks

Entries are sorted by API entry type and full name

Reference

ApiFilter Class

SandcastleBuilder.Utils Namespace