ProfileProvider.FindProfilesByUserName Método

Referência

Definição

Namespace:: System.Web.Profile

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Quando substituído em uma classe derivada, recupera informações de perfil para perfis em que o nome de usuário corresponde aos nomes de usuário especificados.

public:
 abstract System::Web::Profile::ProfileInfoCollection ^ FindProfilesByUserName(System::Web::Profile::ProfileAuthenticationOption authenticationOption, System::String ^ usernameToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);

public abstract System.Web.Profile.ProfileInfoCollection FindProfilesByUserName (System.Web.Profile.ProfileAuthenticationOption authenticationOption, string usernameToMatch, int pageIndex, int pageSize, out int totalRecords);

abstract member FindProfilesByUserName : System.Web.Profile.ProfileAuthenticationOption * string * int * int * int -> System.Web.Profile.ProfileInfoCollection

Public MustOverride Function FindProfilesByUserName (authenticationOption As ProfileAuthenticationOption, usernameToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As ProfileInfoCollection

Parâmetros

authenticationOption: ProfileAuthenticationOption

Um dos valores de ProfileAuthenticationOption, especificando se anônimo, autenticado ou ambos os tipos de perfis são retornados.

usernameToMatch: String

O nome de usuário a ser pesquisado.

pageIndex: Int32

O índice da página de resultados a serem retornados.

pageSize: Int32

O tamanho da página de resultados a ser retornada.

totalRecords: Int32

Quando este método retorna, contém o número total de perfis.

Retornos

ProfileInfoCollection

Um ProfileInfoCollection que contém informações de perfil de usuário para perfis em que o nome de usuário corresponde ao parâmetro usernameToMatch fornecido.

Exemplos

O exemplo de código a seguir mostra a assinatura do método para uma implementação do FindProfilesByUserName método. Para obter um exemplo de implementação completa ProfileProvider , consulte Como criar e executar o exemplo do provedor de perfil.

public override ProfileInfoCollection FindProfilesByUserName(
    ProfileAuthenticationOption authenticationOption,
    string usernameToMatch,
    int pageIndex,
    int pageSize,
    out int totalRecords)
{
    totalRecords = 0;

    return new ProfileInfoCollection();
}

Public Overrides Function FindProfilesByUserName( _
ByVal authenticationOption As ProfileAuthenticationOption, _
ByVal usernameToMatch As String, _
ByVal pageIndex As Integer, _
ByVal pageSize As Integer, _
 ByRef totalRecords As Integer) As ProfileInfoCollection

  totalRecords = 0

  Return New ProfileInfoCollection()
End Function

Comentários

O FindProfilesByUserName método retorna uma lista de informações de perfil para perfis nos quais o nome de usuário corresponde ao parâmetro fornecido usernameToMatch . Somente os dados para os applicationName especificados no arquivo de configuração são retornados. O authenticationOption parâmetro especifica se somente perfis anônimos, apenas perfis autenticados ou todos os perfis são pesquisados.

Se a fonte de dados der suporte a recursos de pesquisa adicionais, como caracteres curinga, você poderá fornecer recursos de pesquisa mais abrangentes para nomes de usuário.

Os resultados retornados por FindProfilesByUserName são restritos pelo parâmetro e pageSize pelos pageIndex parâmetros. O pageSize parâmetro identifica o número máximo de ProfileInfo objetos a serem retornados no ProfileInfoCollection. O pageIndex parâmetro identifica qual página de resultados retornar, onde zero identifica a primeira página. O totalRecords parâmetro é um out parâmetro definido como o número total de perfis de usuário inativos para o configuradoapplicationName, com base no parâmetro e userInactiveSinceDate no authenticationOption parâmetro. Por exemplo, se houver 13 usuários para o configurado applicationNamee o pageIndex valor for 1 com um pageSize de 5, o ProfileInfoCollection retornado conterá o sexto até o décimo perfis inativos retornados. O totalRecords parâmetro seria definido como 13.

Aplica-se a