HelpPageSampleGenerator.GetActionSample Method

Search for samples that are provided directly through ActionSamples.
Public Overridable Function GetActionSample( _ 
ByVal controllerName As String, _ 
ByVal actionName As String, _ 
ByVal parameterNames As IEnumerable(Of String), _ 
ByVal type As Type, _ 
ByVal formatter As MediaTypeFormatter, _ 
ByVal mediaType As MediaTypeHeaderValue, _ 
ByVal sampleDirection As SampleDirection
) As Object
This language is not supported or no code example is available.
public virtual object GetActionSample( 
string controllerName
string actionName
IEnumerable<string> parameterNames
Type type
MediaTypeFormatter formatter
MediaTypeHeaderValue mediaType
SampleDirection sampleDirection 
)
This language is not supported or no code example is available.
public:  
virtual object^ GetActionSample( 
String^ controllerName
String^ actionName
IEnumerable<String^>^ parameterNames
Type^ type
MediaTypeFormatter^ formatter
MediaTypeHeaderValue^ mediaType
SampleDirection sampleDirection 
)
This language is not supported or no code example is available.
JScript does not support generic types and methods.
This language is not supported or no code example is available.

Parameters

controllerName
string

Name of the controller.

actionName
string

Name of the action.

parameterNames
IEnumerable<string>

The parameter names.

type
Type

The CLR type.

formatter
MediaTypeFormatter

The formatter.

mediaType
MediaTypeHeaderValue

The media type.

sampleDirection
SampleDirection

The value indicating whether the sample is for a request or for a response.

Return Value

object

The sample that matches the parameters.

.NET Framework

Supported in: 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8

In this article

Definition