ReportingService2010.GetDataDrivenSubscriptionProperties Method

Returns the properties of a data-driven subscription.

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

Syntax

'Declaration
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetDataDrivenSubscriptionProperties", 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 GetDataDrivenSubscriptionProperties ( _
    DataDrivenSubscriptionID As String, _
    <OutAttribute> ByRef ExtensionSettings As ExtensionSettings, _
    <OutAttribute> ByRef DataRetrievalPlan As DataRetrievalPlan, _
    <OutAttribute> ByRef Description As String, _
    <OutAttribute> ByRef Active As ActiveState, _
    <OutAttribute> ByRef Status As String, _
    <OutAttribute> ByRef EventType As String, _
    <OutAttribute> ByRef MatchData As String, _
    <OutAttribute> ByRef Parameters As ParameterValueOrFieldReference() _
) As String
'Usage
Dim instance As ReportingService2010
Dim DataDrivenSubscriptionID As String
Dim ExtensionSettings As ExtensionSettings
Dim DataRetrievalPlan As DataRetrievalPlan
Dim Description As String
Dim Active As ActiveState
Dim Status As String
Dim EventType As String
Dim MatchData As String
Dim Parameters As ParameterValueOrFieldReference()
Dim returnValue As String

returnValue = instance.GetDataDrivenSubscriptionProperties(DataDrivenSubscriptionID, _
    ExtensionSettings, DataRetrievalPlan, _
    Description, Active, Status, EventType, _
    MatchData, Parameters)
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetDataDrivenSubscriptionProperties", 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 GetDataDrivenSubscriptionProperties(
    string DataDrivenSubscriptionID,
    out ExtensionSettings ExtensionSettings,
    out DataRetrievalPlan DataRetrievalPlan,
    out string Description,
    out ActiveState Active,
    out string Status,
    out string EventType,
    out string MatchData,
    out ParameterValueOrFieldReference[] Parameters
)
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute(L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetDataDrivenSubscriptionProperties", 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^ GetDataDrivenSubscriptionProperties(
    String^ DataDrivenSubscriptionID, 
    [OutAttribute] ExtensionSettings^% ExtensionSettings, 
    [OutAttribute] DataRetrievalPlan^% DataRetrievalPlan, 
    [OutAttribute] String^% Description, 
    [OutAttribute] ActiveState^% Active, 
    [OutAttribute] String^% Status, 
    [OutAttribute] String^% EventType, 
    [OutAttribute] String^% MatchData, 
    [OutAttribute] array<ParameterValueOrFieldReference^>^% Parameters
)
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetDataDrivenSubscriptionProperties", 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 GetDataDrivenSubscriptionProperties : 
        DataDrivenSubscriptionID:string * 
        ExtensionSettings:ExtensionSettings byref * 
        DataRetrievalPlan:DataRetrievalPlan byref * 
        Description:string byref * 
        Active:ActiveState byref * 
        Status:string byref * 
        EventType:string byref * 
        MatchData:string byref * 
        Parameters:ParameterValueOrFieldReference[] byref -> string 
public function GetDataDrivenSubscriptionProperties(
    DataDrivenSubscriptionID : String, 
    ExtensionSettings : ExtensionSettings, 
    DataRetrievalPlan : DataRetrievalPlan, 
    Description : String, 
    Active : ActiveState, 
    Status : String, 
    EventType : String, 
    MatchData : String, 
    Parameters : ParameterValueOrFieldReference[]
) : String

Parameters

  • Description
    Type: System.String%
    [out] A meaningful description that is displayed to users.
  • Status
    Type: System.String%
    [out] The status of the subscription.
  • EventType
    Type: System.String%
    [out] The type of event that triggers the subscription.
  • MatchData
    Type: System.String%
    [out] The data that is associated with the specified type of event. This parameter is used by an event to match the subscription with an event that has fired.

Return Value

Type: System.String
A String value containing the user ID of the owner of the data-driven subscription.

Remarks

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

SOAP Header Usage

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

Native Mode Required Permissions

ReadAnySubscription

SharePoint Mode Required Permissions

ManageAlerts()