Click or drag to resize

SavedFilterExtractFilterFromReq Method (IAppContext, HttpRequest, String, SavedFilter)

Extract any general filter clause from the request. Use this method to obtain the filter clause and SavedFilter specified in the request via the name (defaults to 'flt') parameter. The value must be a special SavedFilter identifier generated using one of the RegisterReqFilter(IAppContext, String) overloads. If the parameter is not present, or its value is blank/null, a blank/null clause will be returned and the returned filter will be null.
Remarks
In early version of the platform providing a raw SQL filter clause was allowed, but due to the risk of SQL injection this is no longer supported and an error will be thrown if a non-blank/empty parameter value is found that is not a recognized SavedFilter identifier.

Namespace:  NetQuarry
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public static string ExtractFilterFromReq(
	IAppContext cxt,
	HttpRequest req,
	string name,
	out SavedFilter filter
)

Parameters

cxt
Type: NetQuarryIAppContext
The application context.
req
Type: System.WebHttpRequest
The HTTP request object.
name
Type: SystemString
The name of the request parameter (defaults to 'flt').
filter
Type: NetQuarrySavedFilter
The SavedFilter, if any, which may include a filter description.

Return Value

Type: String
The extracted filter clause, if any.
See Also