ProfileProvider.GetAllProfiles Method (ProfileAuthenticationOption, 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.

When overridden in a derived class, retrieves user profile data for all profiles in the data source.

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

Public MustOverride Function GetAllProfiles (
	authenticationOption As ProfileAuthenticationOption,
	pageIndex As Integer,
	pageSize As Integer,
	<OutAttribute> ByRef totalRecords As Integer
) As ProfileInfoCollection

Parameters

authenticationOption
Type: System.Web.Profile.ProfileAuthenticationOption

One of the ProfileAuthenticationOption values, specifying whether anonymous, authenticated, or both types of profiles are returned.

pageIndex
Type: System.Int32

The index of the page of results to return.

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 profiles.

Return Value

Type: System.Web.Profile.ProfileInfoCollection

A ProfileInfoCollection containing user-profile information for all profiles in the data source.

The GetAllProfiles method is used to retrieve profile information for all profiles. Only data for the applicationName specified in the configuration file is returned. The authenticationOption parameter specifies whether only anonymous profiles, only authenticated profiles, or all profiles are searched.

The results returned by GetAllInactiveProfiles are constrained by the pageIndex and pageSize parameters. The pageSize parameter identifies the maximum number of ProfileInfo objects to return in the ProfileInfoCollection. The pageIndex parameter identifies which page of results to return, where zero identifies the first page. The totalRecords parameter is an out parameter that is set to the total number of inactive user profiles for the configured applicationName, based on the authenticationOption and userInactiveSinceDate parameters. For example, if there are 13 users for the configured applicationName, and the pageIndex value is 1 with a pageSize of 5, the ProfileInfoCollection returned would contain the sixth through the tenth inactive profiles returned. The totalRecords parameter would be set to 13.

The following code example shows the method signature for an implementation of the GetAllProfiles method. For an example of a full ProfileProvider implementation, see How to: Build and Run the Profile Provider Example.

Public Overrides Function GetAllProfiles( _
ByVal authenticationOption As ProfileAuthenticationOption, _
ByVal pageIndex As Integer, _
ByVal pageSize As Integer, _
 ByRef totalRecords As Integer) As ProfileInfoCollection

  totalRecords = 0

  Return New ProfileInfoCollection()
End Function

.NET Framework
Available since 2.0
Return to top
Show: