SPWeb.GetUsageData method (SPUsageReportType, SPUsagePeriodType, Int32, DateTime)

Artigo
05/12/2015

Obtém uma tabela que contém informações sobre o uso de um site com base no tipo de relatório especificado, intervalo de tempo, número de colunas para exibição e o último dia para exibir.

Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaração
Public Function GetUsageData ( _
    itemType As SPUsageReportType, _
    periodType As SPUsagePeriodType, _
    numColsToDisplay As Integer, _
    lastDayToDisplay As DateTime _
) As DataTable
'Uso
Dim instance As SPWeb
Dim itemType As SPUsageReportType
Dim periodType As SPUsagePeriodType
Dim numColsToDisplay As Integer
Dim lastDayToDisplay As DateTime
Dim returnValue As DataTable

returnValue = instance.GetUsageData(itemType, _
    periodType, numColsToDisplay, lastDayToDisplay)

public DataTable GetUsageData(
    SPUsageReportType itemType,
    SPUsagePeriodType periodType,
    int numColsToDisplay,
    DateTime lastDayToDisplay
)

Parâmetros

itemType
Type: Microsoft.SharePoint.Administration.SPUsageReportType

Um valor de SPUsageReportType que especifica o tipo de relatório a ser criado.

periodType
Type: Microsoft.SharePoint.Administration.SPUsagePeriodType

Um valor de SPUsagePeriodType que especifica o intervalo de tempo para usar as informações retornadas.

numColsToDisplay
Type: System.Int32

Um inteiro de 32 bits que especifica o número de colunas para retornar na tabela.

lastDayToDisplay
Type: System.DateTime

Um valor de System.DateTime que especifica mais recente dia para representar as informações retornadas. O valor é passado para esse parâmetro deve especificar um tempo maior que ou igual ao último processamento de uso de tempo foi executado para o site.

Valor retornado

Type: System.Data.DataTable
Um objeto System.Data.DataTable que contém as informações.

Comentários

O método GetUsageData retorna resultados indefinidos quando forem passados parâmetros inválidos (por exemplo, a data de 100 anos atrás). Se o valor passado no parâmetro numColsToDisplay está fora do intervalo, 31 colunas são retornadas.

Esse método retorna 2000 somente registros de dados de uso do site, enquanto o método GetUsageBlob do protocolo Remote Procedure Call (RPC) retorna todos os dados de uso.

Examples

O exemplo de código a seguir preenche um controle DataGrid com 12 colunas de informações sobre o uso de um site, desde ontem.

Este exemplo também pressupõe a presença de um controle DataGrid .

Using webSite As SPWeb = SPContext.Current.Site.OpenWeb("Site_Name")
    Dim dateValue As System.DateTime = System.DateTime.Today
    dateValue = dateValue.AddDays(- 1)

    DataGrid1.DataSource = webSite.GetUsageData(SPUsageReportType.user, SPUsagePeriodType.day, 12, dateValue)

    DataGrid1.DataBind()
End Using

using (SPWeb oWebsite = SPContext.Current.Site.OpenWeb("Website_URL"))
{
    System.DateTime dtValue = System.DateTime.Today;
    dtValue = dtValue.AddDays(-1);
    DataGrid1.DataSource = 
        oWebsite.GetUsageData(SPUsageReportType.user, SPUsagePeriodType.day, 
        12, dtValue);
    DataGrid1.DataBind();
}

Dica

Determinados objetos implementam a interface IDisposable , e você deve evitar reter esses objetos na memória depois que eles não são mais necessários. Para obter informações sobre boas práticas de codificação, consulte Disposing Objects.

Ver também

Referência

SPWeb class

SPWeb members

GetUsageData overload

Microsoft.SharePoint namespace

Share via