ConnectAsync Method

In This Topic

Creates a client for the Report Server using the provided authentication and other options. Before returning the client instance, the server connection and version is checked.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Shared Function ConnectAsync( _
   ByVal baseUrl As String, _
   ByVal options As ClientOptions _
) As Task(Of IReportServerClient)

public static Task<IReportServerClient> ConnectAsync( 
   string baseUrl,
   ClientOptions options
)

public:
static Task<IReportServerClient^>^ ConnectAsync( 
   String^ baseUrl,
   ClientOptions^ options
)

Parameters

baseUrl
options

Exceptions

Exception	Description
System.ArgumentNullException	The exception that is thrown when a null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
InvalidCredentialsException	Thrown when the login data is wrong. The (localized) error message can be displayed to the user.
GenericReportServerException	Thrown for unexpected errors on the server. The (localized) error message can be displayed to the user. The error message will only include technical details if the debug mode on the server is enabled.
GenericHttpRequestException	Thrown for generic HTTP errors which are not related to combit Report Server, e.g. network errors, proxy errors, ...
ReportServerNotAvailableException	Thrown when the application pool of the Report Server is stopped or the REST API is not enabled (see the advanced settings page in the management area of the Report Server).

Requirements

Platforms: Windows 10 (Version 21H2 - 23H2), Windows 11 (21H2 - 22H2), Windows Server 2016 - 2022
.NET: .NET Framework 4.8, .NET 6, .NET 7, .NET 8

Reference

ReportServer Class
ReportServer Members

Send Feedback