DirectorySearcher.SizeLimit Property (System.DirectoryServices)

SizeLimit Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

DirectorySearcher..::.SizeLimit Property

Gets or sets a value indicating the maximum number of objects that the server returns in a search.

Namespace: System.DirectoryServices
Assembly: System.DirectoryServices (in System.DirectoryServices.dll)

Syntax

Visual Basic (Declaration)

<DSDescriptionAttribute("DSSizeLimit")> _
Public Property SizeLimit As Integer

Visual Basic (Usage)

Dim instance As DirectorySearcher
Dim value As Integer

value = instance.SizeLimit

instance.SizeLimit = value

[DSDescriptionAttribute("DSSizeLimit")]
public int SizeLimit { get; set; }

Visual C++

[DSDescriptionAttribute(L"DSSizeLimit")]
public:
property int SizeLimit {
    int get ();
    void set (int value);
}

JScript

public function get SizeLimit () : int
public function set SizeLimit (value : int)

Property Value

Type: System..::.Int32
The maximum number of objects that the server returns in a search. The default value is zero, which means to use the server-determined default size limit of 1000 entries.

Exceptions

Exception	Condition
ArgumentException	The new value is less than zero.

Remarks

The server stops searching after the size limit is reached and returns the results accumulated up to that point.

Note:
If you set SizeLimit to a value that is larger than the server-determined default of 1000 entries, the server-determined default is used.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Reference

DirectorySearcher Class

DirectorySearcher Members

System.DirectoryServices Namespace