ReportingService2005.GetCacheOptions Method

Article
12/03/2008

Returns the cache configuration for a report and the settings that describe when the cached copy of the report expires.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetCacheOptions", 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 Function GetCacheOptions ( _
    Report As String, _
    <OutAttribute> ByRef Item As ExpirationDefinition _
) As Boolean

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetCacheOptions", 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 bool GetCacheOptions (
    string Report,
    out ExpirationDefinition Item
)

[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetCacheOptions", 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:
bool GetCacheOptions (
    String^ Report, 
    [OutAttribute] ExpirationDefinition^% Item
)

/** @attribute SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetCacheOptions", 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) */ 
/** @attribute SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) */ 
public boolean GetCacheOptions (
    String Report, 
    /** @attribute OutAttribute() */ /** @ref */ ExpirationDefinition Item
)

JScript does not support passing value-type arguments by reference.

Parameters

Report
The full path name of the report.

Item
[out] An ExpirationDefinition object that defines either the time, in minutes, or the schedule upon which the cached copy expires.

Return Value

A value of true if a copy of an executed report is placed in cache; otherwise, a value of false. The default value is false.

Remarks

Use the return value of this method to evaluate whether the report is set to be cached. If the value is false, the method returns a null (or Nothing in Visual Basic) for Item.

Use GetCacheOptions only if the execution option is configured to run on demand. For more information about the cache settings of a report, see Report Caching in Reporting Services. For information about programmatically setting the caching options of a report, see SetCacheOptions method.

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