SqlPersonalizationProvider.GetCountOfState Método

Definição

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Retorna uma contagem do número de linhas no armazenamento de dados subjacente, que existem para o parâmetro scope especificado.

public:
 override int GetCountOfState(System::Web::UI::WebControls::WebParts::PersonalizationScope scope, System::Web::UI::WebControls::WebParts::PersonalizationStateQuery ^ query);

public override int GetCountOfState (System.Web.UI.WebControls.WebParts.PersonalizationScope scope, System.Web.UI.WebControls.WebParts.PersonalizationStateQuery query);

override this.GetCountOfState : System.Web.UI.WebControls.WebParts.PersonalizationScope * System.Web.UI.WebControls.WebParts.PersonalizationStateQuery -> int

Public Overrides Function GetCountOfState (scope As PersonalizationScope, query As PersonalizationStateQuery) As Integer

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.

Retornos

Int32

O número de linhas no armazenamento de dados subjacente que existem para o parâmetro scope especificado.

Exceções

ArgumentException

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

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 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 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 seria semelhante a "John%".

As seguintes restrições de consulta se aplicam:

• Se apenas scope for fornecido e query for null ou todas as propriedades em query valores retornados null ou padrão, 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 o UsernameToMatch não nullfor , os registros retornados também serão filtrados com base em 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 uma contagem de registros de estado associados a usuários inativos no escopo compartilhado. Como não há nenhum conceito de personalizações inativas, a contagem retornada seria zero.

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 de qualquer ou todas as PathToMatchpropriedades , UsernameToMatche UserInactiveSinceDate .