ReportingService2005.GetSubscriptionProperties Method
Returns the properties of a specified subscription.
Namespace: ReportService2005
Assembly: ReportService2005 (in ReportService2005.dll)
Syntax
'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetSubscriptionProperties", RequestNamespace := "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", _
ResponseNamespace := "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", _
Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
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 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)
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetSubscriptionProperties", RequestNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",
ResponseNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",
Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
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
)
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetSubscriptionProperties", RequestNamespace = L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",
ResponseNamespace = L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",
Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
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
)
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetSubscriptionProperties", RequestNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",
ResponseNamespace = "https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",
Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
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
- SubscriptionID
Type: System.String
The ID of the subscription.
- ExtensionSettings
Type: ReportService2005.ExtensionSettings%
[out] An ExtensionSettings object that contains a list of settings that are specific to the delivery extension.
- Description
Type: System.String%
[out] A meaningful description that is displayed to users.
- Active
Type: ReportService2005.ActiveState%
[out] An ActiveState object that contains the active state of the subscription.
- 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 fired.
- Parameters
Type: array<ReportService2005.ParameterValue[]%
[out] An array of ParameterValue objects that contains a list of parameters for the report.
Return Value
Type: System.String
The user ID of the owner of the subscription.
Examples
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):
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() );
}
}
}
See Also