Verastream Host Integrator .Net Reference

HostIntegratorSession.ConnectToSession Method (String, String, String, String, IDictionary)

Establishes a connection to a Host Integrator server and creates or allocates a host session with the specified session pool. This version of ConnectToSession presents a user ID and a password, to establish authorization on the Host Integrator server, and also provides a set of model variables, to set upon connection.

[Visual Basic]
Overloads Public Sub ConnectToSession( _
   ByVal server As String, _
   ByVal sessionPool As String, _
   ByVal userID As String, _
   ByVal password As String, _
   ByVal modelVariables As IDictionary _
)
[C#]
public void ConnectToSession(
   string server,
   string sessionPool,
   string userID,
   string password,
   IDictionary modelVariables
);

Parameters

server
Specifies the name of the Host Integrator server. This value can be a DNS name or an IP address.
sessionPool
Specifies a Host Integrator session pool.
userID
Specifies a user ID to present to the Host Integrator server.
password
Specifies a password to present to the Host Integrator server.
modelVariables
Specifies model variables to set on connection.

Remarks

Reasons for failure include:

Exceptions

Exception TypeCondition
HostIntegratorConnectorExceptionThrown if already connected
HostIntegratorChannelExceptionThrown if the client connection attempt fails
HostIntegratorTimeoutExceptionThrown if the client connection times out waiting for a response from the VHI server
HostIntegratorServerExceptionThrown if the server refuses a client connection attempt
HostIntegratorServerExceptionThrown if the requested model or session is not available
HostIntegratorServerExceptionThrown if the host connection does not succeed

See Also

HostIntegratorSession Class | HostIntegratorSession Members | WRQ.Verastream.HostIntegrator Namespace | HostIntegratorSession.ConnectToSession Overload List