Export (0) Print
Expand All

ReportingService2010.ValidateExtensionSettings Method (String, ParameterValueOrFieldReference[], String)

 

Applies To: SQL Server 2016 Preview

Validates Reporting Services extension settings.

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

[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/ValidateExtensionSettings",
    RequestNamespace = "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    ResponseNamespace = "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
member 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.

ParameterValues
Type: ReportService2010.ParameterValueOrFieldReference[]

An array of ParameterValueOrFieldReference objects representing the settings to validate for the extension.

SiteUrl
Type: System.String

The fully qualified URL for the SharePoint site.

Set this parameter to null (Nothing in Visual Basic) when invoking this method in Native mode.

Return Value

Type: ReportService2010.ExtensionParameter[]

An array of ExtensionParameter objects that contain validated extension settings and any required settings that were not specified.

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.

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft