SqlPersonalizationProvider.FindState Metoda

Definicja

Przestrzeń nazw:

System.Web.UI.WebControls.WebParts

Zestaw:

System.Web.dll

Zwraca kolekcję zawierającą zero lub więcej PersonalizationStateInfoobiektów pochodnych na podstawie określonego zakresu i parametrów.

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

Parametry

scope

PersonalizationScope

Element PersonalizationScope wskazujący informacje o personalizacji do odpytowania. Ta wartość nie może być wartością null.

query

PersonalizationStateQuery

Element PersonalizationStateQuery zawierający zapytanie. Ta wartość może mieć wartość null.

pageIndex

Int32

Lokalizacja, w której uruchamia się zapytanie.

pageSize

Int32

Liczba rekordów do zwrócenia.

totalRecords

Int32

Całkowita liczba dostępnych rekordów.

Zwraca

PersonalizationStateInfoCollection

Obiekt PersonalizationStateInfoCollection zawierający zero lub więcej PersonalizationStateInfoobiektów pochodnych.

Wyjątki

ArgumentException

Parametr pageIndex ma wartość niższą niż zero.

-lub-

pageSize jest mniejsze niż lub równe zero.

-lub-

Kombinacja parametrów pageIndex i pageSize powoduje, że wartość jest większa niż Int32.MaxValue.

-lub-

PathToMatch jest inny niżnull i jest pustym ciągiem ("") po przycinaniu.

-lub-

PathToMatch Długość wartości jest większa niż 256 znaków, gdy wartość nie jestnull.

-lub-

UsernameToMatch jest inny niżnull i jest pustym ciągiem po przycinaniu.

-lub-

UsernameToMatch Długość wartości jest większa niż 256 znaków, gdy wartość nie jestnull.

ArgumentOutOfRangeException

Określona scope wartość nie jest prawidłową wartością PersonalizationScope z wyliczenia.

Uwagi

Zestaw zwracanych elementów jest ograniczony przez pageSize parametry i pageIndex , gdzie pageSize kontroluje liczbę rekordów do zwrócenia i pageIndex kontroluje, które rekordy mają być zwracane. Na przykład wartość pageIndex 0 i pageSize z 25 zwróci pierwsze 25 wystąpień, a wartość pageIndex 1 i pageSize 25 zwróci wystąpienia 26–50. Jeśli chcesz pobrać wszystkie dostępne rekordy, ustaw wartość pageIndex 0 i pageSize na .MaxValue

PersonalizationStateInfoObiekty pochodne są zwracane w kolejności alfabetycznej posortowane według Path i Username, zarówno w kolejności rosnącej.

Ta metoda przekazuje symbole wieloznaczne zapytania do bazowego magazynu danych. Obsługa symboli wieloznacznych jest obecnie zależna od sposobu obsługi znaków przez każdego dostawcę, takich jak gwiazdka (*), symbol procentu (%), lub podkreślenie (_).

Zwykle w przypadku magazynów danych zgodnych z językiem SQL można wykonać wyszukiwanie symboli wieloznacznych na częściowej ścieżce z symbolem wieloznacznymi wyświetlanym na początku, na końcu lub w środku tekstu ciągu wyszukiwania we PathToMatch właściwości . Aby na przykład znaleźć wszystkie ścieżki rozpoczynające się od "~/approot", PathToMatch właściwość zostanie ustawiona na "~/approot%".

Podobnie wyszukiwanie symboli wieloznacznych w częściowej nazwie użytkownika może mieć symbol wieloznaczny wyświetlany w dowolnym momencie w ciągu tekstowym UsernameToMatch właściwości. Aby na przykład znaleźć wszystkie nazwy użytkowników rozpoczynające się od "John", UsernameToMatch parametr będzie wyglądać następująco: "John%".

Obowiązują następujące ograniczenia zapytania:

• Jeśli podano tylko scope wartości i query jest null lub wszystkie właściwości zwracane querynull albo wartości domyślne, zwracane są wszystkie rekordy pasujące do wskazanego scope parametru.

• PathToMatch Jeśli właściwość nie nulljest , zwracane rekordy są również filtrowane na podstawie ścieżek, które pasują do PathToMatch wartości właściwości.

• UsernameToMatch Jeśli właściwość nie nulljest , zwracane rekordy są również filtrowane na podstawie nazw użytkowników, które pasują do UsernameToMatch wartości właściwości.

• UserInactiveSinceDate Jeśli właściwość nie jest równa MaxValuewartości , zwracane rekordy są również filtrowane w celu zwrócenia tylko tych rekordów skojarzonych z nieaktywnymi użytkownikami. Porównanie obejmuje rekordy, w których LastActivityDate właściwość jest mniejsza lub równa UserInactiveSinceDate właściwości.

Należy pamiętać, że ta metoda nie weryfikuje kombinacji parametrów zapytania. Na przykład kod może zażądać zestawu rekordów stanu personalizacji skojarzonych z określoną nazwą użytkownika w zakresie udostępnionym. Ponieważ nazwy użytkowników nie są skojarzone z informacjami udostępnionymi, zwracana kolekcja będzie pusta.

Kombinacje parametrów, które mają potencjał do zwrócenia kolekcji niepustej, obejmują:

• Shared zakres w połączeniu z PathToMatch.

• User zakres w połączeniu z wartościami dla dowolnych PathToMatchlub wszystkich właściwości , UsernameToMatchi UserInactiveSinceDate .