company logo

ODABAClient :: SendClientMessage - 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 as message box.

The message is sent to the client addressed via the client_id. If no client_id is passed (UNDEF) the message is send to all clients except the sending one.

Return value:  Success ( logical  )

Implementation details

logical ODABAClient  :: SendClientMessage ( int32 client_id, NString &mtext, NString &mtitle=NString::Null(), char mtype=0 )
  • client_id - 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.

  • mtext - Message text

    The message text may contain up to 500 characters and must be 0-terminated.

  • mtitle - 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.

    Default: NString::Null()
  • mtype - Message Type

    One character indicating the message type can be passed:

    I - information

    W - Warning

    E - Error

    All other message types are considered as errors.

    Default: 0