<Connection variable>.SendMessageToClient (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / Managing databases / HFSQL / HFSQL Client/Server functions

Customization
Use conditions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Connection variable>.SendMessageToClient (Function)

In french: <Variable Connexion>.EnvoieMessageVersClient

Available only with this kind of connection

Displays a message on the client computers. The affected Client computers are those specified in the HClient structure.

Example

// Description de la connexion
MaConnexion is Connection
...
// Message à tous les utilisateurs de la base de données "BAL"
HClient.Database = "BAL"
MaConnexion.SendMessageToClient("Attention : Déconnexion imminente", 300)

// Description de la connexion
MaConnexion is Connection
...
// Message à l'utilisateur "Admin" de la base de données "MaBase"
HClient.Database = "MaBase"
HClient.Login = "Admin"
MaConnexion.SendMessageToClient("Test d'envoi de message", 15)

// Description de la connexion
MaConnexion is Connection
...
// Message à toute application accédant au fichier Client.fic 
// de la base de données "MaBase"
HClient.Database = "MaBase"
HClient.File = "Client.fic"
MaConnexion.SendMessageToClient("Vous utilisez le fichier Client", 300)

// Description de la connexion
MaConnexion is Connection
...
// Message à toute application exécutée sur "Machine1"
//  utilisant le login "Admin"
HClient.Computer = "Machine1"
HClient.Login = "Admin"
MaConnexion.SendMessageToClient("Attention : Déconnexion imminente", 300)

Syntax

<Result> = <Connection>.SendMessageToClient(<Message> , <Display duration>)

<Result>: Boolean

True if the operation was performed,
False if a problem occurs.
<Connection variable>.SendMessageToClient is a blocking function while the message is being sent to the server. The application continues to run once the message is received by the server.

<Connection>: Connection variable

Name of the Connection variable that describes the connection to use.

<Message>: Character string

Message that will be displayed on the client computer.

<Display duration>: Integer or Duration

Display duration of message (in seconds). This parameter can correspond to:
an integer corresponding to the number of seconds,
a Duration variable,
the duration in a readable format (e.g., 1 s).

Remarks

Customization

HOnServerCall is used to customize the management of message display on the client computer.

Use conditions

To use this function, you must have:
- the "Rights to send messages to the client computers" (hRightsSendMessageToClient constant in <Connection variable>.ModifyServerRights).
- the "Rights to see the users and groups" (hRightsSeeUser constant in <Connection variable>.ModifyServerRights).
The message will be sent to the users that the client calling the function is allowed to see.
This function can be used to send a message to all the users of an HFSQL cluster.

Component: wd300hf.dll