• Article

ReportingService2005.SetReportHistoryLimit Method

Specifies the number of snapshots of a report that the report server retains in the report server database.

Namespace:  ReportService2005
Assembly:  ReportService2005 (in ReportService2005.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetReportHistoryLimit", RequestNamespace := "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",  _
    ResponseNamespace := "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapHeaderAttribute("BatchHeaderValue")> _
Public Sub SetReportHistoryLimit ( _
    Report As String, _
    UseSystem As Boolean, _
    HistoryLimit As Integer _
)
'Usage
Dim instance As ReportingService2005
Dim Report As String
Dim UseSystem As Boolean
Dim HistoryLimit As Integer

instance.SetReportHistoryLimit(Report, _
    UseSystem, HistoryLimit)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetReportHistoryLimit", RequestNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapHeaderAttribute("BatchHeaderValue")]
public void SetReportHistoryLimit(
    string Report,
    bool UseSystem,
    int HistoryLimit
)

[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetReportHistoryLimit", RequestNamespace = L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapHeaderAttribute(L"BatchHeaderValue")]
public:
void SetReportHistoryLimit(
    String^ Report, 
    bool UseSystem, 
    int HistoryLimit
)

[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetReportHistoryLimit", RequestNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapHeaderAttribute("BatchHeaderValue")>]
member SetReportHistoryLimit : 
        Report:string * 
        UseSystem:bool * 
        HistoryLimit:int -> unit 

public function SetReportHistoryLimit(
    Report : String, 
    UseSystem : boolean, 
    HistoryLimit : int
)

Parameters

  • UseSystem
    Type: System.Boolean
    A Boolean expression that, when set to true, sets the report history limit to the current system report history limit. A value of false indicates that the report history limit corresponds to the value supplied in the HistoryLimit parameter.
  • HistoryLimit
    Type: System.Int32
    The number of report history snapshots to store for the report. Values can range from -1 to 2,147,483,647. If the value is set to –1, all report snapshots are saved.

Remarks

The table below shows header and permissions information on this operation.

SOAP Headers

(In) BatchHeaderValue

(Out) ServerInfoHeaderValue

Required Permissions

UpdatePolicy

If the UseSystem parameter is set to true, the report server ignores the HistoryLimit parameter.

Note

If the value of HistoryLimit is changed, report history snapshots may be deleted.