SendMessage

Purpose

This command transmits a text message to speaker clients and controls how it is to be displayed.

• This command is only valid with the Professional edition of HomeSeer.

Parameters

Parameter: message
Type: string
Description: The text of the message you wish to send.

Parameter: host
Type: string
Description: The host name, comma separated hosts list, or comma separated list of host:instance names that you wish to send the message to.

Parameter: showballoon
Type: boolean
Description: If set to TRUE, the text will be displayed in a balloon popup window in the system tray.

Returns

Return value: error
Type: integer (.NET Enum, Short)
Description: 1 = No Error, 2 = There are no speaker clients to send to, 3 = An error occurred during the sending.

Example

Sub Main()

Dim i

i = hs.SendMessage("Hello, World.", "*:Default", True)
if i > 1 then
  hs.WriteLog "Error","SendMessage failed with code " & CStr(i)
end if

End Sub