ReportingService2005.GetSubscriptionProperties(String, ExtensionSettings, String, ActiveState, String, String, String, ParameterValue[]) Method

Definition

返回指定订阅的属性。Returns the properties of a specified subscription.

public:
 System::String ^ GetSubscriptionProperties(System::String ^ SubscriptionID, [Runtime::InteropServices::Out] ReportService2005::ExtensionSettings ^ % ExtensionSettings, [Runtime::InteropServices::Out] System::String ^ % Description, [Runtime::InteropServices::Out] ReportService2005::ActiveState ^ % Active, [Runtime::InteropServices::Out] System::String ^ % Status, [Runtime::InteropServices::Out] System::String ^ % EventType, [Runtime::InteropServices::Out] System::String ^ % MatchData, [Runtime::InteropServices::Out] cli::array <ReportService2005::ParameterValue ^> ^ % Parameters);
public string GetSubscriptionProperties (string SubscriptionID, out ReportService2005.ExtensionSettings ExtensionSettings, out string Description, out ReportService2005.ActiveState Active, out string Status, out string EventType, out string MatchData, out ReportService2005.ParameterValue[] Parameters);
member this.GetSubscriptionProperties : string * ExtensionSettings * string * ActiveState * string * string * string * ParameterValue[] -> string
Public Function GetSubscriptionProperties (SubscriptionID As String, ByRef ExtensionSettings As ExtensionSettings, ByRef Description As String, ByRef Active As ActiveState, ByRef Status As String, ByRef EventType As String, ByRef MatchData As String, ByRef Parameters As ParameterValue()) As String

Parameters

SubscriptionID
String

订阅 ID。The ID of the subscription.

ExtensionSettings
ExtensionSettings

[out] 一个 ExtensionSettings 对象,该对象包含特定于传递扩展插件的设置列表。[out] An ExtensionSettings object that contains a list of settings that are specific to the delivery extension.

Description
String

[out] 向用户显示的贴切描述。[out] A meaningful description that is displayed to users.

Active
ActiveState

[out] 一个包含订阅的活动状态的 ActiveState 对象。[out] An ActiveState object that contains the active state of the subscription.

Status
String

[out] 订阅的状态。[out] The status of the subscription.

EventType
String

[out] 触发订阅的事件的类型。[out] The type of event that triggers the subscription.

MatchData
String

[out] 与指定类型的事件关联的数据。[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
ParameterValue[]

[out] ParameterValue 对象的数组,它包含用于报表的参数的列表。[out] An array of ParameterValue objects that contains a list of parameters for the report.

Returns

String

订阅所有者的用户 ID。The user ID of the owner of the subscription.

Examples

若要编译此代码示例,必须引用 Reporting Services WSDL 并导入某些命名空间。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. 下面的代码示例使用 GetSubscriptionProperties 方法检索产品目录报表的某个订阅的属性,该订阅由用户 myDomain\myUserName 拥有。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. 订阅不是数据驱动的,因此该代码假定传递扩展插件的所有设置都是静态参数值 (ParameterValue 对象) :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 ReportingService2005()  
      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  
         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  
         Console.WriteLine(e.Detail.InnerXml.ToString())  
      End Try  
   End Sub 'Main  
End Class 'Sample  
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() );   
      }  
   }  
}  

Remarks

下表显示了有关此操作的标头和权限信息。The table below shows header and permissions information on this operation.

SOAP 标头SOAP Headers (Out) ServerInfoHeaderValue(Out) ServerInfoHeaderValue
所需的权限Required Permissions (ReadSubscription 报表上,并且用户是订阅所有者) 或 ReadAnySubscription(ReadSubscription on the report AND the user is the subscription owner) OR ReadAnySubscription

Applies to