ReportingService2010.TestConnectForDataSourceDefinition Method (DataSourceDefinition, String, String, String)

Article
07/27/2015

Applies To: SQL Server 2016 Preview

Tests the connection for a data source. This method supports the direct testing of the data source.

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

Syntax

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/TestConnectForDataSourceDefinition", 
    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)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
public bool TestConnectForDataSourceDefinition(
    DataSourceDefinition DataSourceDefinition,
    string UserName,
    string Password,
    out string ConnectError
)

public:
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/TestConnectForDataSourceDefinition", 
    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)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
bool TestConnectForDataSourceDefinition(
    DataSourceDefinition^ DataSourceDefinition,
    String^ UserName,
    String^ Password,
    [OutAttribute] String^% ConnectError
)

[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/TestConnectForDataSourceDefinition",
    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)>]
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member TestConnectForDataSourceDefinition : 
        DataSourceDefinition:DataSourceDefinition *
        UserName:string *
        Password:string *
        ConnectError:string byref -> bool

<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/TestConnectForDataSourceDefinition",
    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)>
<SoapHeaderAttribute("TrustedUserHeaderValue")>
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)>
Public Function TestConnectForDataSourceDefinition (
    DataSourceDefinition As DataSourceDefinition,
    UserName As String,
    Password As String,
    <OutAttribute> ByRef ConnectError As String
) As Boolean

Parameters

DataSourceDefinition
Type: ReportService2010.DataSourceDefinition

The data source definition that defines the connection to the data source.

UserName
Type: System.String

The user name to use to test the connection.UserName is used with data sources that prompt for credentials.

Password
Type: System.String

The password to use to test the connection.Password is used with data sources that prompt for credentials.

ConnectError
Type: System.String

A detailed error message. The message is returned when the connection fails. The data source provider provides the detailed message.