• Article

ReportingService2005.SetCacheOptions Method

Configures a report for caching and provides settings that specify when the cached copy of the report expires.

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

Syntax

'Declaration
<SoapHeaderAttribute("BatchHeaderValue")> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetCacheOptions", 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("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
Public Sub SetCacheOptions ( _
    Report As String, _
    CacheReport As Boolean, _
    Item As ExpirationDefinition _
)
'Usage
Dim instance As ReportingService2005
Dim Report As String
Dim CacheReport As Boolean
Dim Item As ExpirationDefinition

instance.SetCacheOptions(Report, CacheReport, _
    Item)

[SoapHeaderAttribute("BatchHeaderValue")]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetCacheOptions", 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("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
public void SetCacheOptions(
    string Report,
    bool CacheReport,
    ExpirationDefinition Item
)

[SoapHeaderAttribute(L"BatchHeaderValue")]
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetCacheOptions", 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"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
public:
void SetCacheOptions(
    String^ Report, 
    bool CacheReport, 
    ExpirationDefinition^ Item
)

[<SoapHeaderAttribute("BatchHeaderValue")>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetCacheOptions", 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("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member SetCacheOptions : 
        Report:string * 
        CacheReport:bool * 
        Item:ExpirationDefinition -> unit 

public function SetCacheOptions(
    Report : String, 
    CacheReport : boolean, 
    Item : ExpirationDefinition
)

Parameters

  • CacheReport
    Type: System.Boolean
    A Boolean value that indicates whether a copy of the executed report is placed in cache. The default value is false.

Remarks

If CacheReport is set to false, set the value for Item to nulla null reference (Nothing in Visual Basic) (Nothing in Visual Basic); an error occurs. If CacheReport is set to true, you must provide a value for Item; otherwise, it results in an error.

The SetCacheOptions method can be called only when the execution option for the report is set to Live. For more information about setting execution options programmatically, see SetExecutionOptions.