ReportingService2010.CreateItemHistorySnapshot(String, Warning[]) Method

Reference

Definition

Namespace:: ReportService2010

Assembly:: ReportService2010.dll

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 an item history snapshot of a specified catalog item. This method applies to the Report item type.

public:
 System::String ^ CreateItemHistorySnapshot(System::String ^ ItemPath, [Runtime::InteropServices::Out] cli::array <ReportService2010::Warning ^> ^ % Warnings);

[System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateItemHistorySnapshot", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)]
[System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)]
[System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")]
public string CreateItemHistorySnapshot (string ItemPath, out ReportService2010.Warning[] Warnings);

[<System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateItemHistorySnapshot", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)>]
[<System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)>]
[<System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")>]
member this.CreateItemHistorySnapshot : string * Warning[] -> string

Public Function CreateItemHistorySnapshot (ItemPath As String, ByRef Warnings As Warning()) As String

Parameters

ItemPath: String

The fully qualified URL of the item including the file name and, in SharePoint mode, the extension.

Warnings: Warning[]

[out] An array of Warning objects that lists warnings that occurred during report processing.

Returns

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.

Attributes: SoapDocumentMethodAttribute SoapHeaderAttribute

Remarks

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


SOAP Header Usage	(In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue
Native Mode Required Permissions	CreateSnapshot AND Execute
SharePoint Mode Required Permissions	<xref:Microsoft.SharePoint.SPBasePermissions.EditListItems> AND <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems>

For the snapshot to be generated successfully, item history must be enabled for the catelog item. To enable item history for a catalog item, use the SetItemHistoryOptions method.

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

Snapshots are created by this method with default parameters only.

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

The ItemPath 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.

Applies to

Share via