SPRequestUsageDefinition.FilterRequest Method

Filters out page requests based on URLs, HTTP status, and other parameters.

Namespace:  Microsoft.SharePoint.Administration
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
Public Function FilterRequest ( _
    statusCode As Integer, _
    url As String, _
    userAgent As String, _
    user As String _
) As Boolean
'Usage
Dim instance As SPRequestUsageDefinition
Dim statusCode As Integer
Dim url As String
Dim userAgent As String
Dim user As String
Dim returnValue As Boolean

returnValue = instance.FilterRequest(statusCode, _
    url, userAgent, user)

public bool FilterRequest(
    int statusCode,
    string url,
    string userAgent,
    string user
)

Parameters

• statusCode
  Type: System.Int32

  The status of the HTTP response, for example, success, redirect, or failure.

• url
  Type: System.String

  The absolute URL for the server, site, Web, document, and query string.

• userAgent
  Type: System.String

  The browser name, the major and minor versions of the browser, and whether the browser is a beta release.

• user
  Type: System.String

  The name of the user who initiated the usage entry.

Return Value

Type: System.Boolean
true if the request is filtered on any of the parameters; otherwise, false.

See Also

Reference

SPRequestUsageDefinition Class

SPRequestUsageDefinition Members

Microsoft.SharePoint.Administration Namespace

HttpStatusCode