TM1SystemServerConnect

Purpose

Connects a client to a server. Use this function to start a TM1® session if your IBM® Cognos® TM1 Server is configured for standard TM1 authentication or LDAP authentication. Use TM1SystemServerConnectIntegratedLogin if it is configured for Integrated Login.

Definition

Declare Function TM1SystemServerConnect
Lib "tm1api.dll" (ByVal hPool As Long, 
ByVal sDatabase As Long,
ByVal sClient As Long, 
ByVal sPassword As Long) As Long 

Parameters

hPool is a long. This TM1 value capsule contains a pool handle. The pool handle is returned by the function TM1ValPoolCreate.

sDatabase is a long. This TM1 value capsule contains a string value containing the name of the server.

sClient is a long. This TM1 value capsule contains a string value containing the name of the client.

sPassword is a long. This TM1 value capsule contains a string value containing the password.

Result

The function returns a handle to the server. This function is part of the API initialization sequence required by every TM1 API program. For more information, see Connecting to the API.

Errors

TM1ErrorSystemServerNotFound

TM1ErrorSystemServerConnectionFailed

TM1ErrorSystemServerClientAlready
Connected

TM1ErrorSystemServerClientNotFound 

TM1ErrorSystemServerClientPasswordInvalid

TM1ErrorSystemServerClientPasswordExpired

TM1ErrorSystemServerClientExceedMax
LogonNumber

TM1ErrorClientMaximumPortsExceeded

See Also

TM1SystemOpen

TM1SystemServerDisconnect