ReportingService2010.CreateItemHistorySnapshot Method
Generates an item history snapshot of a specified catalog item. This method applies to the Report item type.
Namespace: ReportService2010
Assembly: ReportService2010 (in ReportService2010.dll)
Syntax
'Declaration
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateItemHistorySnapshot", RequestNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", _
ResponseNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", _
Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function CreateItemHistorySnapshot ( _
ItemPath As String, _
<OutAttribute> ByRef Warnings As Warning() _
) As String
'Usage
Dim instance As ReportingService2010
Dim ItemPath As String
Dim Warnings As Warning()
Dim returnValue As String
returnValue = instance.CreateItemHistorySnapshot(ItemPath, _
Warnings)
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateItemHistorySnapshot", RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public string CreateItemHistorySnapshot(
string ItemPath,
out Warning[] Warnings
)
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateItemHistorySnapshot", RequestNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
ResponseNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
public:
String^ CreateItemHistorySnapshot(
String^ ItemPath,
[OutAttribute] array<Warning^>^% Warnings
)
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateItemHistorySnapshot", RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
member CreateItemHistorySnapshot :
ItemPath:string *
Warnings:Warning[] byref -> string
public function CreateItemHistorySnapshot(
ItemPath : String,
Warnings : Warning[]
) : String
Parameters
- ItemPath
Type: System.String
The fully qualified URL of the item including the file name and, in SharePoint mode, the extension.
- Warnings
Type: array<ReportService2010.Warning[]%
[out] An array of Warning objects that lists warnings that occurred during report processing.
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
The table below shows header and permissions information on this operation.
SOAP Header Usage |
(Out) ServerInfoHeaderValue |
Native Mode Required Permissions |
|
SharePoint Mode Required Permissions |
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.