ReportingService2010.GetExtensionSettings(String) ReportingService2010.GetExtensionSettings(String) ReportingService2010.GetExtensionSettings(String) Method

Definition

Returns a list of settings for a given extension.

public:
 cli::array <ReportService2010::ExtensionParameter ^> ^ GetExtensionSettings(System::String ^ Extension);
[System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/GetExtensionSettings", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)]
[System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")]
[System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)]
public ReportService2010.ExtensionParameter[] GetExtensionSettings (string Extension);
Public Function GetExtensionSettings (Extension As String) As ExtensionParameter()
Parameters
Extension
String String String

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

Returns

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

Examples

using System;  
using System.Collections.Generic;  
using System.IO;  
using System.Text;  
using System.Web;  
using System.Web.Services;  
using System.Web.Services.Protocols;  

class Sample  
{  
    static void Main(string[] args)  
    {  
        ReportingService2010 rs = new ReportingService2010();  
        rs.Url = "http://<Server Name>" +   
            "/_vti_bin/ReportServer/ReportService2010.asmx";  
        rs.Credentials =   
            System.Net.CredentialCache.DefaultCredentials;  

        ExtensionParameter[] extensionParams = null;  

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

            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());  
        }  
    }  
}  
Imports System  
Imports System.IO  
Imports System.Text  
Imports System.Web.Services  
Imports System.Web.Services.Protocols  

Class Sample  

    Public Shared Sub Main()  

        Dim rs As New ReportingService2010()  
        rs.Url = "http://<Server Name>" + _  
            "/_vti_bin/ReportServer/ReportService2010.asmx"  
        rs.Credentials = _  
            System.Net.CredentialCache.DefaultCredentials  

        Dim extensionParams As ExtensionParameter() = Nothing  

        Try  
            extensionParams = _  
                rs.GetExtensionSettings("Report Server " + _  
                    "DocumentLibrary")  

            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  

End Class  

Remarks

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

SOAP Header Usage (In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue
Native Mode Required Permissions None
SharePoint Mode Required Permissions None

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.

Applies to