LOGIN Message

Login message is used to make a connection to the server. This is the first message that the client sends to the server.

Message syntax

LOGIN<s>version<s>userName<s>password[<s>clientType[<s>clientOS[<s>clientVersion]]]<end>

where

Parameter Type Required Description
version integer yes DSTP version that the client uses
userName string yes User name that is used to log in
password string yes Password of the user name
clientType integer no Type of the client application:
Value Description
0 Unknown. This is the default value.
1 Language Manager
2 Project Manager
3 Delphi
4 C++Builder
5 Java
6 Visual basic
7 WFC
clientOS integer no Type of the client operating system:
Value Description
0 Windows. This is the default value.
1 Java
2 Linux
clientVersion string no The client version. This can be any string value excluding the space character.
<s> = Char(127)
<end> = Char(0)

Reply syntax

resultCode<s>userType<end>

where

Parameter Type Description
resultCode integer
OK The client was succesfully connected to the server.
ACCESS_ERROR Invalid user name or password.
INVALID_VERSION The server does not support the DSTP version.
TOO_MANY_CONNECTIONS The maximum amount of client connections was exceeded.
ERROR An unspecified error.
userType integer User type of the user. This is sent only if the result is OK.
Value Description
0 No access rights to the server
1 User access
2 Author access
3 Administrator access
<s> = Char(127)
<end> = Char(0)

Example

The following string makes a connection to the server using the test user name.

-> LOGIN<s>10<s>test<s>test123<s>3<s>4.0<s>0<s>1252<end>
<- 0<s>1<end>

where

<s> = Char(127)
<end> = Char(0)

See also

LOGOUT