ProfileProvider.FindProfilesByUserName Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
После переопределения в производном классе возвращает данные профилей, имена пользователей в которых соответствуют указанным именам пользователей.
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
Параметры
- authenticationOption
- ProfileAuthenticationOption
Одно из значений ProfileAuthenticationOption, с помощью которого можно задать возвращаемые типы профилей: анонимный, с проверкой подлинности или оба.
- usernameToMatch
- String
Имя пользователя для поиска.
- pageIndex
- Int32
Индекс страницы возвращаемых результатов.
- pageSize
- Int32
Размер возвращаемой страницы результатов.
- totalRecords
- Int32
Когда метод возвращает управление, содержит общее число профилей.
Возвращаемое значение
Коллекция ProfileInfoCollection, содержащая данные профилей, имена пользователей в которых соответствуют предоставленному параметру usernameToMatch
.
Примеры
В следующем примере кода показана сигнатура метода для реализации FindProfilesByUserName метода. Пример полной ProfileProvider реализации см. в разделе "Практическое руководство. Сборка и запуск примера поставщика профилей".
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
Комментарии
Метод FindProfilesByUserName возвращает список сведений о профиле для профилей, в которых имя пользователя соответствует указанному usernameToMatch
параметру. Возвращаются только данные для указанного applicationName
в файле конфигурации. Параметр authenticationOption
указывает, выполняются ли поиск только анонимные профили, только профили, прошедшие проверку подлинности, или все профили.
Если источник данных поддерживает дополнительные возможности поиска, такие как подстановочные знаки, можно предоставить более широкие возможности поиска для имен пользователей.
Возвращаемые FindProfilesByUserName результаты ограничены pageIndex
параметрами и pageSize
параметрами. Параметр pageSize
определяет максимальное количество ProfileInfo объектов, возвращаемых в .ProfileInfoCollection Параметр pageIndex
определяет, какая страница результатов возвращается, где нуль идентифицирует первую страницу. Параметр totalRecords
— это out
параметр, который имеет общее количество неактивных профилей пользователей для настроенных applicationName
на основе authenticationOption
параметров и userInactiveSinceDate
параметров. Например, если настроено applicationName
13 пользователей и pageIndex
значение равно 1 с pageSize
5, ProfileInfoCollection возвращенное значение будет содержать шестое по десятый неактивные профили. Параметру totalRecords
будет присвоено значение 13.