• Article

ReportingService2005.CreateReportHistorySnapshot Method

Generates a report history snapshot of a specified report.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/CreateReportHistorySnapshot", 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("BatchHeaderValue")> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
Public Function CreateReportHistorySnapshot ( _
    Report As String, _
    <OutAttribute> ByRef Warnings As Warning() _
) As String
'Usage
Dim instance As ReportingService2005
Dim Report As String
Dim Warnings As Warning()
Dim returnValue As String

returnValue = instance.CreateReportHistorySnapshot(Report, _
    Warnings)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/CreateReportHistorySnapshot", 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("BatchHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
public string CreateReportHistorySnapshot(
    string Report,
    out Warning[] Warnings
)

[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/CreateReportHistorySnapshot", 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"BatchHeaderValue")]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
public:
String^ CreateReportHistorySnapshot(
    String^ Report, 
    [OutAttribute] array<Warning^>^% Warnings
)

[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/CreateReportHistorySnapshot", 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("BatchHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member CreateReportHistorySnapshot : 
        Report:string * 
        Warnings:Warning[] byref -> string 

public function CreateReportHistorySnapshot(
    Report : String, 
    Warnings : Warning[]
) : String

Parameters

  • Report
    Type: System.String
    The fully qualified URL of the report.

Return Value

Type: System.String
A String that represents the date and time stamp of the snapshot. This string is used as a unique identifier for the historical snapshot.

Remarks

For the snapshot to be generated successfully, report history must be enabled for the report. To enable report history for a report, use the SetReportHistoryOptions method. For more information about report history, see Managing Report History.

If the report contains subreports, query result sets from the subreports are persisted in the report history snapshot. Report parameters that are passed to the report at the time the report is executed are also persisted.

Snapshots are created by the CreateReportHistorySnapshot method with default report parameters only. If you need to create report history snapshots with different parameter profiles, then use linked reports with CreateReportHistorySnapshot.

The length of the Report parameter cannot exceed 260 characters; otherwise, a SOAP exception is thrown with the error code rsItemLengthExceeded.

The Report parameter cannot be null or empty or contain the following reserved characters: : ? ; @ & = + $ , \ * > < | . ". You can use the forward slash character (/) to separate items in the full path name of the folder, but you cannot use it at the end of the folder name.