SqlPersonalizationProvider.FindState Método

Definición

Espacio de nombres:

System.Web.UI.WebControls.WebParts

Ensamblado:

System.Web.dll

Devuelve una colección que contiene cero o más objetos derivados de PersonalizationStateInfo, basándose en el ámbito y los parámetros 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

Un objeto PersonalizationScope que indica la información de personalización que se consulta. Este valor no puede ser null.

query

PersonalizationStateQuery

Una clase PersonalizationStateQuery que contiene una consulta. Este valor puede ser null.

pageIndex

Int32

La ubicación donde se inicia la consulta.

pageSize

Int32

Número de registros que se van a devolver.

totalRecords

Int32

Número total de registros disponibles.

Devoluciones

PersonalizationStateInfoCollection

Una colección PersonalizationStateInfoCollection que contiene cero o más objetos derivados de PersonalizationStateInfo.

Excepciones

ArgumentException

pageIndex es menor que cero.

o bien

pageSize es menor o igual que cero.

o bien

La combinación de pageIndex y pageSize da como resultado un valor mayor que Int32.MaxValue.

o bien

El valor de la propiedad PathToMatch no es null y es una cadena vacía ("") después de su recorte.

o bien

La longitud de PathToMatch es mayor de 256 caracteres cuando el valor no es null.

o bien

El valor de la propiedad UsernameToMatch no es null y es una cadena vacía después de su recorte.

o bien

La longitud de UsernameToMatch es mayor de 256 caracteres cuando el valor no es null.

ArgumentOutOfRangeException

El elemento scope especificado no es un valor válido de la enumeración PersonalizationScope.

Comentarios

El conjunto de elementos devueltos está restringido por los pageSize parámetros y pageIndex , donde pageSize controla el número de registros que se van a devolver y pageIndex los controles que se van a devolver. Por ejemplo, un pageIndex de 0 y un pageSize de 25 devolverían las primeras 25 repeticiones, mientras que un pageIndex de 1 y un pageSize de 25 devolvería repeticiones 26-50. Si desea capturar todos los registros disponibles, establezca pageIndex en 0 y pageSize en MaxValue.

Los PersonalizationStateInfoobjetos derivados de se devuelven en orden alfabético ordenados por Path y Username, ambos en orden ascendente.

Este método pasa caracteres comodín de consulta al almacén de datos subyacente. La compatibilidad con caracteres comodín depende actualmente de cómo controla cada proveedor caracteres, como un asterisco (*), un símbolo de porcentaje (%), o un carácter de subrayado (_).

Normalmente, para los almacenes de datos compatibles con SQL, puede realizar una búsqueda con caracteres comodín en una ruta de acceso parcial con el carácter comodín que aparece al principio, el final o el medio del texto de la cadena de búsqueda en la PathToMatch propiedad . Por ejemplo, para buscar todas las rutas de acceso que comienzan por "~/approot", la PathToMatch propiedad se establecería en "~/approot%".

Del mismo modo, una búsqueda con caracteres comodín en un nombre de usuario parcial podría hacer que el carácter comodín aparezca en cualquier punto de la cadena de texto de la UsernameToMatch propiedad. Por ejemplo, para buscar todos los nombres de usuario que comienzan por "John", el UsernameToMatch parámetro tendría un aspecto similar a "John%".

Se aplican las restricciones de consulta siguientes:

• Si solo scope se proporciona y query es null o todas las propiedades query de devuelven null o valores predeterminados, se devuelven todos los registros que coinciden con el parámetro indicado scope .

• Si la PathToMatch propiedad no nulles , los registros devueltos también se filtran en función de las rutas de acceso que coincidan con el valor de propiedad PathToMatch .

• Si la UsernameToMatch propiedad no nulles , los registros devueltos también se filtran en función de los nombres de usuario que coincidan con el valor de propiedad UsernameToMatch .

• Si la UserInactiveSinceDate propiedad no es igual a MaxValue, los registros devueltos también se filtran para devolver solo los registros asociados a usuarios inactivos. La comparación incluye registros en los que la LastActivityDate propiedad es menor o igual que la UserInactiveSinceDate propiedad .

Tenga en cuenta que este método no valida las combinaciones de parámetros de consulta. Por ejemplo, el código puede solicitar un conjunto de registros de estado de personalización asociados a un nombre de usuario específico en el ámbito compartido. Dado que los nombres de usuario no están asociados a la información compartida, la colección devuelta estaría vacía.

Las combinaciones de parámetros que tienen la posibilidad de devolver una colección no vacía incluyen:

• Shared ámbito en combinación con PathToMatch.

• User ámbito en combinación con los valores de cualquiera o todas las PathToMatchpropiedades , UsernameToMatchy UserInactiveSinceDate .