ProfileProvider.GetAllProfiles Method (System.Web.Profile)

GetAllProfiles Method

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

ProfileProvider..::.GetAllProfiles Method

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)

Syntax

Visual Basic (Declaration)

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

Visual Basic (Usage)

Dim instance As ProfileProvider
Dim authenticationOption As ProfileAuthenticationOption
Dim pageIndex As Integer
Dim pageSize As Integer
Dim totalRecords As Integer
Dim returnValue As ProfileInfoCollection

returnValue = instance.GetAllProfiles(authenticationOption, _
    pageIndex, pageSize, totalRecords)

public abstract ProfileInfoCollection GetAllProfiles(
    ProfileAuthenticationOption authenticationOption,
    int pageIndex,
    int pageSize,
    out int totalRecords
)

Visual C++

public:
virtual ProfileInfoCollection^ GetAllProfiles(
    ProfileAuthenticationOption authenticationOption, 
    int pageIndex, 
    int pageSize, 
    [OutAttribute] int% totalRecords
) abstract

JScript

public abstract function GetAllProfiles(
    authenticationOption : ProfileAuthenticationOption, 
    pageIndex : int, 
    pageSize : int, 
    totalRecords : int
) : 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.

Remarks

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.

Examples

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.

Visual Basic

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

public override ProfileInfoCollection GetAllProfiles(
    ProfileAuthenticationOption authenticationOption,
    int pageIndex,
    int pageSize,
    out int totalRecords)
{
    totalRecords = 0;

    return new ProfileInfoCollection();
}

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

Reference

ProfileProvider Class

ProfileProvider Members

System.Web.Profile Namespace

Other Resources

Implementing a Profile Provider

ASP.NET Profile Properties Overview