Export (0) Print
Expand All
Expand Minimize

ReportingService2005.GetSubscriptionProperties Method

SQL Server 2005

Returns the properties of a specified subscription.

Namespace: Microsoft.WSSUX.ReportingServicesWebService.RSManagementService2005
Assembly: ReportService2005 (in reportingservice2005.dll)

[SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out)] 
[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetSubscriptionProperties", RequestNamespace="http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace="http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
public string GetSubscriptionProperties (
	string SubscriptionID,
	out ExtensionSettings ExtensionSettings,
	out string Description,
	out ActiveState Active,
	out string Status,
	out string EventType,
	out string MatchData,
	out ParameterValue[] Parameters
)
/** @attribute SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) */ 
/** @attribute SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetSubscriptionProperties", RequestNamespace="http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace="http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped) */ 
public String GetSubscriptionProperties (
	String SubscriptionID, 
	/** @attribute OutAttribute() */ /** @ref */ ExtensionSettings ExtensionSettings, 
	/** @attribute OutAttribute() */ /** @ref */ String Description, 
	/** @attribute OutAttribute() */ /** @ref */ ActiveState Active, 
	/** @attribute OutAttribute() */ /** @ref */ String Status, 
	/** @attribute OutAttribute() */ /** @ref */ String EventType, 
	/** @attribute OutAttribute() */ /** @ref */ String MatchData, 
	/** @attribute OutAttribute() */ /** @ref */ ParameterValue[] Parameters
)
JScript does not support passing value-type arguments by reference.

Parameters

SubscriptionID

The ID of the subscription.

ExtensionSettings

[out] An ExtensionSettings object that contains a list of settings that are specific to the delivery extension.

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 is used by an event processing extension 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

The user ID of the owner of the subscription.

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

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

class Sample
{
   public static void Main()
   {
      ReportingService2005 rs = new ReportingService2005();
      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;

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

         if ( subscriptions != null )
         {
            rs.GetSubscriptionProperties( subscriptions[0].SubscriptionID, name, 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() ); 
      }
   }
}

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.

Development Platforms

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

Target Platforms

Community Additions

ADD
Show:
© 2014 Microsoft