Partilhar via


ReportingService2006.GetCacheOptions Method

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

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

Syntax

'Declaration
Public Function GetCacheOptions ( _
    Report As String, _
    <OutAttribute> ByRef Item As ExpirationDefinition _
) As Boolean
public bool GetCacheOptions (
    string Report,
    out ExpirationDefinition Item
)
public:
bool GetCacheOptions (
    String^ Report, 
    [OutAttribute] ExpirationDefinition^% Item
)
public boolean GetCacheOptions (
    String Report, 
    /** @attribute OutAttribute() */ /** @ref */ ExpirationDefinition Item
)
JScript does not support passing value-type arguments by reference.

Parameters

  • Report
    The fully qualified URL of the report including the file name and .rdl file name extension.
  • Item
    [out] An ExpirationDefinition object that defines either the time, in minutes, or the schedule upon which the cached copy expires.

Return Value

true if a copy of an executed report is put in cache; otherwise, 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

Windows 98, Windows 2000, Windows 2000 Server, Windows CE, Windows Server 2008, Windows 98 Second Edition, Pocket PC, Smart Phone, Windows Server 2003, Windows XP Professional with Service Pack 2 (SP2), Windows 2000 Professional, Windows 2000 Advanced Server, Windows XP Home Edition, For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005., Windows Vista, Windows Mobile 5.0, Windows Mobile 2003 for Pocket PC, Windows CE 5.0

See Also

Reference

ReportingService2006 Class
ReportingService2006 Members
ReportService2006 Namespace