ReportingService2010.GetItemHistoryOptions Method

Returns the item history snapshot option and properties that are generated for a 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/GetItemHistoryOptions", 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 GetItemHistoryOptions ( _
    ItemPath As String, _
    <OutAttribute> ByRef KeepExecutionSnapshots As Boolean, _
    <OutAttribute> ByRef Item As ScheduleDefinitionOrReference _
) As Boolean
'Usage
Dim instance As ReportingService2010 
Dim ItemPath As String 
Dim KeepExecutionSnapshots As Boolean 
Dim Item As ScheduleDefinitionOrReference 
Dim returnValue As Boolean 

returnValue = instance.GetItemHistoryOptions(ItemPath, _
    KeepExecutionSnapshots, Item)

[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetItemHistoryOptions", 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 bool GetItemHistoryOptions(
    string ItemPath,
    out bool KeepExecutionSnapshots,
    out ScheduleDefinitionOrReference Item
)

[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetItemHistoryOptions", 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:
bool GetItemHistoryOptions(
    String^ ItemPath, 
    [OutAttribute] bool% KeepExecutionSnapshots, 
    [OutAttribute] ScheduleDefinitionOrReference^% Item
)

[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetItemHistoryOptions", 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 GetItemHistoryOptions : 
        ItemPath:string * 
        KeepExecutionSnapshots:bool byref * 
        Item:ScheduleDefinitionOrReference byref -> bool

public function GetItemHistoryOptions(
    ItemPath : String, 
    KeepExecutionSnapshots : boolean, 
    Item : ScheduleDefinitionOrReference
) : boolean

Parameters

• ItemPath
  Type: System.String
  The fully qualified URL of the item including the file name and, in SharePoint mode, the extension.

• KeepExecutionSnapshots
  Type: System.Boolean%
  [out] A Boolean expression indicating whether item history is collected for the item. The default value is false.

• Item
  Type: ReportService2010.ScheduleDefinitionOrReference%
  [out] A ScheduleDefinitionOrReference object that represents a ScheduleDefinition object, a ScheduleReference object, or a NoSchedule object.

Return Value

Type: System.Boolean
true if item history is collected for the item; otherwise, false.

Remarks

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

SOAP Header Usage	(In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue
Native Mode Required Permissions	ReadPolicy
SharePoint Mode Required Permissions	ViewListItems

See Also

Reference

ReportingService2010 Class

ReportService2010 Namespace