ReportingService2010.GetCacheRefreshPlanProperties Method

Returns the properties of the specified cache refresh plan.

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

Syntax

'Declaration
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetCacheRefreshPlanProperties", RequestNamespace := "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",  _
    ResponseNamespace := "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
Public Function GetCacheRefreshPlanProperties ( _
    CacheRefreshPlanID As String, _
    <OutAttribute> ByRef LastRunStatus As String, _
    <OutAttribute> ByRef State As CacheRefreshPlanState, _
    <OutAttribute> ByRef EventType As String, _
    <OutAttribute> ByRef MatchData As String, _
    <OutAttribute> ByRef Parameters As ParameterValue() _
) As String
'Usage
Dim instance As ReportingService2010 
Dim CacheRefreshPlanID As String 
Dim LastRunStatus As String 
Dim State As CacheRefreshPlanState 
Dim EventType As String 
Dim MatchData As String 
Dim Parameters As ParameterValue()
Dim returnValue As String 

returnValue = instance.GetCacheRefreshPlanProperties(CacheRefreshPlanID, _
    LastRunStatus, State, EventType, _
    MatchData, Parameters)
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetCacheRefreshPlanProperties", RequestNamespace = "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
public string GetCacheRefreshPlanProperties(
    string CacheRefreshPlanID,
    out string LastRunStatus,
    out CacheRefreshPlanState State,
    out string EventType,
    out string MatchData,
    out ParameterValue[] Parameters
)
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute(L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetCacheRefreshPlanProperties", RequestNamespace = L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
public:
String^ GetCacheRefreshPlanProperties(
    String^ CacheRefreshPlanID, 
    [OutAttribute] String^% LastRunStatus, 
    [OutAttribute] CacheRefreshPlanState^% State, 
    [OutAttribute] String^% EventType, 
    [OutAttribute] String^% MatchData, 
    [OutAttribute] array<ParameterValue^>^% Parameters
)
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetCacheRefreshPlanProperties", RequestNamespace = "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member GetCacheRefreshPlanProperties : 
        CacheRefreshPlanID:string * 
        LastRunStatus:string byref * 
        State:CacheRefreshPlanState byref * 
        EventType:string byref * 
        MatchData:string byref * 
        Parameters:ParameterValue[] byref -> string
public function GetCacheRefreshPlanProperties(
    CacheRefreshPlanID : String, 
    LastRunStatus : String, 
    State : CacheRefreshPlanState, 
    EventType : String, 
    MatchData : String, 
    Parameters : ParameterValue[]
) : String

Parameters

  • CacheRefreshPlanID
    Type: System.String
    The unique identifier for the cache refresh plan.
  • LastRunStatus
    Type: System.String%
    [out] A string that represents the status of the most recent cache refresh.
  • EventType
    Type: System.String%
    [out] The type of event that triggers the cache refresh.
  • MatchData
    Type: System.String%
    [out] The data that is associated with the specified EventType parameter. This is a serialized ScheduleDefinition specific to the item in ItemPath, or the schedule ID of a shared schedule.

Return Value

Type: System.String
A string that represents the description of the cache refresh plan.

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

ViewListItems

See Also

Reference

ReportingService2010 Class

ReportService2010 Namespace

Other Resources

Cache Shared Datasets (SSRS)

Caching Reports (SSRS)