Share via

  • Article

AdomdConnection.SessionID Property

Gets or sets the string identifier of the session that the AdomdConnection opened with the server.

Namespace:  Microsoft.AnalysisServices.AdomdClient
Assembly:  Microsoft.AnalysisServices.AdomdClient (in Microsoft.AnalysisServices.AdomdClient.dll)

Syntax

'Declaration
Public Property SessionID As String
    Get
    Set
'Usage
Dim instance As AdomdConnection
Dim value As String

value = instance.SessionID

instance.SessionID = value

public string SessionID { get; set; }

public:
property String^ SessionID {
    String^ get ();
    void set (String^ value);
}

member SessionID : string with get, set

function get SessionID () : String
function set SessionID (value : String)

Property Value

Type: System.String
A string that contains a string identifier that represents the unique ID of a session.

Exceptions

Exception Condition
System.InvalidOperationException

The session ID was set after the connection was opened.

Remarks

The value of this property can only be set before the connection is opened.

Each session has a unique ID for connection purposes. You can use this property, along with the Open and Close methods, to pool sessions. Because an AdomdConnection can be destroyed without destroying the session, the session ID can be used to maintain state by reconnecting to a specific active session.