Share via

ApiExplorer.ShouldExploreController Method

  • Article

Determines whether the controller should be considered for ApiDescriptions generation. Called when initializing the ApiDescriptions.

Namespace:  System.Web.Http.Description
Assembly:  System.Web.Http (in System.Web.Http.dll)

Syntax

'Declaration
Public Overridable Function ShouldExploreController ( _
    controllerVariableValue As String, _
    controllerDescriptor As HttpControllerDescriptor, _
    route As IHttpRoute _
) As Boolean
'Usage
Dim instance As ApiExplorer 
Dim controllerVariableValue As String 
Dim controllerDescriptor As HttpControllerDescriptor 
Dim route As IHttpRoute 
Dim returnValue As Boolean 

returnValue = instance.ShouldExploreController(controllerVariableValue, _
    controllerDescriptor, route)

public virtual bool ShouldExploreController(
    string controllerVariableValue,
    HttpControllerDescriptor controllerDescriptor,
    IHttpRoute route
)

public:
virtual bool ShouldExploreController(
    String^ controllerVariableValue, 
    HttpControllerDescriptor^ controllerDescriptor, 
    IHttpRoute^ route
)

abstract ShouldExploreController : 
        controllerVariableValue:string * 
        controllerDescriptor:HttpControllerDescriptor * 
        route:IHttpRoute -> bool  
override ShouldExploreController : 
        controllerVariableValue:string * 
        controllerDescriptor:HttpControllerDescriptor * 
        route:IHttpRoute -> bool

public function ShouldExploreController(
    controllerVariableValue : String, 
    controllerDescriptor : HttpControllerDescriptor, 
    route : IHttpRoute
) : boolean

Parameters

  • controllerVariableValue
    Type: System.String

    The controller variable value from the route.

Return Value

Type: System.Boolean
true if the controller should be considered for ApiDescriptions generation, false otherwise.

See Also

Reference

ApiExplorer Class

System.Web.Http.Description Namespace