HSendMessageToClient (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

HFSQL Client/Server functions

HAddScheduledOptimization

HCS.FrameSize (Variable)

HCS.Timeout (Variable)

HDeleteScheduledBackup

HDeleteScheduledOptimization

HExecuteScheduledBackup

HExecuteScheduling

HInfoBackup

HInfoDatabaseProperty

HInfoDatabaseRights (Example)

HInfoDatabaseRights

HInfoFileProperty

HInfoFileRights (Example)

HInfoServerRights (Example)

HListScheduledOptimization

HModifyDatabaseProperty

HModifyDatabaseRights

HModifyFileProperty

HModifyFileRights

HModifyGroup

HModifyScheduledBackup

HModifyScheduledOptimization

HModifyScheduling

HModifyServerProperty

HNotifAddEmailRecipient

HNotifConfigure

HNotifDeleteCCRecipient

HNotifDeleteEmailRecipient

HNotifListCCRecipient

HNotifListEmailRecipient

HRestoreBackup (Example)

Customization
Use conditions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HSendMessageToClient (Function)

In french: HEnvoieMessageVersClient

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.

Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 20 and later

This function is now available for iPhone/iPad applications.

New in version 20

This function is now available for iPhone/iPad applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

This function is now available to send a message to the users of an HFSQL cluster.

New in version 21

This function is now available in Universal Windows 10 App mode.

This function is now available to send a message to the users of an HFSQL cluster.

This function is now available in Universal Windows 10 App mode.

This function is now available to send a message to the users of an HFSQL cluster.

Versions 22 and later

This function is now available in Android widget mode.

This function is now available for Java applications.

This function is now available for Android applications.

New in version 22

This function is now available in Android widget mode.

This function is now available for Java applications.

This function is now available for Android applications.

This function is now available in Android widget mode.

This function is now available for Java applications.

This function is now available for Android applications.

Example

// Message to all users of "MAILBOX" database
HClient.Database = "MAILBOX"
HSendMessageToClient("MyConnection", "Caution: You will be disconnected soon", 300)

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

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

// Message to all applications run on "Computer1"
// that use the "Admin" login
HClient.Computer = "Computer1"
HClient.Login = "Admin"
HSendMessageToClient("MyConnection", "Caution: You will be disconnected soon", 300)

Syntax

<Result> = HSendMessageToClient(<Connection> , <Message> , <Display duration>)

<Result>: Boolean

True if the operation was performed,
False if a problem occurs.
HSendMessageToClient 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>: Character string or Connection variable

Connection to use. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a variable of type Connection.

<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 correspond to:
an integer corresponding to the number of seconds,
a Duration variable,
Versions 23 and later
the duration in a readable format (e.g., 1 s).
New in version 23
the duration in a readable format (e.g., 1 s).
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 HModifyServerRights).
- the "Rights to see the users and groups" (hRightsSeeUser constant in HModifyServerRights).
The message will be sent to the users that the client calling the function is allowed to see.
Versions 21 and later
This function can be used to send a message to all the users of an HFSQL cluster.
New in version 21
This function can be used to send a message to all the users of an HFSQL cluster.
This function can be used to send a message to all the users of an HFSQL cluster.

Component: wd270hf.dll