Partager via


ActiveDirectoryMembershipProvider.FindUsersByName Méthode

Définition

Retourne une collection d'utilisateurs du magasin de données Active Directory en fonction du nom d'utilisateur.

public:
 override System::Web::Security::MembershipUserCollection ^ FindUsersByName(System::String ^ usernameToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);
public override System.Web.Security.MembershipUserCollection FindUsersByName (string usernameToMatch, int pageIndex, int pageSize, out int totalRecords);
override this.FindUsersByName : string * int * int * int -> System.Web.Security.MembershipUserCollection
Public Overrides Function FindUsersByName (usernameToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As MembershipUserCollection

Paramètres

usernameToMatch
String

Nom d'utilisateur ou partie d'un nom d'utilisateur à rechercher.

pageIndex
Int32

Index de la page de résultats à retourner. pageIndex est de base zéro.

pageSize
Int32

Taille de la page de résultats à retourner.

totalRecords
Int32

Cette méthode retourne le nombre total d'enregistrements retourné dans la collection. Ce paramètre est passé sans être initialisé.

Retours

MembershipUserCollection qui contient des instances de pageSizeMembershipUser commençant à la page spécifiée par pageIndex.

Exceptions

La méthode FindUsersByName(String, Int32, Int32, Int32) est appelée avant l'initialisation de l'instance de ActiveDirectoryMembershipProvider.

usernameToMatch est vide ou dépasse la longueur maximale autorisée pour le nom d'utilisateur (généralement 256 caractères).

- ou -

usernameToMatch contient des virgules.

- ou -

pageIndex est inférieur à 0.

- ou -

pageSize est inférieur à 1.

- ou -

pageSize multiplié par pageIndex, plus pageSize, moins 1 est supérieur à Int32.MaxValue.

usernameToMatch a la valeur null.

La propriété EnableSearchMethods a la valeur false.

Remarques

La FindUsersByName méthode retourne une MembershipUserCollection instance contenant les enregistrements utilisateur du magasin de données Active Directory pour tous les noms d’utilisateur qui correspondent aux userNameToMatch paramètres. Les enregistrements sont retournés triés par ordre alphabétique par nom d’utilisateur.

Les résultats retournés par la FindUsersByName méthode sont limités par les pageIndex paramètres et pageSize . Le pageSize paramètre spécifie le nombre maximal d’instances MembershipUser à retourner dans le MembershipUserCollection. Le pageIndex paramètre spécifie la page de résultats à retourner, où 0 (zéro) indique la première page.

Le totalRecords paramètre est un out paramètre défini sur le nombre total d’utilisateurs d’appartenance correspondants trouvés dans le magasin de données Active Directory. Par exemple, s’il y a 13 utilisateurs pour le magasin de données configuré et que la pageIndex valeur est 1 avec un pageSize de 5, le MembershipUserCollection retourné contient le sixième au dixième utilisateurs. Le totalRecords paramètre est défini sur 13.

Vous pouvez contrôler s’il faut autoriser la recherche d’utilisateurs en définissant la EnableSearchMethods propriété dans le fichier de configuration de l’application à l’aide de l’attribut enableSearchMethods de l’élément membership Element (ASP.NET Settings Schema). Si vous définissez la valeur de la EnableSearchMethods propriété sur false , la FindUsersByName méthode lève une NotSupportedException exception.

Le fournisseur utilise une recherche de sous-arborescence commençant au point de recherche spécifié dans la chaîne de connexion. Consultez la rubrique de ActiveDirectoryMembershipProvider classe pour plus d’informations sur les chaînes de connexion.

Nous vous recommandons de ne pas activer la recherche sur les systèmes de production tant que vous n’avez pas confirmé que les requêtes de recherche émises par la ActiveDirectoryMembershipProvider classe n’ont pas d’impact négatif sur les performances de votre serveur d’annuaire. Étant donné que la ActiveDirectoryMembershipProvider classe est conçue pour un environnement Web sans état, elle ne peut pas utiliser les optimisations de pagination exposées par les API sous-jacentes System.DirectoryServices . Cela signifie que les opérations de pagination pendant les recherches sur des répertoires volumineux sont très coûteuses et doivent être évitées. Les opérations de recherche sont toujours émises sur le serveur d’annuaire configuré dans la chaîne de connexion, ou sur un serveur sélectionné automatiquement dans le cas d’une chaîne de connexion pointant vers un domaine. Le fournisseur n’utilise pas de catalogue global pour ses méthodes de recherche.

S’applique à

Voir aussi