GetSubscriptionProperties Method
Collapse the table of content
Expand the table of content

GetSubscriptionProperties Method

SQL Server 2000

ReportingService.GetSubscriptionProperties Method

Returns the properties of a specified subscription.

Public Function GetSubscriptionProperties(
   ByVal SubscriptionID As String,
   ByRef ExtensionSettings As [Namespace].ExtensionSettings,
   ByRef Description As String,
   ByRef Active As [Namespace].ActiveState,
   ByRef Status As String,
   ByRef EventType As String,
   ByRef MatchData As String,
   ByRef Parameters() As [Namespace].ParameterValue
) As String
   Member of [Namespace].ReportingService

public string GetSubscriptionProperties(
   string SubscriptionID,
   out [Namespace].ExtensionSettings ExtensionSettings,
   out string Description,
   out [Namespace].ActiveState Active,
   out string Status,
   out string EventType,
   out string MatchData,
   out [Namespace].ParameterValue[] Parameters
   Member of [Namespace].ReportingService
The ID of the subscription.
[out] An ExtensionSettings object that contains a list of settings that are specific to the delivery extension.
[out] A meaningful description that is displayed to users.
[out] An ActiveState object that contains the active state of the subscription.
[out] The status of the subscription.
[out] The type of event that triggers the subscription.
[out] The data that is associated with the specified type of event. This is used by an event processing extension to match the subscription with an event that has fired.
[out] An array of ParameterValue[] objects that contains a list of parameters for the report.
Return Value

The user ID of the owner of the subscription.


Operation Description
Read Subscription Required for viewing the properties of a subscription.
Read Any Subscription Required for administrators or users who do not own the subscription to view the subscription properties.


To compile this code example, you must reference the Reporting Services WSDL and import certain namespaces. For more information, see Compiling and Running Code Examples. The following code example uses the GetSubscriptionProperties method to retrieve the properties of one of the subscriptions for the Product Catalog report, which is owned by the user myDomain\myUserName. The subscription is not data driven, so the code assumes that all the settings for the delivery extension are static parameter values (ParameterValue[] objects):

Imports System
Imports System.Web.Services.Protocols

Class Sample
    Public Shared Sub Main()
      Dim rs As New ReportingService()
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials
      Dim extSettings As ExtensionSettings
      Dim desc As String
      Dim active As ActiveState
      Dim status As String
      Dim eventType As String
      Dim matchData As String
      Dim values As ParameterValue() = Nothing
      Dim subscriptions As Subscription() = Nothing
      Dim extensionParams As ParameterValueOrFieldReference() = Nothing
         subscriptions = rs.ListSubscriptions("/SampleReports/Employee Sales Summary", "Domain\username")
         If Not (subscriptions Is Nothing) Then
            rs.GetSubscriptionProperties( _
               subscriptions(0).SubscriptionID, extSettings, desc, active, status, eventType, matchData, values)
            Console.WriteLine("Description: {0}", desc)
            Console.WriteLine("Status: {0}", status)
            Console.WriteLine("EventType: {0}", eventType)
            Console.WriteLine("matchData: {0}", matchData)
            Console.WriteLine("Extension: {0}", extSettings.Extension)
            extensionParams = extSettings.ParameterValues
            If Not (extensionParams Is Nothing) Then
               Dim extensionParam As ParameterValueOrFieldReference
               For Each extensionParam In extensionParams
                  Console.WriteLine( _
                     (CType(extensionParam, ParameterValue).Name + ": " + CType(extensionParam, ParameterValue).Value))
               Next extensionParam
            End If
            If Not (values Is Nothing) Then
               Dim pv As ParameterValue
               For Each pv In  values
                  Console.WriteLine("Name: {0}", pv.Name)
                  Console.WriteLine("Value: {0}", pv.Value)
               Next pv
            End If
         End If
      Catch e As SoapException
      End Try
   End Sub 'Main
End Class 'Sample

using System;
using System.Web.Services.Protocols;

class Sample
   public static void Main()
      ReportingService rs = new ReportingService();
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials;

      ExtensionSettings extSettings;
      string desc;
      ActiveState active;
      string status;
      string eventType;
      string matchData;
      ParameterValue[] values = null;
      Subscription[] subscriptions = null;
      ParameterValueOrFieldReference[] extensionParams = null;

         subscriptions = rs.ListSubscriptions( "/SampleReports/Employee Sales Summary", "Domain\\username" );

         if ( subscriptions != null )
               subscriptions[0].SubscriptionID, out extSettings, out desc, out active, 
               out status, out eventType, out matchData, out values );

            Console.WriteLine( "Description: {0}", desc );
            Console.WriteLine( "Status: {0}", status );
            Console.WriteLine( "EventType: {0}", eventType );
            Console.WriteLine( "matchData: {0}", matchData );
            Console.WriteLine( "Extension: {0}", extSettings.Extension );

            extensionParams = extSettings.ParameterValues;

            if (extensionParams != null)
               foreach (ParameterValueOrFieldReference extensionParam in extensionParams)
                  Console.WriteLine( ((ParameterValue)extensionParam).Name + ": " + ((ParameterValue)extensionParam).Value );

            if ( values != null )
               foreach ( ParameterValue pv in values )
                  Console.WriteLine( "Name: {0}", pv.Name );
                  Console.WriteLine( "Value: {0}", pv.Value );

      catch ( SoapException e )
         Console.WriteLine( e.Detail.InnerXml.ToString() ); 
See Also

ReportingService Class

Reporting Services Web Service Library

© 2015 Microsoft