company logo

Client :: connectionId - Connection identifier property

When running in client server mode, the property contains the connection number assigned to the connection by the server. The connection number is used in order to identify running clients. It will be displayed in the ShowClients command and has to be passed in order to submit client actions (e.g. KillClient).

When no server connection has been established, the connection identifier is 0. When running in local mode, the function returns 1.

When passing an invalid client handle, the function throws an exception.

  if ( myClient.connectionID() == 1 )

    printf("I am a local client");

Return value:  Server connection identifier ( int32  )

The server connection identifier is a number that allows referring to a server connection established in another session.

Implementation details

int32 Client  :: connectionId (  )