ReportingService2010.GetCacheOptions Method (String, ExpirationDefinition)

Applies To: SQL Server 2016 Preview

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)

Syntax

[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetCacheOptions", 
    RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
public bool GetCacheOptions(
    string ItemPath,
    out ExpirationDefinition Item
)

public:
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetCacheOptions", 
    RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
bool GetCacheOptions(
    String^ ItemPath,
    [OutAttribute] ExpirationDefinition^% Item
)

[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetCacheOptions",
    RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
member GetCacheOptions : 
        ItemPath:string *
        Item:ExpirationDefinition byref -> bool

<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)>
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetCacheOptions",
    RequestNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    ResponseNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)>
<SoapHeaderAttribute("TrustedUserHeaderValue")>
Public Function GetCacheOptions (
    ItemPath As String,
    <OutAttribute> ByRef Item As ExpirationDefinition
) As Boolean

Parameters

• ItemPath
  Type: System.String

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

• Item
  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.

Remarks

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

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.

See Also

ReportingService2010 Class
ReportService2010 Namespace

Return to top