ReportingService2010::GetCacheOptions Method (String^, ExpirationDefinition^%)


Returns the cache configuration for an item and the settings that describe when the cached copy of the item expires. This method applies to the Report and Dataset item types.

Namespace:   ReportService2010
Assembly:  ReportService2010 (in ReportService2010.dll)

[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
	RequestNamespace = "", 
	ResponseNamespace = "", 
	Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
bool GetCacheOptions(
	String^ ItemPath,
	[OutAttribute] ExpirationDefinition^% Item


Type: System::String^

The fully qualified URL of the item including the file name and, in SharePoint mode, the extension.

Type: ReportService2010::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

true if a copy of an executed item is put in cache; otherwise, false.

The table below shows header and permissions information on this operation.

SOAP Header Usage

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

Native Mode Required Permissions


SharePoint Mode Required Permissions


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

Use this method only if the execution option is configured to run on demand. For more information about the cache settings of an item, see Caching Reports (SSRS). For information about programmatically setting the caching options of an item, see the SetCacheOptions method.

Return to top