ReportingService2010.GetCacheOptions(String, ExpirationDefinition) ReportingService2010.GetCacheOptions(String, ExpirationDefinition) ReportingService2010.GetCacheOptions(String, ExpirationDefinition) Method

Definition

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.

public:
 bool GetCacheOptions(System::String ^ ItemPath, [Runtime::InteropServices::Out] ReportService2010::ExpirationDefinition ^ % Item);
[System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetCacheOptions", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)]
[System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)]
[System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")]
public bool GetCacheOptions (string ItemPath, out ReportService2010.ExpirationDefinition Item);
Public Function GetCacheOptions (ItemPath As String, ByRef Item As ExpirationDefinition) As Boolean
Parameters
ItemPath
String String String

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

Item
ExpirationDefinition ExpirationDefinition 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 item is put in cache; otherwise, false.

Remarks

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

SOAP Header Usage (In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue
Native Mode Required Permissions ReadPolicy
SharePoint Mode Required Permissions <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems>

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.

Applies to