Share via

AuditLogTrimmingReportCallout.GetAuditReportStorageLocation method

  • Article

Gets the storage location for audit log reports that are generated by the periodic trimming job.

Namespace:  Microsoft.Office.RecordsManagement.Reporting
Assembly:  Microsoft.Office.Policy (in Microsoft.Office.Policy.dll)

Syntax

'Declaration
Public Shared Function GetAuditReportStorageLocation ( _
    site As SPSite, _
    fThrowIfNotExists As Boolean _
) As SPFolder
'Usage
Dim site As SPSite
Dim fThrowIfNotExists As Boolean
Dim returnValue As SPFolder

returnValue = AuditLogTrimmingReportCallout.GetAuditReportStorageLocation(site, _
    fThrowIfNotExists)

public static SPFolder GetAuditReportStorageLocation(
    SPSite site,
    bool fThrowIfNotExists
)

Parameters

  • site
    Type: Microsoft.SharePoint.SPSite

    The site that is the storage location for the audit log reports that are generated by the periodic trimming job.

  • fThrowIfNotExists
    Type: System.Boolean

    Whether to throw an exception if the folder doesn’t exist.

Return value

Type: Microsoft.SharePoint.SPFolder
Returns SPFolder.

Exceptions

Exception Condition
DirectoryNotFoundException

When the fThrowIfNotExists parameter is true and the folder does not exist.

See also

Reference

AuditLogTrimmingReportCallout class

AuditLogTrimmingReportCallout members

Microsoft.Office.RecordsManagement.Reporting namespace