ReportingService2010.GetCacheOptions Method
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
'Declaration
<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
'Usage
Dim instance As ReportingService2010
Dim ItemPath As String
Dim Item As ExpirationDefinition
Dim returnValue As Boolean
returnValue = instance.GetCacheOptions(ItemPath, _
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")]
public bool GetCacheOptions(
string ItemPath,
out ExpirationDefinition Item
)
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetCacheOptions", RequestNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
ResponseNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
public:
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
public function GetCacheOptions(
ItemPath : String,
Item : ExpirationDefinition
) : 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.
SOAP Header Usage |
(Out) ServerInfoHeaderValue |
Native Mode Required Permissions |
|
SharePoint Mode Required Permissions |
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 nulla null reference (Nothing in Visual Basic) (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.