ProfileProvider.FindProfilesByUserName Methode

Definition

Ruft beim Überschreiben in einer abgeleiteten Klasse Profilinformationen für Profile ab, bei denen der Benutzername den angegebenen Benutzernamen entspricht.

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

Parameter

authenticationOption
ProfileAuthenticationOption

Einer der ProfileAuthenticationOption-Werte, der angibt, ob anonyme Profile, authentifizierte Profile oder beide Profilarten zurückgegeben werden.

usernameToMatch
String

Der zu suchende Benutzername.

pageIndex
Int32

Der Index der zurückzugebenden Ergebnisseite.

pageSize
Int32

Die Größe der zurückzugebenden Ergebnisseite.

totalRecords
Int32

Diese Methode enthält bei der Rückgabe die Gesamtzahl von Profilen.

Gibt zurück

Eine ProfileInfoCollection, die Benutzerprofilinformationen für Profile enthält, in denen der Benutzername dem angegebenen usernameToMatch-Parameter entspricht.

Beispiele

Das folgende Codebeispiel zeigt die Methodensignatur für eine Implementierung der FindProfilesByUserName -Methode. Ein Beispiel für eine vollständige ProfileProvider Implementierung finden Sie unter Vorgehensweise: Erstellen und Ausführen des Profilanbieterbeispiels.

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

Hinweise

Die FindProfilesByUserName -Methode gibt eine Liste von Profilinformationen für Profile zurück, in denen der Benutzername mit dem angegebenen usernameToMatch Parameter übereinstimmt. Es werden nur Daten für die applicationName in der Konfigurationsdatei angegebene zurückgegeben. Der authenticationOption Parameter gibt an, ob nur anonyme Profile, nur authentifizierte Profile oder alle Profile durchsucht werden.

Wenn Ihre Datenquelle zusätzliche Suchfunktionen unterstützt, z. B. Wildcardzeichen, können Sie umfangreichere Suchfunktionen für Benutzernamen bereitstellen.

Die von FindProfilesByUserName zurückgegebenen Ergebnisse werden durch die pageIndex Parameter und pageSize eingeschränkt. Der pageSize Parameter identifiziert die maximale Anzahl von ProfileInfo Objekten, die in zurückgegeben werden ProfileInfoCollectionsollen. Der pageIndex Parameter gibt an, welche Ergebnisseite zurückgegeben werden soll, wobei null die erste Seite identifiziert. Der totalRecords Parameter ist ein out Parameter, der auf die Gesamtzahl der inaktiven Benutzerprofile für das konfigurierte applicationNamefestgelegt wird, basierend auf den authenticationOption Parametern und userInactiveSinceDate . Wenn es beispielsweise 13 Benutzer für das konfigurierte applicationNamegibt und der pageIndex Wert 1 mit einem pageSize von 5 ist, enthält das ProfileInfoCollection zurückgegebene sechste bis zehnte inaktive Profile, das zurückgegeben wird. Der totalRecords Parameter wird auf 13 festgelegt.

Gilt für:

Weitere Informationen