SqlPersonalizationProvider.FindState Método

Definição

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Retorna uma coleção que contém zero ou mais objetos derivados de PersonalizationStateInfo, de acordo com os parâmetros e o escopo especificados.

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

Parâmetros

scope

PersonalizationScope

Um PersonalizationScope que indica quais são as informações de personalização a serem consultadas. Esse valor não pode ser null.

query

PersonalizationStateQuery

Uma PersonalizationStateQuery que contém uma consulta. Este valor pode ser null.

pageIndex

Int32

O local em que a consulta é iniciada.

pageSize

Int32

O número de registros a serem retornados.

totalRecords

Int32

O número total de registros disponíveis.

Retornos

PersonalizationStateInfoCollection

Uma PersonalizationStateInfoCollection que contém zero ou mais objetos derivados de PersonalizationStateInfo.

Exceções

ArgumentException

pageIndex é menor que zero.

- ou -

pageSize é menor que ou igual a zero.

- ou -

A combinação de pageIndex e pageSize resulta em um valor maior que Int32.MaxValue.

- ou -

PathToMatch não é null e é uma cadeia de caracteres vazia ("") após a filtragem.

- ou -

O tamanho de PathToMatch é maior que 256 caracteres quando o valor não é null.

- ou -

UsernameToMatch não é null e é uma cadeia de caracteres vazia após a filtragem.

- ou -

O tamanho de UsernameToMatch é maior que 256 caracteres quando o valor não é null.

ArgumentOutOfRangeException

O scope especificado não é um valor válido da enumeração PersonalizationScope.

Comentários

O conjunto de itens retornados é restrito pelos pageSize parâmetros e pageIndex , em pageSize que controla o número de registros a serem retornados e pageIndex controla quais registros retornar. Por exemplo, um pageIndex de 0 e um pageSize de 25 retornaria as primeiras 25 ocorrências, enquanto um pageIndex de 1 e um pageSize de 25 retornariam ocorrências 26-50. Se você quiser buscar todos os registros disponíveis, defina pageIndex como 0 e pageSize como MaxValue.

Os PersonalizationStateInfoobjetos derivados de são retornados em ordem alfabética classificada por Path e Username, ambos em ordem crescente.

Esse método passa caracteres curinga de consulta para o armazenamento de dados subjacente. Atualmente, o suporte para caracteres curinga depende de como cada provedor manipula caracteres como um asterisco (*), um símbolo de porcentagem (%) ou um sublinhado (_).

Normalmente, para armazenamentos de dados em conformidade com SQL, você pode executar uma pesquisa curinga em um caminho parcial com o caractere curinga aparecendo no início, no final ou no meio do texto da cadeia de caracteres de pesquisa na PathToMatch propriedade . Por exemplo, para localizar todos os caminhos que começam com "~/approot", a PathToMatch propriedade seria definida como "~/approot%".

Da mesma forma, uma pesquisa curinga em um nome de usuário parcial pode fazer com que o caractere curinga apareça em qualquer ponto na cadeia de caracteres de texto da UsernameToMatch propriedade. Por exemplo, para localizar todos os nomes de usuário que começam com "John", o UsernameToMatch parâmetro se pareceria com "John%".

As seguintes restrições de consulta se aplicam:

• Se apenas scope for fornecido e for querynull ou todas as propriedades em query valores padrão ou retornados null , todos os registros correspondentes ao parâmetro indicado scope serão retornados.

• Se a PathToMatch propriedade não nullfor , os registros retornados também serão filtrados com base em caminhos que correspondem ao valor da PathToMatch propriedade.

• Se a UsernameToMatch propriedade não nullfor , os registros retornados também serão filtrados com base nos nomes de usuário que correspondem ao valor da UsernameToMatch propriedade.

• Se a UserInactiveSinceDate propriedade não for igual a MaxValue, os registros retornados também serão filtrados para retornar apenas os registros associados a usuários inativos. A comparação inclui registros em que a LastActivityDate propriedade é menor ou igual à UserInactiveSinceDate propriedade .

Observe que esse método não valida combinações de parâmetros de consulta. Por exemplo, o código pode solicitar um conjunto de registros de estado de personalização associados a um nome de usuário específico no escopo compartilhado. Como os nomes de usuário não estão associados a informações compartilhadas, a coleção retornada estaria vazia.

As combinações de parâmetros que têm o potencial de retornar uma coleção não vazia incluem:

• Shared escopo em combinação com PathToMatch.

• User escopo em combinação com os valores para qualquer uma ou todas as PathToMatchpropriedades , UsernameToMatche UserInactiveSinceDate .