ReportingService2005.GetExtensionSettings Method

Article
12/03/2008

Returns a list of settings for a given extension.

Namespace: Microsoft.WSSUX.ReportingServicesWebService.RSManagementService2005
Assembly: ReportService2005 (in reportingservice2005.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetExtensionSettings", 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 GetExtensionSettings ( _
    Extension As String _
) As ExtensionParameter()

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetExtensionSettings", 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 ExtensionParameter[] GetExtensionSettings (
    string Extension
)

[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetExtensionSettings", 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:
array<ExtensionParameter^>^ GetExtensionSettings (
    String^ Extension
)

/** @attribute SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetExtensionSettings", 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) */ 
/** @attribute SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) */ 
public ExtensionParameter[] GetExtensionSettings (
    String Extension
)

SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetExtensionSettings", 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 GetExtensionSettings (
    Extension : String
) : ExtensionParameter[]

Parameters

Extension
The name of the extension as it appears in the report server configuration file. Valid values are Report Server Email and Report Server FileShare.

Return Value

An array of ExtensionParameter objects that represents the list of known settings for a given extension.

Remarks

If the extension does not support any extension parameters, an empty list is returned.

Note

Currently, the GetExtensionSettings method supports delivery extensions. Other extensions are not yet supported by this method.

Example

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 retrieves information about the settings of the report server e-mail delivery extension:

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 extensionParams As ExtensionParameter() = Nothing

      Try
         extensionParams = rs.GetExtensionSettings("Report Server Email")

         Console.WriteLine("Settings retrieved.")

         If Not (extensionParams Is Nothing) Then
            Dim extensionParam As ExtensionParameter
            For Each extensionParam In  extensionParams
               Console.WriteLine("Value: {0}", extensionParam.Value)
               Console.WriteLine("Name: {0}", extensionParam.Name)
               Console.WriteLine("ReadOnly: {0}", extensionParam.ReadOnly)
               Console.WriteLine("Required: {0}", extensionParam.Required)
            Next extensionParam
         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;

      ExtensionParameter[] extensionParams = null;

      try
      {
         extensionParams = rs.GetExtensionSettings("Report Server Email");

         Console.WriteLine("Settings retrieved.");

         if (extensionParams != null)
         {
            foreach (ExtensionParameter extensionParam in extensionParams)
            {
               Console.WriteLine("Value: {0}", extensionParam.Value);
               Console.WriteLine("Name: {0}", extensionParam.Name);
               Console.WriteLine("ReadOnly: {0}", extensionParam.ReadOnly);
               Console.WriteLine("Required: {0}", extensionParam.Required);
            }
         }
      }

      catch (SoapException e)
      {
         Console.WriteLine(e.Detail.InnerXml.ToString());
      }
   }
}

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