ReportingService2005.GetCacheOptions Method
Returns the cache configuration for a report and the settings that describe when the cached copy of the report expires.
Namespace: ReportService2005
Assembly: ReportService2005 (in ReportService2005.dll)
Syntax
'Declaration
Public Function GetCacheOptions ( _
Report As String, _
<OutAttribute> ByRef Item As ExpirationDefinition _
) As Boolean
'Usage
Dim instance As ReportingService2005
Dim Report As String
Dim Item As ExpirationDefinition
Dim returnValue As Boolean
returnValue = instance.GetCacheOptions(Report, _
Item)
public bool GetCacheOptions(
string Report,
out ExpirationDefinition Item
)
public:
bool GetCacheOptions(
String^ Report,
[OutAttribute] ExpirationDefinition^% Item
)
member GetCacheOptions :
Report:string *
Item:ExpirationDefinition byref -> bool
public function GetCacheOptions(
Report : String,
Item : ExpirationDefinition
) : boolean
Parameters
- Report
Type: System.String
The full path name of the report.
- Item
Type: ReportService2005.ExpirationDefinition%
[out] An ExpirationDefinition object that defines either the time, in minutes, or the schedule upon which the cached copy expires.
Return Value
Type: System.Boolean
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
The table below shows header and permissions information on this operation.
SOAP Headers |
(Out) ServerInfoHeaderValue |
Required Permissions |
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 nulla null reference (Nothing in Visual Basic) (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 Caching Reports (SSRS). For information about programmatically setting the caching options of a report, see SetCacheOptions method.