Export (0) Print
Expand All

ProfileProvider.GetAllInactiveProfiles Method

When overridden in a derived class, retrieves user-profile data from the data source for profiles in which the last activity date occurred on or before the specified date.

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

public abstract ProfileInfoCollection GetAllInactiveProfiles (
	ProfileAuthenticationOption authenticationOption,
	DateTime userInactiveSinceDate,
	int pageIndex,
	int pageSize,
	out int totalRecords
)
public abstract 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.

pageSize

The size of the page of results to return.

totalRecords

When this method returns, contains the total number of profiles.

Return Value

A ProfileInfoCollection containing user-profile information about the inactive profiles.

The GetAllInactiveProfiles method is used to retrieve profile information for unused user 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. Of the searched profiles, any profile with a LastActivityDate that occurs on or 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, 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 GetAllInactiveProfiles method. For an example of a full ProfileProvider implementation, see Sample Profile Provider Implementation.

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

	return new ProfileInfoCollection();
}

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:
© 2015 Microsoft