SqlPersonalizationProvider.FindState Méthode

Définition

Espace de noms:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Retourne une collection qui contient un nombre nul ou supérieur d'objets dérivés de PersonalizationStateInfo, selon la portée et les paramètres spécifiés.

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

Paramètres

scope

PersonalizationScope

PersonalizationScope indiquant les informations de personnalisation à rechercher. Cette valeur ne peut pas être null.

query

PersonalizationStateQuery

PersonalizationStateQuery contenant une requête. Cette valeur peut être null.

pageIndex

Int32

Emplacement où commence la requête.

pageSize

Int32

Nombre d'enregistrements à retourner.

totalRecords

Int32

Nombre total d'enregistrements disponibles.

Retours

PersonalizationStateInfoCollection

PersonalizationStateInfoCollection qui contient un nombre d'objets dérivés de PersonalizationStateInfo supérieur ou égal à zéro.

Exceptions

ArgumentException

pageIndex est inférieur à zéro.

- ou -

pageSize est inférieur ou égal à zéro.

-ou-

La combinaison de pageIndex et pageSize entraîne une valeur supérieure à Int32.MaxValue.

- ou -

PathToMatch est non null et constitue une chaîne vide ("  ") après troncation.

- ou -

La longueur de PathToMatch est supérieure à 256 caractères quand la valeur n'est pas null.

- ou -

UsernameToMatch est non null et constitue une chaîne vide après troncation.

- ou -

La longueur de UsernameToMatch est supérieure à 256 caractères quand la valeur n'est pas null.

ArgumentOutOfRangeException

Le scope spécifié n'est pas une valeur valide issue de l'énumération PersonalizationScope.

Remarques

L’ensemble d’éléments retournés est limité par les pageSize paramètres et pageIndex , où pageSize contrôle le nombre d’enregistrements à retourner et pageIndex les enregistrements à retourner. Par exemple, un pageIndex de 0 et un pageSize de 25 retourneraient les 25 premières occurrences, tandis que un pageIndex de 1 et un pageSize de 25 retourneraient les occurrences 26 à 50. Si vous souhaitez récupérer tous les enregistrements disponibles, définissez pageIndex sur 0 et pageSizeMaxValuesur .

Les PersonalizationStateInfoobjets dérivés sont retournés dans l’ordre alphabétique triés par Path et Username, tous deux dans l’ordre croissant.

Cette méthode transmet des caractères génériques de requête au magasin de données sous-jacent. La prise en charge des caractères génériques dépend actuellement de la façon dont chaque fournisseur gère des caractères tels qu’un astérisque (*), un symbole de pourcentage (%) ou un trait de soulignement (_).

Normalement, pour les magasins de données compatibles SQL, vous pouvez effectuer une recherche générique sur un chemin d’accès partiel avec le caractère générique qui apparaît au début, à la fin ou au milieu du texte de la chaîne de recherche dans la PathToMatch propriété. Par exemple, pour rechercher tous les chemins qui commencent par « ~/approot », la PathToMatch propriété est définie sur « ~/approot% ».

De même, une recherche générique sur un nom d’utilisateur partiel peut faire apparaître le caractère générique à n’importe quel point de la chaîne de texte de la UsernameToMatch propriété. Par exemple, pour rechercher tous les noms d’utilisateur qui commencent par « John », le UsernameToMatch paramètre ressemblerait à « John% ».

Les contraintes de requête suivantes s’appliquent :

• Si uniquement scope est fourni et query est null ou toutes les propriétés sur query les valeurs retournées null ou par défaut, tous les enregistrements correspondant au paramètre indiqué scope sont retournés.

• Si la PathToMatch propriété n’est pas null, les enregistrements retournés sont également filtrés en fonction des chemins qui correspondent à la valeur de la PathToMatch propriété.

• Si la UsernameToMatch propriété n’est pas null, les enregistrements retournés sont également filtrés en fonction des noms d’utilisateur qui correspondent à la valeur de la UsernameToMatch propriété.

• Si la UserInactiveSinceDate propriété n’est pas égale à MaxValue, les enregistrements retournés sont également filtrés pour renvoyer uniquement les enregistrements associés aux utilisateurs inactifs. La comparaison inclut les enregistrements où la LastActivityDate propriété est inférieure ou égale à la UserInactiveSinceDate propriété .

Notez que cette méthode ne valide pas les combinaisons de paramètres de requête. Par exemple, le code peut demander un ensemble d’enregistrements d’état de personnalisation associés à un nom d’utilisateur spécifique dans l’étendue partagée. Étant donné que les noms d’utilisateur ne sont pas associés aux informations partagées, la collection retournée est vide.

Les combinaisons de paramètres qui ont le potentiel de retourner une collection non vide sont les suivantes :

• Shared étendue en combinaison avec PathToMatch.

• User étendue en combinaison avec les valeurs de l’une ou de l’ensemble PathToMatchdes propriétés , UsernameToMatchet UserInactiveSinceDate .