PersonalizationProvider.FindState Método
Definição
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, retorna uma coleção que contém zero ou mais PersonalizationStateInfoobjetos derivados com base no escopo e em parâmetros de consulta específicos.
public:
abstract 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 abstract 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);
abstract member FindState : System.Web.UI.WebControls.WebParts.PersonalizationScope * System.Web.UI.WebControls.WebParts.PersonalizationStateQuery * int * int * int -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public MustOverride Function FindState (scope As PersonalizationScope, query As PersonalizationStateQuery, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As PersonalizationStateInfoCollection
Parâmetros
- scope
- PersonalizationScope
A PersonalizationScope com as informações de personalização a serem consultadas. Esse valor não pode ser null.
Uma PersonalizationStateQuery que contém uma consulta. Este valor pode ser null.
- pageIndex
- Int32
O local onde a consulta é iniciada.
- pageSize
- Int32
O número de registros a serem retornados.
- totalRecords
- Int32
O número total de registros disponíveis.
Retornos
Um PersonalizationStateInfoCollection que contém zero ou mais PersonalizationStateInfoobjetos derivados.
Comentários
Esse método é a definição abstrata de um método administrativo para consultar dados de personalização. As implementações derivadas devem seguir a lógica descrita abaixo.
O conjunto de itens retornados é restrito pelos pageIndex parâmetros e pageSize , em que pageSize define o número de registros a serem retornados e pageIndex define quais registros devem ser retornados. 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 retornaria as ocorrências de 26 a 50. Se você quiser recuperar todos os registros disponíveis, defina pageIndex como 0 e pageSize como MaxValue.
Os PersonalizationStateInfoobjetos derivados são retornados em ordem alfabética e classificados por uma combinação de valores de propriedade e Username delesPath, 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 lida com caracteres como um asterisco (*), um símbolo percentual (%) 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 "~/vdir", a PathToMatch propriedade seria definida como "~/vdir%".
Da mesma forma, uma pesquisa curinga em um nome de usuário parcial pode fazer com que o caractere curinga apareça a qualquer momento 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
scopefor fornecido equeryfornullou todas as propriedades emqueryvalores retornadosnullou padrão, todos os registros correspondentes ao parâmetro indicadoscopeserão retornados.Se a PathToMatch propriedade não
nullestiver, os registros retornados também serão filtrados com base em caminhos que correspondem ao PathToMatch valor.Se a UsernameToMatch propriedade não
nullestiver, 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 somente 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 a PathToMatch propriedade.
Userescopo em combinação com os valores para qualquer um ou todas as PathToMatchUsernameToMatchpropriedades e UserInactiveSinceDate propriedades.