ActiveDirectoryMembershipProvider.FindUsersByName Método

Definição

Devolve uma coleção de utilizadores do armazenamento de dados do Active Directory com base no nome de utilizador.

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

Parâmetros

usernameToMatch
String

O nome de utilizador ou parte de um nome de utilizador a procurar.

pageIndex
Int32

O índice da página de resultados para devolver. pageIndex é baseado em zero.

pageSize
Int32

O tamanho da página de resultados para devolver.

totalRecords
Int32

Quando este método retorna, contém o número total de registos devolvidos na coleção. Este parâmetro é passado sem inicializar.

Devoluções

A MembershipUserCollection contendo pageSizeMembershipUser instâncias que começam na página especificada por pageIndex.

Exceções

usernameToMatch está vazio ou excede o comprimento máximo do nome de utilizador (normalmente 256 caracteres).

-ou-

usernameToMatch contém vírgulas.

-ou-

pageIndex é inferior a 0.

-ou

pageSize é inferior a 1.

-ou-

pageSize multiplicado por pageIndex, mais pageSize, menos 1 é maior que Int32.MaxValue.

usernameToMatch é null.

A propriedade EnableSearchMethods é false.

Observações

O método FindUsersByName devolve uma instância MembershipUserCollection contendo os registos de utilizador da Active Directory data store para todos os nomes de utilizador que correspondem aos parâmetros userNameToMatch. Os registos são devolvidos ordenados alfabeticamente por nome de utilizador.

Os resultados devolvidos pelo FindUsersByName método são limitados pelos pageIndex parâmetros e pageSize . O pageSize parâmetro especifica o número máximo de MembershipUser instâncias a devolver no MembershipUserCollection. O pageIndex parâmetro especifica qual página de resultados devolver, onde 0 (zero) indica a primeira página.

O parâmetro totalRecords é um parâmetro out definido para o número total de utilizadores correspondentes encontrados no armazenamento de dados Active Directory. Por exemplo, se houver 13 utilizadores para o armazenamento de dados configurado, e o pageIndex valor for 1 com a pageSize de 5, os MembershipUserCollection devolvidos conterão do sexto ao décimo utilizador. O totalRecords parâmetro seria definido para 13.

Pode controlar se permite a pesquisa de utilizadores, definindo a propriedade EnableSearchMethods no ficheiro de configuração da aplicação usando o atributo enableSearchMethods do elemento membership (ASP.NET Settings Schema). Definir o EnableSearchMethods valor da propriedade para false faz com que o FindUsersByName método lance uma NotSupportedException exceção.

O fornecedor utiliza uma pesquisa em subárvore que começa no ponto de pesquisa especificado na cadeia de ligação. Consulte o ActiveDirectoryMembershipProvider tópico da aula para mais informações sobre cordas de ligação.

Recomendamos que não ative a pesquisa em sistemas de produção até confirmar que as consultas de pesquisa emitidas pela ActiveDirectoryMembershipProvider classe não afetam negativamente o desempenho do seu servidor de diretórios. Como a ActiveDirectoryMembershipProvider classe foi concebida para um ambiente Web sem estado, não consegue utilizar as otimizações de paginação expostas pelas APIs subjacentes System.DirectoryServices . Isto significa que as operações de paginação durante pesquisas em grandes diretórios são muito dispendiosas e devem ser evitadas. As operações de pesquisa são sempre emitidas contra o servidor de diretório configurado na cadeia de ligação, ou contra um servidor selecionado automaticamente no caso de uma cadeia de ligação apontar para um domínio. O fornecedor não utiliza um catálogo global para os seus métodos de pesquisa.

Aplica-se a

Ver também