BuildProcess.ApplyManualApiFilter Method

BuildProcessApplyManualApiFilter Method

This is used to manually apply the specified API filter to the specified reflection information file

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

Syntax

C++

Copy

public void ApplyManualApiFilter(
	ApiFilterCollection filterToApply,
	string reflectionFilename
)

Public Sub ApplyManualApiFilter ( 
	filterToApply As ApiFilterCollection,
	reflectionFilename As String
)

public:
void ApplyManualApiFilter(
	ApiFilterCollection^ filterToApply, 
	String^ reflectionFilename
)

member ApplyManualApiFilter : 
        filterToApply : ApiFilterCollection * 
        reflectionFilename : string -> unit

Parameters

filterToApply: Type: SandcastleBuilder.UtilsApiFilterCollection
The API filter to apply
reflectionFilename: Type: SystemString
The reflection information file

Remarks

This can be used by any plug-in that does not produce a reflection information file using MRefBuilder.exe. In such cases, the API filter is not applied unless the plug-in uses this method. If the reflection information file is produced by MRefBuilder.exe, there is no need to use this method as it will apply the API filter automatically to the file that it produces.

Reference

BuildProcess Class

SandcastleBuilder.Utils.BuildEngine Namespace