ReportingService2006.GetCacheOptions(String, ExpirationDefinition) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns the cache configuration for a report and the settings that describe when the cached copy of the report expires.
public:
bool GetCacheOptions(System::String ^ Report, [Runtime::InteropServices::Out] ReportService2006::ExpirationDefinition ^ % Item);public bool GetCacheOptions (string Report, out ReportService2006.ExpirationDefinition Item);member this.GetCacheOptions : string * ExpirationDefinition -> boolPublic Function GetCacheOptions (Report As String, ByRef Item As ExpirationDefinition) As BooleanParameters
- Report
- String
The fully qualified URL of the report including the file name and .rdl file name extension.
- Item
- ExpirationDefinition
[out] An ExpirationDefinition object that defines either the time, in minutes, or the schedule upon which the cached copy expires.
Returns
true if a copy of an executed report is put in cache; otherwise, false.
Remarks
The table below shows header and permissions information on this operation.
| SOAP Headers | (In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue |
| Required Permissions | <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems> |
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 Caching Reports (SSRS). For information about programmatically setting the caching options of a report, see SetCacheOptions method.