Share via

LimitFilter Class

  • Article

Represents a Limit filter in the Business Data Catalog.

Inheritance Hierarchy

System.Object
  Microsoft.Office.Server.ApplicationRegistry.Runtime.FilterBase
    Microsoft.Office.Server.ApplicationRegistry.Runtime.UserInputFilter
      Microsoft.Office.Server.ApplicationRegistry.Runtime.LimitFilter

Namespace:  Microsoft.Office.Server.ApplicationRegistry.Runtime
Assembly:  Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public Class LimitFilter _
    Inherits UserInputFilter

'Usage
Dim instance As LimitFilter

[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public class LimitFilter : UserInputFilter

Remarks

A Limit filter limits the number of entity instances returned from the back-end method to n. When you use this filter, you pass in the number of entity instances you want returned in an input parameter to the back-end method. The back-end method then can process the input parameter and return the specified number of entity instances. SQL supports it with the SELECT TOP clause.

Note

The Limit filter does nothing to preclude bringing back large amounts of data. It is up to the metadata author to hook up the filter to an API that actually limits data. Filters are just descriptor abstractions.

By using a Limit filter, you can prevent long waits, time outs, and users from issuing bad queries that request large amounts of data.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

LimitFilter Members

Microsoft.Office.Server.ApplicationRegistry.Runtime Namespace