LoginConnectionId - cConnection

Attempts to log in the connection identified by the passed connection ID

Type: Function

Return Data Type: Integer

Parameters: String sId

ParameterDescription
sIdConnection ID


Return Value

Status: 0 = Success, 1 = Failed


Syntax
Function LoginConnectionId String sId Returns Integer

Call: Get LoginConnectionId sId to IntegerVariable


Description

LoginConnectionId attempts to log in the connection identified by the passed connection ID.

If the connection is already logged in (IsConnectionIdLoggedIn), the login can be skipped (pbSkipDuplicateLogin). It performs the login by calling LoginConnectIdBase.

It returns success or failure. An error status is returned (see piErrorNumber, piErrorLine and psErrorText).