ReportingService2005.GetDataDrivenSubscriptionProperties Method

  • Article

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Returns the properties of a data-driven subscription.

Syntax

'Declaration
Public Function GetDataDrivenSubscriptionProperties ( _
    DataDrivenSubscriptionID As String, _
     ByRef ExtensionSettings As ExtensionSettings, _
     ByRef DataRetrievalPlan As DataRetrievalPlan, _
     ByRef Description As String, _
     ByRef Active As ActiveState, _
     ByRef Status As String, _
     ByRef EventType As String, _
     ByRef MatchData As String, _
     ByRef Parameters As ParameterValueOrFieldReference() _
) As String

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
)

public:
String^ GetDataDrivenSubscriptionProperties (
    String^ DataDrivenSubscriptionID, 
     ExtensionSettings^% ExtensionSettings, 
     DataRetrievalPlan^% DataRetrievalPlan, 
     String^% Description, 
     ActiveState^% Active, 
     String^% Status, 
     String^% EventType, 
     String^% MatchData, 
     array<ParameterValueOrFieldReference^>^% Parameters
)

public String GetDataDrivenSubscriptionProperties (
    String DataDrivenSubscriptionID, 
    /** @attribute  */ /** @ref */ ExtensionSettings ExtensionSettings, 
    /** @attribute  */ /** @ref */ DataRetrievalPlan DataRetrievalPlan, 
    /** @attribute  */ /** @ref */ String Description, 
    /** @attribute  */ /** @ref */ ActiveState Active, 
    /** @attribute  */ /** @ref */ String Status, 
    /** @attribute  */ /** @ref */ String EventType, 
    /** @attribute  */ /** @ref */ String MatchData, 
    /** @attribute  */ /** @ref */ ParameterValueOrFieldReference[] Parameters
)

JScript does not support passing value-type arguments by reference.

Parameters

  • DataDrivenSubscriptionID
    The ID of the data-driven subscription.
  • ExtensionSettings
    [out] An ExtensionSettings object that contains a list of settings that are specific to the delivery extension.
  • 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
    [out] A meaningful description that is displayed to users.
  • Active
    [out] An ActiveState object that contains the active state of the subscription.
  • Status
    [out] The status of the subscription.
  • EventType
    [out] The type of event that triggers the subscription.
  • MatchData
    [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
    [out] An array of ParameterValue objects that contains a list of parameters for the report.

Return Value

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

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server.

Target Platforms

See Also

Reference

ReportingService2005 Class
ReportingService2005 Members
Microsoft.WSSUX.ReportingServicesWebService.RSManagementService2005 Namespace
ReportingService2005.CreateDataDrivenSubscription Method