ReportingService2010.SetCacheOptions Method

Definition

Configures an item to be cached and provides settings that specify when the cached copy of the item expires. This method applies to the Report and Dataset item types.

public:
 void SetCacheOptions(System::String ^ ItemPath, bool CacheItem, ReportService2010::ExpirationDefinition ^ Item);
[System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/SetCacheOptions", 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 void SetCacheOptions (string ItemPath, bool CacheItem, ReportService2010.ExpirationDefinition Item);
[<System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/SetCacheOptions", 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")>]
member this.SetCacheOptions : string * bool * ReportService2010.ExpirationDefinition -> unit
Public Sub SetCacheOptions (ItemPath As String, CacheItem As Boolean, Item As ExpirationDefinition)

Parameters

ItemPath
String

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

CacheItem
Boolean

A Boolean value that indicates whether a copy of the executed item is put in cache. The default value is false.

Item
ExpirationDefinition

An ExpirationDefinition object that represents either a schedule or an expiration time for the item in cache.

Attributes

Remarks

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

SOAP Header Usage (In) TrustedUserHeaderValue

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

If CacheItem is set to false, you must set the value for Item to null (Nothing in Visual Basic); otherwise, an error occurs. If CacheItem is set to true, you must provide a value for Item; otherwise, a error occurs.

This method can be called only when the execution option for the item is set to Live. For more information about how to set execution options programmatically, see SetExecutionOptions.

Applies to