SqlPersonalizationProvider.FindState Метод

Определение

Пространство имен:

System.Web.UI.WebControls.WebParts

Сборка:

System.Web.dll

Возвращает коллекцию, в которой содержится ноль или несколько объектов, созданных на основе PersonalizationStateInfo с учетом указанных области и параметров.

public:
 override System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindState(System::Web::UI::WebControls::WebParts::PersonalizationScope scope, System::Web::UI::WebControls::WebParts::PersonalizationStateQuery ^ query, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);

public override System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindState (System.Web.UI.WebControls.WebParts.PersonalizationScope scope, System.Web.UI.WebControls.WebParts.PersonalizationStateQuery query, int pageIndex, int pageSize, out int totalRecords);

override this.FindState : System.Web.UI.WebControls.WebParts.PersonalizationScope * System.Web.UI.WebControls.WebParts.PersonalizationStateQuery * int * int * int -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection

Public Overrides Function FindState (scope As PersonalizationScope, query As PersonalizationStateQuery, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As PersonalizationStateInfoCollection

Параметры

scope

PersonalizationScope

Область PersonalizationScope, указывающая, какие сведения о личных настройках необходимо запросить. Это значение не может быть равно null.

query

PersonalizationStateQuery

Объект PersonalizationStateQuery, содержащий запрос. Это значение может быть равно null.

pageIndex

Int32

Место, где начинается выполнение запроса.

pageSize

Int32

Число возвращаемых записей.

totalRecords

Int32

Общее число доступных записей.

Возвращаемое значение

PersonalizationStateInfoCollection

Объект PersonalizationStateInfoCollection, содержащий объекты, производные от PersonalizationStateInfo.

Исключения

ArgumentException

Значение параметра pageIndex меньше нуля.

-или-

pageSize меньше или равно нулю.

-или-

Сочетание pageIndex и pageSize приводит к тому, что значение больше Int32.MaxValue.

-или-

Значение параметра PathToMatch не равно null и является пустой строкой ("") после усечения.

-или-

Длина параметра PathToMatch превышает 256 символов, в то время как значение не равно null.

-или-

Значение параметра UsernameToMatch не равно null и является пустой строкой после усечения.

-или-

Длина параметра UsernameToMatch превышает 256 символов, в то время как значение не равно null.

ArgumentOutOfRangeException

Указанное значение scope не является допустимым значением перечисления PersonalizationScope.

Комментарии

Набор возвращаемых элементов ограничивается параметрами pageSize и pageIndex , где pageSize управляет количеством возвращаемых записей и pageIndex определяет, какие записи нужно вернуть. Например, pageIndex значения 0 и pageSize 25 возвращают первые 25 вхождений, а pageIndex 1 и pageSize 25 — 26–50. Если вы хотите получить все доступные записи, задайте значение pageIndex 0, а pageSize — значение MaxValue.

Производные PersonalizationStateInfoот объектов возвращаются в алфавитном порядке с сортировкой по Path и Usernameв порядке возрастания.

Этот метод передает подстановочные знаки запроса в базовое хранилище данных. Поддержка подстановочных знаков в настоящее время зависит от того, как каждый поставщик обрабатывает такие символы, как звездочка (*), символ процента (%) или символ подчеркивания (_).

Обычно для хранилищ данных, совместимых с SQL, можно выполнить поиск с подстановочными знаками по частичному пути с подстановочным знаком, отображаемым в начале, конце или середине текста строки поиска в свойстве PathToMatch . Например, чтобы найти все пути, начинающиеся с "~/approot", свойству PathToMatch будет присвоено значение "~/approot%".

Аналогичным образом, при поиске с подстановочными знаками по частичному имени пользователя подстановочный знак может отображаться в любой точке текстовой UsernameToMatch строки свойства. Например, чтобы найти все имена пользователей, начинающиеся с "John", UsernameToMatch параметр будет выглядеть как "John%".

Применяются следующие ограничения запросов:

• Если указан только scope параметр и query имеет значение или все null свойства, query возвращаемые null значениями или по умолчанию, возвращаются все записи, соответствующие указанному scope параметру.

• PathToMatch Если свойство не nullравно , возвращаемые записи также фильтруются по путям, соответствующим значению PathToMatch свойства.

• UsernameToMatch Если свойство не nullравно , возвращаемые записи также фильтруются по именам пользователей, которые соответствуют значению UsernameToMatch свойства.

• UserInactiveSinceDate Если свойство не равно MaxValue, то возвращаемые записи также фильтруются для возврата только тех записей, которые связаны с неактивными пользователями. Сравнение включает записи, в которых LastActivityDate свойство меньше или равно свойству UserInactiveSinceDate .

Обратите внимание, что этот метод не проверяет сочетания параметров запроса. Например, код может запросить набор записей состояния персонализации, связанных с определенным именем пользователя в общем область. Так как имена пользователей не связаны с общими сведениями, возвращаемая коллекция будет пустой.

К сочетаниям параметров, которые могут возвращать непустую коллекцию, относятся:

• Sharedобласть в сочетании с PathToMatch.

• Userобласть в сочетании со значениями для любого или всех PathToMatchсвойств , UsernameToMatchи UserInactiveSinceDate .