Membership.GetAllUsers Method (Int32, Int32, Int32)

Gets a collection of all the users in the database in pages of data.

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

public:
static MembershipUserCollection^ GetAllUsers (
	int pageIndex, 
	int pageSize, 
	[OutAttribute] int% totalRecords
)
public static MembershipUserCollection GetAllUsers (
	int pageIndex, 
	int pageSize, 
	/** @attribute OutAttribute() */ /** @ref */ int totalRecords
)
Not applicable.

Parameters

pageIndex

The index of the page of results to return. Use 0 to indicate the first page.

pageSize

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

totalRecords

The total number of users.

Return Value

A MembershipUserCollection of MembershipUser objects representing all the users in the database for the configured applicationName.

Exception typeCondition

ArgumentException

pageIndex is less than zero.

-or-

pageSize is less than 1.

The results returned by GetAllUsers are constrained by the pageIndex and pageSize parameters. The pageSize parameter identifies the maximum number of MembershipUser objects to return in the MembershipUserCollection. The pageIndex parameter identifies which page of results to return, where 0 identifies the first page. The totalRecords parameter is an out parameter that is set to the total number of membership users for the configured applicationName. For example, if there are 13 users for the configured applicationName, and the pageIndex value was 1 with a pageSize of 5, the MembershipUserCollection returned would contain the sixth through the tenth users returned. totalRecords would be set to 13.

The following code example returns a list of users in pages of data with a count of the number of users currently online.

No code example is currently available or this language may not be supported.

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: