Get connection to the MVSP server
Namespace: rocketsoftware.MVSP
Assembly: RocketMVSP (in RocketMVSP.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Function GetConnection( _ ByRef MvspPick As Pick, _ ByRef nStatusCode As Integer, _ ByRef sStatusMessage As String _ ) As Boolean |
| C# |
|---|
| public bool GetConnection( ref Pick MvspPick, ref int nStatusCode, ref string sStatusMessage ) |
| C++ |
|---|
| public: bool GetConnection( Pick% MvspPick, int% nStatusCode, String% sStatusMessage ) sealed |
| J# |
|---|
| public bool GetConnection( Pick MvspPick, int nStatusCode, string sStatusMessage ) |
| JScript |
|---|
| public
function GetConnection( MvspPick : Pick, nStatusCode : int, sStatusMessage : String ) : bool |
Parameters
- MvspPick
- rocketsoftware.MVSP.Pick object returned that is connected to the MVSP server
- nStatusCode
- Integer returned containing the error status code
- sStatusMessage
- String returned containing the error status message
Return Value
True if successful in getting connection
Remarks
If available rocketsoftware.MVSP.Pick object exists in pool, return it
If no available rocketsoftware.MVSP.Pick object exists in pool and pool not full,
create a new connection to the MVSP server and add it to the pool.
If no available rocketsoftware.MVSP.Pick object exists in pool and pool is full,
wait for connection to the MVSP server to become available from the pool.
The maximum wait time property specifies the amount of time to wait for available connection.
If the connection pool is disabled (maximum capacity = 0) or the server doesn't support
connection pooling, then it creates a new user licensed connection to the MVSP server and doesn't use the pool.