Client :: sendMessage - Send message to one or all clients

The function sends a message to one or all clients. Depending on the client type the message is displayed on the console (console applications) or in a message box.

The message text displayed, e.g. in a message box, can be passed in sMessageText. A title, which will be displayed in message boxes, only, can be passed in sMessageTitle. The eMessageType option describes the appearance of the message box (information, error etc.).

When the client handle is not valid, the function throws an exception.

Implementation overview

Send message to all clients
Client :: sendMessage ( sMessageText, sMessageTitle, eMessageType )
Send message to single client
Client :: sendMessage ( iClientId, sMessageText, sMessageTitle, eMessageType )

Implementation details

Send message to all clients
Client :: sendMessage ( odaba::String &sMessageText, odaba::String &sMessageTitle, odaba::MessageTypes eMessageType )

The function will send the message to all clients. When the client handle is not valid, the function throws an exception.
- sMessageText - Message Text
  The message text is the text to be displayed in the message or decision. It may contain up to 500 characters.
- sMessageTitle - Message Title
  When displaying the message in a dialog box the message title will be displayed in the title bar. The message title should refer in some way to the application the message applies on.
- eMessageType - Message type

to list

Send message to single client
Client :: sendMessage ( int32 iClientId, odaba::String &sMessageText, odaba::String &sMessageTitle, odaba::MessageTypes eMessageType )

The function sends a message to a single client with the client number (identification) passed in iClientID. iClientID is the connection identifier returned from the server to the client after connecting (connectionID() property). The number for the clients are shown in the ShowClients command.
- iClientId - Client session number
  The client number is an internal number the server has assigned to the client while connecting. You can retrieve client numbers by using the GetClientHandle() function which returns client information for all active clients.
- sMessageText - Message Text
  The message text is the text to be displayed in the message or decision. It may contain up to 500 characters.
- sMessageTitle - Message Title
  When displaying the message in a dialog box the message title will be displayed in the title bar. The message title should refer in some way to the application the message applies on.
- eMessageType - Message type

to list

to top Comment