Open pool for connections to MVSP server


Namespace: rocketsoftware.MVSP
Assembly: RocketMVSP (in RocketMVSP.dll)

Syntax

Visual Basic (Declaration)
Public Function OpenPool( _ 
   ByRef ConnectProperties As ConnectProperties,  _ 
   ByVal sAcctName As String,  _ 
   ByVal sAcctPassword As String,  _ 
   Optional ByVal nMinCapacity As Integer = 0,  _ 
   Optional ByVal nMaxCapacity As Integer = 0 _ 
) As Boolean
C#
public bool OpenPool(
   ref ConnectProperties ConnectProperties,
   string sAcctName,
   string sAcctPassword,
   [OptionalAttribute] int nMinCapacity,
   [OptionalAttribute] int nMaxCapacity
)
C++
public:
 bool OpenPool(
   ConnectProperties% ConnectProperties,
   String sAcctName,
   String sAcctPassword,
   [OptionalAttribute] int nMinCapacity,
   [OptionalAttribute] int nMaxCapacity
) sealed 
J#
public bool OpenPool(
   ConnectProperties ConnectProperties,
   string sAcctName,
   string sAcctPassword,
   /** @attribute OptionalAttribute() */ int nMinCapacity,
   /** @attribute OptionalAttribute() */ int nMaxCapacity
)
JScript
public  function OpenPool(
   ConnectProperties : ConnectProperties,
   sAcctName : String,
   sAcctPassword : String,
   OptionalAttribute nMinCapacity : int,
   OptionalAttribute nMaxCapacity : int
) : bool

Parameters

ConnectProperties
Object containing the properties for connecting to the MVSP server.
sAcctName
sAcctPassword
nMinCapacity
Integer containing the minimum number of connections to MVSP server in pool
nMaxCapacity
Integer containing the maximum number of connections to MVSP server in pool

Return Value

True if pool successfully opened

Remarks

Sets StatusMessage and StatusCode properties
Can only open the pool when it is not already opened.
When opening the pool, we specify the parameters for connecting the MVSP server.
All connections in the pool are connected to the same MVSP server.
If a minimum capacity is specified, the minimum number of connections to the MVSP server will be automatically established.
If no minimum capacity is specified, connecting to the MVSP server doesn't occur when opening the pool, but when calling the GetConnection method.

See Also