EndpointMetadataComparer<TMetadata>.CompareMetadata Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Routing.Matching

Assembly:: Microsoft.AspNetCore.Routing.dll

Package:: Microsoft.AspNetCore.Routing v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Source:: EndpointMetadataComparer.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Compares two TMetadata instances.

protected:
 virtual int CompareMetadata(TMetadata x, TMetadata y);

protected virtual int CompareMetadata (TMetadata x, TMetadata y);

protected virtual int CompareMetadata (TMetadata? x, TMetadata? y);

abstract member CompareMetadata : 'Metadata * 'Metadata -> int
override this.CompareMetadata : 'Metadata * 'Metadata -> int

Protected Overridable Function CompareMetadata (x As TMetadata, y As TMetadata) As Integer

Parameters

x: TMetadata

The first object to compare.

y: TMetadata

The second object to compare.

Returns

Int32

An implementation of this method must return a value less than zero if x is less than y, zero if x is equal to y, or a value greater than zero if x is greater than y.

Remarks

The base-class implementation of this method will compare metadata based on whether or not they are null. The effect of this is that when endpoints are being compared, the endpoint that defines an instance of TMetadata will be considered higher priority.

Applies to