ActiveDirectoryMembershipProvider.GetAllUsers Method (Int32, Int32, Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a collection of all the users stored in an Active Directory data source.

Namespace:   System.Web.Security
Assembly:  System.Web (in System.Web.dll)

[DirectoryServicesPermissionAttribute(SecurityAction.Assert, 
	Unrestricted = true)]
[DirectoryServicesPermissionAttribute(SecurityAction.Demand, 
	Unrestricted = true)]
[DirectoryServicesPermissionAttribute(SecurityAction.InheritanceDemand, 
	Unrestricted = true)]
public override MembershipUserCollection GetAllUsers(
	int pageIndex,
	int pageSize,
	out int totalRecords
)

Parameters

pageIndex
Type: System.Int32

The index of the page of results to return. pageIndex is zero-based.

pageSize
Type: System.Int32

The size of the page of results to return.

totalRecords
Type: System.Int32

When this method returns, contains the total number of records returned in the collection. This parameter is passed uninitialized.

Return Value

Type: System.Web.Security.MembershipUserCollection

A MembershipUserCollection containing pageSizeMembershipUser instances beginning at the page specified by pageIndex.

Exception Condition
InvalidOperationException

The GetAllUsers method is called before the ActiveDirectoryMembershipProvider instance is initialized.

ArgumentException

pageIndex is less than 0.

-or

pageSize is less than 1.

- or -

pageSize multiplied by pageIndex, plus pageSize, minus 1 is greater than MaxValue.

NotSupportedException

The EnableSearchMethods property is false.

This method is called by the Membership class to retrieve user information from the Active Directory data store specified in the ASP.NET application's configuration file.

The results returned by the GetAllUsers method are constrained by the pageIndex and pageSize parameters. The pageSize parameter specifies the maximum number of MembershipUser instances to return in the MembershipUserCollection collection. The pageIndex parameter specifies which page of results to return, where 0 (zero) indicates the first page.

The totalRecords parameter is an out parameter that is set to the total number of matching membership users found in the Active Directory data store. For example, if there are 13 users for the configured data store, and the pageIndex value was 1 with la pageSize of 5, the MembershipUserCollection returned would contain the sixth through the tenth users. The totalRecords parameter would be set to 13.

You can control whether to allow searching for users by setting the EnableSearchMethods property in the application's configuration file using the enableSearchMethods attribute of the membership Element (ASP.NET Settings Schema) element. Setting the EnableSearchMethods property to false causes the GetAllUsers method to throw a NotSupportedException exception.

The provider uses a subtree search starting at the search point specified in the connection string. See the ActiveDirectoryMembershipProvider class topic for more information about connection strings.

We recommend that you do not enable searching on production systems until you have confirmed that the search queries issued by the ActiveDirectoryMembershipProvider class do not adversely impact your directory server's performance. Since the ActiveDirectoryMembershipProvider class is designed for a stateless Web environment, it is unable to use the paging optimizations exposed by the underlying System.DirectoryServices APIs. This means that paging operations during searches against large directories are very expensive and should be avoided. Search operations are always issued against the directory server configured in the connection string, or an automatically selected server in the case of a connection string pointing at a domain. The provider does not use a global catalog for its search methods.

.NET Framework
Available since 2.0
Return to top
Show: