ReportingService2005.GetExtensionSettings Method (String)

Applies To: SQL Server 2016 Preview

Returns a list of settings for a given extension.

Namespace:   ReportService2005
Assembly:  ReportService2005 (in ReportService2005.dll)

Syntax

public ExtensionParameter[] GetExtensionSettings(
    string Extension
)

public:
array<ExtensionParameter^>^ GetExtensionSettings(
    String^ Extension
)

member GetExtensionSettings : 
        Extension:string -> ExtensionParameter[]

Public Function GetExtensionSettings (
    Extension As String
) As ExtensionParameter()

Parameters

• Extension
  Type: System.String

  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

Type: ReportService2005.ExtensionParameter[]

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

Remarks

The table below shows header and permissions information on this operation.

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

Examples

Legacy Code Example

To compile this code example, you must reference the Reporting Services WSDL and import certain namespaces. For more information, see . The following code example retrieves information about the settings of the report server e-mail delivery extension:Unable to find linked topic '317946aa-8e95-4f0b-8170-394c9d5e184e'.

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

See Also

ReportingService2005 Class
ReportService2005 Namespace

Return to top