SqlPersonalizationProvider.FindState Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает коллекцию, содержащую ноль или несколько 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.
Объект, PersonalizationStateQuery содержащий запрос. Это значение может быть равно null.
- pageIndex
- Int32
Расположение, в котором запускается запрос.
- pageSize
- Int32
Количество возвращаемых записей.
- totalRecords
- Int32
Общее количество доступных записей.
Возвращаемое значение
Содержащий PersonalizationStateInfoCollection ноль или более PersonalizationStateInfoпроизводных объектов.
Исключения
pageIndex меньше нуля.
–или–
pageSize меньше нуля или равно нулю.
–или–
Сочетание и pageSize приводит к значению pageIndex больше, чем Int32.MaxValue.
–или–
PathToMatch не являетсяnull пустой строкой ("") после обрезки.
–или–
Длина PathToMatch больше 256 символов, если значение не равноnull.
–или–
UsernameToMatch не являетсяnull пустой строкой после обрезки.
–или–
Длина UsernameToMatch больше 256 символов, если значение не равноnull.
Указанный scope параметр не является допустимым значением PersonalizationScope из перечисления.
Комментарии
Набор возвращаемых элементов ограничивается pageSize параметрами и pageIndex параметрами, в которых pageSize определяется количество записей, возвращаемых и pageIndex управление возвращаемыми записями. Например, pageIndex 0 и pageSize 25 возвращают первые 25 вхождений, а pageIndex 1 и pageSize 25 возвращают вхождения 26-50. Если вы хотите получить все доступные записи, задайте pageIndex значение 0 и pageSize значение MaxValue.
Производные PersonalizationStateInfoобъекты возвращаются в алфавитном порядке, отсортированных PathUsernameпо возрастанию.
Этот метод передает подстановочные знаки запроса базовому хранилищу данных. Поддержка подстановочных знаков в настоящее время зависит от того, как каждый поставщик обрабатывает символы, такие как звездочка (*), символ процента (%) или символ подчеркивания (_).
Как правило, для хранилищ данных, совместимых с SQL, можно выполнить поиск подстановочных знаков по частичному пути с подстановочным знаком, отображаемым в начале, конце или середине текста строки поиска в свойстве PathToMatch . Например, чтобы найти все пути, начинающиеся с "~/approot", PathToMatch свойство будет иметь значение "~/approot%".
Аналогичным образом, поиск подстановочных знаков по частичному имени пользователя может содержать подстановочный знак в любой точке текстовой UsernameToMatch строки свойства. Например, чтобы найти все имена пользователей, начинающиеся с "John", UsernameToMatch параметр будет выглядеть следующим образом: "Джон%".
Применяются следующие ограничения запросов:
Если предоставляется только
scopeзначение иqueryявляетсяnullили все свойства приqueryвозвратеnullили значениях по умолчанию, возвращаются все записи, соответствующие указанномуscopeпараметру.PathToMatch Если свойство не
nullявляется, возвращаемые записи также фильтруются на основе путей, соответствующих значению PathToMatch свойства.UsernameToMatch Если свойство не
nullявляется, возвращаемые записи также фильтруются на основе имен пользователей, которые соответствуют значению UsernameToMatch свойства.UserInactiveSinceDate Если свойство не равноMaxValue, возвращаемые записи также фильтруются, чтобы вернуть только те записи, которые связаны с неактивными пользователями. Сравнение включает записи, в которых LastActivityDate свойство меньше или равно свойству UserInactiveSinceDate .
Обратите внимание, что этот метод не проверяет сочетания параметров запроса. Например, код может запрашивать набор записей состояния персонализации, связанных с определенным именем пользователя в общей области. Так как имена пользователей не связаны с общими сведениями, возвращаемая коллекция будет пуста.
К сочетаниям параметров, которые могут возвращать непустую коллекцию, относятся:
Shared область в сочетании с PathToMatch.
Userобласть в сочетании со значениями для любого или всех PathToMatchUsernameToMatchсвойств и UserInactiveSinceDate свойств.