Partager via

SqlPersonalizationProvider.FindState Méthode

Définition

Espace de noms:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Retourne une collection contenant zéro ou plusieurs PersonalizationStateInfoobjets dérivés, en fonction de l’étendue et des 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

Indiquant PersonalizationScope les informations de personnalisation à interroger. Cette valeur ne peut pas être null.

query
PersonalizationStateQuery

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

pageIndex
Int32

Emplacement où la requête démarre.

pageSize
Int32

Nombre d’enregistrements à retourner.

totalRecords
Int32

Nombre total d’enregistrements disponibles.

Retours

PersonalizationStateInfoCollection

Objet PersonalizationStateInfoCollection contenant zéro ou plusieurs PersonalizationStateInfoobjets dérivés.

Exceptions

ArgumentException

pageIndex est inférieur à zéro.

- ou -

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

- ou -

La combinaison des pageIndex valeurs et pageSize des résultats est supérieure à Int32.MaxValue.

- ou -

PathToMatch n’est pas-null et est une chaîne vide («  ») après la suppression.

- ou -

La longueur est PathToMatch supérieure à 256 caractères lorsque la valeur n’est pas-null.

- ou -

UsernameToMatch n’est pas-null et est une chaîne vide après la suppression.

- ou -

La longueur est UsernameToMatch supérieure à 256 caractères lorsque la valeur n’est pas-null.

ArgumentOutOfRangeException

La scope valeur spécifiée n’est pas valide de l’énumération PersonalizationScope .

Remarques

L’ensemble d’éléments retournés est limité par les paramètres et pageIndexpageSize le pageSize nombre d’enregistrements à renvoyer et pageIndex contrôle les enregistrements à retourner. Par exemple, une pageIndex valeur de 0 et une pageSize valeur de 25 retournent les 25 premières occurrences, tandis qu’un pageIndex de 1 et un pageSize de 25 retournent des occurrences de 26 à 50. Si vous souhaitez récupérer tous les enregistrements disponibles, définissez la valeur pageIndex 0 et pageSize la valeur MaxValue.

Les PersonalizationStateInfoobjets dérivés sont retournés dans l’ordre alphabétique trié par Path et Username, 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 les caractères tels qu’un astérisque (*), un symbole de pourcentage (%) ou un trait de soulignement (_).

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

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

Les contraintes de requête suivantes s’appliquent :

  • S’il est fourni uniquement scope et query s’il s’agit null ou de toutes les propriétés de query retour ou null de valeurs 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 des 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 à des 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 :

S’applique à