ReportingService2006.GetSubscriptionProperties Method

Artigo
12/03/2008

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

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
)

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

Parameters
[out] An array of ParameterValue objects that contains a list of parameters for the report.

Return Value

The user ID for the owner of the subscription.

Example

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

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

Target Platforms

Windows 98, Windows 2000, Windows 2000 Server, Windows CE, Windows Server 2008, Windows 98 Second Edition, Pocket PC, Smart Phone, Windows Server 2003, Windows XP Professional with Service Pack 2 (SP2), Windows 2000 Professional, Windows 2000 Advanced Server, Windows XP Home Edition, For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005., Windows Vista, Windows Mobile 5.0, Windows Mobile 2003 for Pocket PC, Windows CE 5.0

Partilhar via