ReportingService2005.GetSubscriptionProperties メソッド

指定したサブスクリプションのプロパティを返します。

名前空間:  ReportService2005
アセンブリ:  ReportService2005 (ReportService2005.dll)

構文

'宣言
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
'使用
Dim instance As ReportingService2005 
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

パラメーター

• SubscriptionID
  型: System.String
  サブスクリプションの ID です。

• ExtensionSettings
  型: ReportService2005.ExtensionSettings%
  [out] 配信拡張機能固有の設定の一覧を格納した ExtensionSettings オブジェクトです。

• Description
  型: System.String%
  [out] ユーザーに対して表示される説明文です。

• Active
  型: ReportService2005.ActiveState%
  [out] サブスクリプションのアクティブな状態を表す ActiveState オブジェクトです。

• Status
  型: System.String%
  [out] サブスクリプションの状態です。

• EventType
  型: System.String%
  [out] サブスクリプションを開始するイベントの種類です。

• MatchData
  型: System.String%
  [out] 指定した種類のイベントに関連付けられているデータです。 このパラメーターは、サブスクリプションと発生したイベントの照合のために、イベント処理拡張機能で使用されます。

• Parameters
  型: array<ReportService2005.ParameterValue[]%
  [out] レポートのパラメーターの一覧を表す ParameterValue オブジェクトの配列です。

戻り値

型: System.String
サブスクリプションの所有者のユーザー ID です。

説明

次の表に、この操作に関連するヘッダーおよび権限の情報を示します。

SOAP ヘッダー	(Out) ServerInfoHeaderValue
必要な権限	(レポートに対する ReadSubscription、およびユーザーがサブスクリプションの所有者であること)、または ReadAnySubscription

使用例

このコード例をコンパイルするには、Reporting Services の WSDL を参照し、特定の名前空間をインポートする必要があります。 詳細については、「Compiling and Running Code Examples」を参照してください。 次のコード例では、GetSubscriptionProperties メソッドを使用して、ユーザー myDomain\myUserName が所有する Product Catalog レポートの 1 つのサブスクリプションのプロパティを取得します。 サブスクリプションはデータ ドリブンでないため、このコードでは、配信拡張機能のすべての設定が静的なパラメーター値 (ParameterValue オブジェクト) であることを前提としています。

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() ); 
      }
   }
}

関連項目

参照

ReportingService2005 クラス

ReportService2005 名前空間