SqlProfileProvider.GetAllInactiveProfiles Method

Retrieves user profile data for profiles in which the last activity date occurred on or before the specified date and time.

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

public:
virtual ProfileInfoCollection^ GetAllInactiveProfiles (
	ProfileAuthenticationOption authenticationOption, 
	DateTime userInactiveSinceDate, 
	int pageIndex, 
	int pageSize, 
	[OutAttribute] int% totalRecords
) override
public ProfileInfoCollection GetAllInactiveProfiles (
	ProfileAuthenticationOption authenticationOption, 
	DateTime userInactiveSinceDate, 
	int pageIndex, 
	int pageSize, 
	/** @attribute OutAttribute() */ /** @ref */ int totalRecords
)
Not applicable.

Parameters

authenticationOption

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

userInactiveSinceDate

A DateTime that identifies which user profiles are considered inactive. If the LastActivityDate of a user profile occurs on or before this date and time, the profile is considered inactive.

pageIndex

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

pageSize

The size of the page of results to return.

totalRecords

When this method returns, contains an integer that identifies the total number of profiles. This parameter is passed uninitialized.

Return Value

A ProfileInfoCollection containing user profile information about the inactive profiles.

Exception typeCondition

ArgumentException

pageIndex is less than zero.

- or -

pageSize is less than one.

- or -

pageIndex multiplied by pageSize is larger than MaxValue.

The GetAllInactiveProfiles method is used to retrieve profile information from the data source for unused user profiles for the application specified by the applicationName attribute in the configuration file. Use the authenticationOption parameter to specify whether you want only anonymous profiles, only authenticated profiles, or all profiles to be searched. Of the searched profiles, any profile with a LastActivityDate that occurs before the specified userInactiveSinceDate parameter value is returned.

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; 0 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 will contain the sixth through the tenth inactive profiles. The totalRecords parameter will be set to 13.

The following code example shows an ASP.NET page that manages inactive profiles. A button is provided to delete all inactive profiles. Whether a profile is considered inactive is based on the date specified for the userInactiveSinceDate parameter.

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

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, 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: