ProfileProvider.FindProfilesByUserName Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
When overridden in a derived class, retrieves profile information for profiles in which the user name matches the specified user names.
public:
abstract System::Web::Profile::ProfileInfoCollection ^ FindProfilesByUserName(System::Web::Profile::ProfileAuthenticationOption authenticationOption, System::String ^ usernameToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);
public abstract System.Web.Profile.ProfileInfoCollection FindProfilesByUserName (System.Web.Profile.ProfileAuthenticationOption authenticationOption, string usernameToMatch, int pageIndex, int pageSize, out int totalRecords);
abstract member FindProfilesByUserName : System.Web.Profile.ProfileAuthenticationOption * string * int * int * int -> System.Web.Profile.ProfileInfoCollection
Public MustOverride Function FindProfilesByUserName (authenticationOption As ProfileAuthenticationOption, usernameToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As ProfileInfoCollection
Parameters
- authenticationOption
- ProfileAuthenticationOption
One of the ProfileAuthenticationOption values, specifying whether anonymous, authenticated, or both types of profiles are returned.
- usernameToMatch
- String
The user name to search for.
- pageIndex
- Int32
The index of the page of results to return.
- pageSize
- Int32
The size of the page of results to return.
- totalRecords
- Int32
When this method returns, contains the total number of profiles.
Returns
A ProfileInfoCollection containing user-profile information for profiles where the user name matches the supplied usernameToMatch
parameter.
Examples
The following code example shows the method signature for an implementation of the FindProfilesByUserName method. For an example of a full ProfileProvider implementation, see How to: Build and Run the Profile Provider Example.
public override ProfileInfoCollection FindProfilesByUserName(
ProfileAuthenticationOption authenticationOption,
string usernameToMatch,
int pageIndex,
int pageSize,
out int totalRecords)
{
totalRecords = 0;
return new ProfileInfoCollection();
}
Public Overrides Function FindProfilesByUserName( _
ByVal authenticationOption As ProfileAuthenticationOption, _
ByVal usernameToMatch As String, _
ByVal pageIndex As Integer, _
ByVal pageSize As Integer, _
ByRef totalRecords As Integer) As ProfileInfoCollection
totalRecords = 0
Return New ProfileInfoCollection()
End Function
Remarks
The FindProfilesByUserName method returns a list of profile information for profiles in which the user name matches the supplied usernameToMatch
parameter. 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.
If your data source supports additional search capabilities, such as wildcard characters, you can provide more extensive search capabilities for user names.
The results returned by FindProfilesByUserName 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.
Applies to
See also
Atsauksmes
https://aka.ms/ContentUserFeedback.
Drīzumā: 2024. gada laikā mēs pakāpeniski pārtrauksim izmantot “GitHub problēmas” kā atsauksmju par saturu mehānismu un aizstāsim to ar jaunu atsauksmju sistēmu. Papildinformāciju skatiet:Iesniegt un skatīt atsauksmes par