ReportingService2010.ValidateExtensionSettings Method

Validates Reporting Services extension settings.

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

Syntax

'Declaration
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/ValidateExtensionSettings", RequestNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",  _
    ResponseNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function ValidateExtensionSettings ( _
    Extension As String, _
    ParameterValues As ParameterValueOrFieldReference(), _
    SiteUrl As String _
) As ExtensionParameter()
'Usage
Dim instance As ReportingService2010 
Dim Extension As String 
Dim ParameterValues As ParameterValueOrFieldReference()
Dim SiteUrl As String 
Dim returnValue As ExtensionParameter()

returnValue = instance.ValidateExtensionSettings(Extension, _
    ParameterValues, SiteUrl)
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/ValidateExtensionSettings", RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public ExtensionParameter[] ValidateExtensionSettings(
    string Extension,
    ParameterValueOrFieldReference[] ParameterValues,
    string SiteUrl
)
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/ValidateExtensionSettings", RequestNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
public:
array<ExtensionParameter^>^ ValidateExtensionSettings(
    String^ Extension, 
    array<ParameterValueOrFieldReference^>^ ParameterValues, 
    String^ SiteUrl
)
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/ValidateExtensionSettings", RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
member ValidateExtensionSettings : 
        Extension:string * 
        ParameterValues:ParameterValueOrFieldReference[] * 
        SiteUrl:string -> ExtensionParameter[] 
public function ValidateExtensionSettings(
    Extension : String, 
    ParameterValues : ParameterValueOrFieldReference[], 
    SiteUrl : String
) : 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.
  • SiteUrl
    Type: System.String
    The fully qualified URL for the SharePoint site. Set this parameter to nulla null reference (Nothing in Visual Basic) (Nothing in Visual Basic) when invoking this method in Native mode.

Return Value

Type: array<ReportService2010.ExtensionParameter[]
An array of ExtensionParameter objects that contain validated extension settings and any required settings that were not specified.

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

This method throws an rsUnsupportedParameterForModeException exception if a non-null value is specified for the SiteUrl parameter in Native mode.

The ExtensionParameter objects that are returned by the ValidateExtensionSettings method contain the following items:

  • All valid setting values specified in the ParameterValues parameter.

  • Settings with values that are not valid contain an error message (Error property of the ExtensionParameter class).

  • The names of all required settings that were not specified in the ParameterValues parameter with the Required property of a ExtensionParameter class set to a value of true.

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

See Also

Reference

ReportingService2010 Class

ReportService2010 Namespace