Release connection to the MVSP server
Namespace: rocketsoftware.MVSP
Assembly: RocketMVSP (in RocketMVSP.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Function ReleaseConnection( _ ByRef MvspPick As Pick, _ ByRef nStatusCode As Integer, _ ByRef sStatusMessage As String _ ) As Boolean |
| C# |
|---|
| public bool ReleaseConnection( ref Pick MvspPick, ref int nStatusCode, ref string sStatusMessage ) |
| C++ |
|---|
| public: bool ReleaseConnection( Pick% MvspPick, int% nStatusCode, String% sStatusMessage ) sealed |
| J# |
|---|
| public bool ReleaseConnection( Pick MvspPick, int nStatusCode, string sStatusMessage ) |
| JScript |
|---|
| public
function ReleaseConnection( MvspPick : Pick, nStatusCode : int, sStatusMessage : String ) : bool |
Parameters
- MvspPick
- rocketsoftware.MVSP.Pick object for connection the MVSP server to release
- nStatusCode
- Integer returned containing the error status code
- sStatusMessage
- String returned containing the error status message
Return Value
True if successful in releasing connection
Remarks
The rocketsoftware.MVSP.Pick object for the connection is not closed, but stored in the pool.
If the connection is not currently logged on to the account of account name property,
the connection will be logged to the account of the account name property.
The connection becomes available in the pool and can be reused by calling the GetConnection method.
If a user licensed connection is being released from when the pool was disabled (maximum capacity = 0),
then the connection is closed on the MVSP server and not returned to the connection pool.