Home Library Learn Downloads Support Community
Sign in | United States - English | |
0 out of 86 rated this helpful - Rate this topic

DirectorySearcher.PageSize Property

.NET Framework 3.5

Gets or sets a value indicating the page size in a paged search.

Namespace:  System.DirectoryServices
Assembly:  System.DirectoryServices (in System.DirectoryServices.dll)
C#
C++
JScript
VB
Copy 
[DSDescriptionAttribute("DSPageSize")]
public int PageSize { get; set; }

Property Value

Type: System.Int32
The maximum number of objects the server can return in a paged search. The default is zero, which means do not do a paged search.
Exception Condition
ArgumentException

The new value is less than zero.

After the server has found the number of objects that are specified by the PageSize property, it will stop searching and return the results to the client. When the client requests more data, the server will restart the search where it left off.

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Note the differences between Paged and Non-Paged searches
Paged searches will chunk up the result data and return data to the client, whilst the search continues.

Non-paged searches will try to do the entire search on the server, and then return the results.

The SizeLimit property will only affect non-paged searches. Even when the SizeLimit is set to zero the number of results will be limited by the server (usually 1000).
To do a non-paged search leave the PageSize property as the default = 0.

A paged search will return all results, without limit.
To do a paged search set the PageSize property greater than 0, and less than the maximum page limit size (~1000).
History
This method does not work as described and only 1000 records are returned at a time no matter what
This method does not work as described and only 1000 records are returned at a time no matter what.
- No, it does work - you need to set the PageSize between 0 and 1000, so that the data is paged. The SizeLimit property will then be ignored.
History