• Article

ReportingService2006.SetCacheOptions Method

Configures a report to be cached and provides settings that specify when the cached copy of the report expires.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices/SetCacheOptions", RequestNamespace := "https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices",  _
    ResponseNamespace := "https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
Public Sub SetCacheOptions ( _
    Report As String, _
    CacheReport As Boolean, _
    Item As ExpirationDefinition _
)
'Usage
Dim instance As ReportingService2006
Dim Report As String
Dim CacheReport As Boolean
Dim Item As ExpirationDefinition

instance.SetCacheOptions(Report, CacheReport, _
    Item)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices/SetCacheOptions", RequestNamespace = "https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
public void SetCacheOptions(
    string Report,
    bool CacheReport,
    ExpirationDefinition Item
)

[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices/SetCacheOptions", RequestNamespace = L"https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices", 
    ResponseNamespace = L"https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
public:
void SetCacheOptions(
    String^ Report, 
    bool CacheReport, 
    ExpirationDefinition^ Item
)

[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices/SetCacheOptions", RequestNamespace = "https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/2006/03/15/reporting/reportingservices", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member SetCacheOptions : 
        Report:string * 
        CacheReport:bool * 
        Item:ExpirationDefinition -> unit 

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

Parameters

  • Report
    Type: System.String
    The fully qualified URL of the report including the file name and .rdl file name extension.
  • CacheReport
    Type: System.Boolean
    A Boolean value that indicates whether a copy of the executed report is put in cache. The default value is false.

Remarks

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

SOAP Headers

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

Required Permissions

EditListItems()

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

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