MembershipProvider.FindUsersByName(String, Int32, Int32, Int32) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает коллекцию пользователей членства, у которых часть имени совпадает с указанным значением.
public:
abstract System::Web::Security::MembershipUserCollection ^ FindUsersByName(System::String ^ usernameToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);
public abstract System.Web.Security.MembershipUserCollection FindUsersByName (string usernameToMatch, int pageIndex, int pageSize, out int totalRecords);
abstract member FindUsersByName : string * int * int * int -> System.Web.Security.MembershipUserCollection
Public MustOverride Function FindUsersByName (usernameToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As MembershipUserCollection
Параметры
- usernameToMatch
- String
Имя пользователя для поиска.
- pageIndex
- Int32
Индекс страницы возвращаемых результатов. Индекс pageIndex
отсчитывается от нуля.
- pageSize
- Int32
Размер возвращаемой страницы результатов.
- totalRecords
- Int32
Общее число соответствующих пользователей.
Возвращаемое значение
Коллекция MembershipUserCollection, которая содержит страницу объектов pageSize
MembershipUser, начиная со страницы, указанной параметром pageIndex
.
Примеры
Пример реализации см. в MembershipProvider разделе Реализация поставщика профилей.
Комментарии
FindUsersByName возвращает список пользователей членства, имя которого совпадает с usernameToMatch
указанным для настроенного ApplicationName свойства. Если источник данных поддерживает дополнительные возможности поиска, такие как подстановочные знаки, можно предоставить более широкие возможности поиска по именам пользователей.
Результаты, возвращаемые параметром , FindUsersByName ограничены параметрами pageIndex
и pageSize
. Параметр pageSize
определяет количество объектов, возвращаемых MembershipUser в MembershipUserCollection коллекции. Параметр pageIndex
определяет, какую страницу результатов следует вернуть, где 0 определяет первую страницу. Параметр totalRecords
является параметром out
, который имеет общее число пользователей членства, соответствующих значению usernameToMatch
. Например, если было найдено 13 пользователей, где usernameToMatch
совпадает часть или полное имя пользователя, и pageIndex
значение равно 1 с pageSize
5, то MembershipUserCollection будет содержать от шестого по десятый возвращенные пользователи.
totalRecords
будет задано значение 13.