ReportingService2010.TestConnectForItemDataSource Method

Tests the connection for a data source. This method supports the testing of published data sources that are used by reports or models and shared data sources. This method applies to the Report, Model, and Dataset item types.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/TestConnectForItemDataSource", 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)> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
Public Function TestConnectForItemDataSource ( _
    ItemPath As String, _
    DataSourceName As String, _
    UserName As String, _
    Password As String, _
    <OutAttribute> ByRef ConnectError As String _
) As Boolean
'Usage
Dim instance As ReportingService2010
Dim ItemPath As String
Dim DataSourceName As String
Dim UserName As String
Dim Password As String
Dim ConnectError As String
Dim returnValue As Boolean

returnValue = instance.TestConnectForItemDataSource(ItemPath, _
    DataSourceName, UserName, Password, _
    ConnectError)
[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/TestConnectForItemDataSource", 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)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
public bool TestConnectForItemDataSource(
    string ItemPath,
    string DataSourceName,
    string UserName,
    string Password,
    out string ConnectError
)
[SoapDocumentMethodAttribute(L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/TestConnectForItemDataSource", RequestNamespace = L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = L"http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
public:
bool TestConnectForItemDataSource(
    String^ ItemPath, 
    String^ DataSourceName, 
    String^ UserName, 
    String^ Password, 
    [OutAttribute] String^% ConnectError
)
[<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/TestConnectForItemDataSource", 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)>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
member TestConnectForItemDataSource : 
        ItemPath:string * 
        DataSourceName:string * 
        UserName:string * 
        Password:string * 
        ConnectError:string byref -> bool 
public function TestConnectForItemDataSource(
    ItemPath : String, 
    DataSourceName : String, 
    UserName : String, 
    Password : String, 
    ConnectError : String
) : boolean

Parameters

  • ItemPath
    Type: System.String
    The fully qualified URL of the item to which the DataSourceName applies, including the file name and, in SharePoint mode, the extension. The item can be a shared data source, a report, or a report model.
  • DataSourceName
    Type: System.String
    The name of the data source for the item.
  • 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.

Return Value

Type: System.Boolean
A string that contains a detailed error message. The string is returned as the out parameter, ConnectError.
A Boolean the indicates whether the connection completed successfully.

Remarks

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

SOAP Header Usage

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

Native Mode Required Permissions

Depends on the item type:

SharePoint Mode Required Permissions

Depends on the item type:

  • Report, DataSet: OpenItems() on ItemPath

  • Report using a model or a shared datasource: OpenItems() on DataSourceName

  • DataSource: OpenItems()

  • Model: OpenItems()

If DataSourceName points to an XML data source, this method does nothing and returns true.