ReportingService2006.CreateReportHistorySnapshot(String, Warning[]) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Generates a report history snapshot of a specified report.
public:
System::String ^ CreateReportHistorySnapshot(System::String ^ Report, [Runtime::InteropServices::Out] cli::array <ReportService2006::Warning ^> ^ % Warnings);
public string CreateReportHistorySnapshot (string Report, out ReportService2006.Warning[] Warnings);
member this.CreateReportHistorySnapshot : string * Warning[] -> string
Public Function CreateReportHistorySnapshot (Report As String, ByRef Warnings As Warning()) As String
Parameters
- Report
- String
The fully qualified URL for the report including the file name and .rdl file name extension.
- Warnings
- Warning[]
[out] An array of Warning objects that lists warnings that occurred during report processing.
Returns
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
The table below shows header and permissions information on this operation.
SOAP Headers | (In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue |
Required Permissions | <xref:Microsoft.SharePoint.SPBasePermissions.EditListItems> AND <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems> |
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.
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.
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.