ReportingService2005.SetCacheOptions Method

Article
12/03/2008

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

Namespace: Microsoft.WSSUX.ReportingServicesWebService.RSManagementService2005
Assembly: ReportService2005 (in reportingservice2005.dll)

Syntax

'Declaration
<SoapHeaderAttribute("BatchHeaderValue")> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction:=SoapHeaderDirection.Out)> _
<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)> _
Public Sub SetCacheOptions ( _
    Report As String, _
    CacheReport As Boolean, _
    Item As ExpirationDefinition _
)

[SoapHeaderAttribute("BatchHeaderValue")] 
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out)] 
[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)] 
public void SetCacheOptions (
    string Report,
    bool CacheReport,
    ExpirationDefinition Item
)

[SoapHeaderAttribute(L"BatchHeaderValue")] 
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction=SoapHeaderDirection::Out)] 
[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)] 
public:
void SetCacheOptions (
    String^ Report, 
    bool CacheReport, 
    ExpirationDefinition^ Item
)

/** @attribute SoapHeaderAttribute("BatchHeaderValue") */ 
/** @attribute SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) */ 
/** @attribute 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) */ 
public void SetCacheOptions (
    String Report, 
    boolean CacheReport, 
    ExpirationDefinition Item
)

SoapHeaderAttribute("BatchHeaderValue") 
SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) 
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) 
public function SetCacheOptions (
    Report : String, 
    CacheReport : boolean, 
    Item : ExpirationDefinition
)

Parameters

Report
The full path name of the report.

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

Item
An ExpirationDefinition object representing either a schedule or an expiration time for the report in cache.

Remarks

If CacheReport is set to false, set the value for Item to null (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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms