Share via


ReportingService2006.GetSubscriptionProperties Method

Returns the properties of a specified subscription.

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

Syntax

'Declaration
Public Function GetSubscriptionProperties ( _
    SubscriptionID As String, _
    <OutAttribute> ByRef ExtensionSettings As ExtensionSettings, _
    <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 ParameterValue() _
) As String
'Usage
Dim instance As ReportingService2006 
Dim SubscriptionID As String 
Dim ExtensionSettings As ExtensionSettings 
Dim Description As String 
Dim Active As ActiveState 
Dim Status As String 
Dim EventType As String 
Dim MatchData As String 
Dim Parameters As ParameterValue()
Dim returnValue As String 

returnValue = instance.GetSubscriptionProperties(SubscriptionID, _
    ExtensionSettings, Description, _
    Active, Status, EventType, MatchData, _
    Parameters)
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
)
public:
String^ GetSubscriptionProperties(
    String^ SubscriptionID, 
    [OutAttribute] ExtensionSettings^% ExtensionSettings, 
    [OutAttribute] String^% Description, 
    [OutAttribute] ActiveState^% Active, 
    [OutAttribute] String^% Status, 
    [OutAttribute] String^% EventType, 
    [OutAttribute] String^% MatchData, 
    [OutAttribute] array<ParameterValue^>^% Parameters
)
member GetSubscriptionProperties : 
        SubscriptionID:string * 
        ExtensionSettings:ExtensionSettings byref * 
        Description:string byref * 
        Active:ActiveState byref * 
        Status:string byref * 
        EventType:string byref * 
        MatchData:string byref * 
        Parameters:ParameterValue[] byref -> string
public function GetSubscriptionProperties(
    SubscriptionID : String, 
    ExtensionSettings : ExtensionSettings, 
    Description : String, 
    Active : ActiveState, 
    Status : String, 
    EventType : String, 
    MatchData : String, 
    Parameters : ParameterValue[]
) : 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 is used by an event processing extension to match the subscription with an event that has occurred.

Return Value

Type: System.String
The user ID for the owner of the subscription.

Remarks

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

SOAP Headers

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

Required Permissions

ManageAlerts OR (CreateAlerts AND the user is the subscription owner)

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Web;
using System.Web.Services;
using System.Web.Services.Protocols;

class Sample
{
    static void Main(string[] args)
    {
        ReportingService2006 rs = new ReportingService2006();
        rs.Url = "http://<Server Name>" +
            "/_vti_bin/ReportServer/ReportService2006.asmx";
        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.ListAllSubscriptions("http://<Server Name>");

            if (subscriptions != null)
            {
                rs.GetSubscriptionProperties(
                    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());
        }
    }
}
Imports System
Imports System.IO
Imports System.Text
Imports System.Web.Services
Imports System.Web.Services.Protocols

Class Sample

    Public Shared Sub Main()

        Dim rs As New ReportingService2006()
        rs.Url = "http://<Server Name>/_vti_bin/ReportServer/ReportService2006.asmx"
        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

        Try
            Dim site As String = "http://<Server Name>"

            subscriptions = rs.ListAllSubscriptions(site)

            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
            Console.WriteLine(e.Detail.InnerXml.ToString())
        End Try

    End Sub

End Class

See Also

Reference

ReportingService2006 Class

ReportService2006 Namespace