PersonalizationProvider.FindState(PersonalizationScope, PersonalizationStateQuery, Int32, Int32, Int32) Método

Definição

Quando substituído em uma classe derivada, retorna uma coleção que contém zero ou mais objetos derivados de PersonalizationStateInfo com base no escopo e nos parâmetros de consulta específicos.When overridden in a derived class, returns a collection containing zero or more PersonalizationStateInfo-derived objects based on scope and specific query parameters.

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

Um PersonalizationScope com as informações de personalização a serem consultadas.A PersonalizationScope with the personalization information to be queried. Esse valor não pode ser null.This value cannot be null.

query
PersonalizationStateQuery

Uma PersonalizationStateQuery que contém uma consulta.A PersonalizationStateQuery containing a query. Este valor pode ser null.This value can be null.

pageIndex
Int32

O local em que a consulta é iniciada.The location where the query starts.

pageSize
Int32

O número de registros a serem retornados.The number of records to return.

totalRecords
Int32

O número total de registros disponíveis.The total number of records available.

Retornos

PersonalizationStateInfoCollection

Uma PersonalizationStateInfoCollection que contém zero ou mais objetos derivados de PersonalizationStateInfo.A PersonalizationStateInfoCollection containing zero or more PersonalizationStateInfo-derived objects.

Comentários

Esse método é a definição abstrata de um método administrativo para consultar dados de personalização.This method is the abstract definition of an administrative method for querying personalization data. As implementações derivadas devem seguir a lógica descrita abaixo.Derived implementations should follow the logic described below.

O conjunto de itens retornados é restrito pelos pageIndex pageSize parâmetros e, em que pageSize define o número de registros a serem retornados e pageIndex define quais registros serão retornados.The set of returned items is constrained by the pageIndex and pageSize parameters, where pageSize sets the number of records to return and pageIndex sets which records to return. Por exemplo, um pageIndex de 0 e um pageSize de 25 retornariam as 25 primeiras ocorrências, enquanto um pageIndex de 1 e um pageSize de 25 retornariam ocorrências de 26-50.For example, a pageIndex of 0 and a pageSize of 25 would return the first 25 occurrences, while a pageIndex of 1 and a pageSize of 25 would return occurrences 26-50. Se você quiser recuperar todos os registros disponíveis, defina pageIndex como 0 e pageSize como MaxValue .If you want to retrieve all available records, set pageIndex to 0 and pageSize to MaxValue.

Os PersonalizationStateInfo objetos derivados são retornados em ordem alfabética e classificados por uma combinação de seus valores de Path Username propriedade e, em ordem crescente.The PersonalizationStateInfo-derived objects are returned in alphabetical order and sorted by a combination of their Path and Username property values, both in ascending order.

Esse método passa caracteres curinga de consulta para o armazenamento de dados subjacente.This method passes query wildcard characters to the underlying data store. No momento, o suporte para caracteres curinga depende de como cada provedor manipula caracteres como um asterisco (*), um símbolo de porcentagem (%) ou um sublinhado ().Support for wildcard characters is currently dependent on how each provider handles characters such as an asterisk (*), a percent symbol (%), or an underscore ().

Normalmente, para armazenamentos de dados compatíveis com SQL, você pode executar uma pesquisa de curinga em um caminho parcial com o caractere curinga que aparece no início, no final ou no meio do texto da cadeia de caracteres de pesquisa na PathToMatch propriedade.Normally, for SQL-compliant data stores, you can perform a wildcard search on a partial path with the wildcard character appearing at the beginning, the end, or the middle of the search string text in the PathToMatch property. Por exemplo, para localizar todos os caminhos que começam com " ~ /vdir", a PathToMatch propriedade seria definida como " ~ /vdir%".For example, to find all paths that start with "~/vdir", the PathToMatch property would be set to "~/vdir%".

Da mesma forma, uma pesquisa curinga em um nome de usuário parcial poderia ter o caractere curinga exibido em qualquer ponto na cadeia de texto da UsernameToMatch propriedade.Likewise, a wildcard search on a partial user name could have the wildcard character appear at any point in the text string of the UsernameToMatch property. Por exemplo, para localizar todos os nomes de usuário que começam com "John", o UsernameToMatch parâmetro ficaria como "João%".For example, to find all user names that start with "John", the UsernameToMatch parameter would look like "John%".

As seguintes restrições de consulta se aplicam:The following query constraints apply:

  • Se scope for fornecido apenas, e query for null ou todas as propriedades em query retornar null valores padrão ou, todos os registros correspondentes ao parâmetro indicado scope serão retornados.If only scope is provided, and query is null or all the properties on query return either null or default values, then all records matching the indicated scope parameter are returned.

  • Se a PathToMatch propriedade não for null , os registros retornados também serão filtrados com base em caminhos que correspondem ao PathToMatch valor.If the PathToMatch property is not null, the returned records are also filtered based on paths that match the PathToMatch value.

  • Se a UsernameToMatch propriedade não for null , os registros retornados também serão filtrados com base nos nomes de usuário que correspondem ao UsernameToMatch valor da propriedade.If the UsernameToMatch property is not null, the returned records are also filtered based on user names that match the UsernameToMatch property value.

  • 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.If the UserInactiveSinceDate property is not equal to MaxValue, then the returned records are also filtered to return only those records associated with inactive users. A comparação inclui registros em que a LastActivityDate propriedade é menor ou igual à UserInactiveSinceDate propriedade.The comparison includes records where the LastActivityDate property is less than or equal to the UserInactiveSinceDate property.

Observe que esse método não valida combinações de parâmetros de consulta.Note that this method does not validate combinations of query parameters. Por exemplo, o código pode solicitar um conjunto de registros de estado de personalização associado a um nome de usuário específico no escopo compartilhado.For example, code can request a set of personalization state records associated with a specific user name in the shared scope. Como os nomes de usuário não estão associados a informações compartilhadas, a coleção retornada estaria vazia.Because user names are not associated with shared information, the returned collection would be empty.

As combinações de parâmetros que têm o potencial de retornar uma coleção não vazia incluem:Parameter combinations that have the potential to return a non-empty collection include:

Aplica-se a