IsConnected (clsDataSource)

Analysis Services Programming

Analysis Services Programming

IsConnected (clsDataSource)

The IsConnected method of an object of ClassType clsDataSource verifies the connection to the data source specified by the ConnectionString property. If the data source is not connected, the method attempts to connect to the source.

Syntax

bRet = object.IsConnected(ErrorMsg As String)

bRet

A Boolean variable that receives the returned value: True is returned if the data source is connected, False if the connection cannot be established.

object

An object of ClassType clsDataSource.

ErrorMsg

An optional string variable that receives the error definition if the connection cannot be established.

Remarks

If the data source is already connected when the method is executed, the method returns True. If the data source is not connected, the method attempts to connect to the data source, returning True if the connection is established or False if the connection cannot be established.

It is not necessary to establish a connection to a data source before it can be used. Decision Support Objects (DSO) will automatically establish the connection when necessary (for example, to read a property value from the source database or to access data in the database).

Example

Use the following code to establish a connection to a data source with the IsConnected property:

'Assume an object (dsoDS) of ClassType clsDataSource exists 
If Not dsoDS.IsConnected Then
   ' Code to handle connection error
Else 
   ' Connection is established 
End If 

See Also

clsDataSource

ConnectionString