<Connection variable>.SendMessageToClient (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

HFSQL Client/Server functions

ActivateServerTrigger

AddGroup

AddLink

AddScheduledBackup

AddScheduledOptimization

DeactivateServerTrigger

DeleteScheduledBackup

DeleteScheduledOptimization

DescribeServerTrigger

ExecuteScheduledBackup

ListScheduledOptimization

ModifyDatabaseProperty

ModifyScheduledBackup

ModifyScheduledOptimization

NotifAddEmailRecipient

NotifConfigure

NotifDeleteCCRecipient

NotifDeleteEmailRecipient

NotifListCCRecipient

NotifListEmailRecipient

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

// Describe the connection
MyConnection is Connection
...
// Message to all users of "MAILBOX" database
HClient.Database = "MAILBOX"
MyConnection.SendMessageToClient("Caution: You will be disconnected soon", 300)

// Describe the connection
MyConnection is Connection
...
// Message to the "Admin" user of "MyDatabase" database
HClient.Database = "MyDatabase"
HClient.Login = "Admin"
MyConnection.SendMessageToClient("Test for sending messages", 15)

// Describe the connection
MyConnection is Connection
...
// Message to all applications accessing Client.fic
// found in "MyDatabase"
HClient.Database = "MyDatabase"
HClient.File = "Customer.fic"
MyConnection.SendMessageToClient("You are using the Client file", 300)

// Describe the connection
MyConnection is Connection
...
// Message to all applications run on "Computer1"
// that use the "Admin" login
HClient.Computer = "Computer1"
HClient.Login = "Admin"
MyConnection.SendMessageToClient("Caution: You will be disconnected soon", 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 ou Duration

Display duration of message (in seconds). This parameter can be:
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: wd280hf.dll