ReportingService2010.GetDataDrivenSubscriptionProperties Method

Returns the properties of a data-driven subscription.

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

Syntax

'Declaration
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetDataDrivenSubscriptionProperties", 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("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("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetDataDrivenSubscriptionProperties", 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("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"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetDataDrivenSubscriptionProperties", 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"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("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetDataDrivenSubscriptionProperties", 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("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

• DataDrivenSubscriptionID
  Type: System.String
  The ID of the data-driven subscription, returned by the CreateDataDrivenSubscription method.

• ExtensionSettings
  Type: ReportService2010.ExtensionSettings%
  [out] An ExtensionSettings object that contains a list of settings that are specific to the delivery extension.

• DataRetrievalPlan
  Type: ReportService2010.DataRetrievalPlan%
  [out] A DataRetrievalPlan object that contains a list of settings that are required to retrieve data from the delivery query for the subscription.

• Description
  Type: System.String%
  [out] A meaningful description that is displayed to users.

• Active
  Type: ReportService2010.ActiveState%
  [out] An ActiveState object that contains the active state of the subscription.

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

• Parameters
  Type: array<ReportService2010.ParameterValueOrFieldReference[]%
  [out] An array of ParameterValue objects that contains a list of parameters for the report.

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()

See Also

Reference

ReportingService2010 Class

ReportService2010 Namespace

CreateDataDrivenSubscription