MsgPlus::DisplayToast

The MsgPlus::DisplayToast function displays a toast (popup window in the corner of the screen) with the specified message.

溴>


Messenger Plus! Live -脚本文件



物体的参考-m sgplus
msgplus ： ： displaytoast


该msgplus ： ： displaytoast功能显示在致祝酒词（弹出式窗口
在街角，在屏幕上）与指定的讯息。

溴>


Messenger Plus! Live -脚本文件



物体的参考-m sgplus
msgplus ： ： displaytoast


该msgplus ： ： displaytoast功能显示在致祝酒词（弹出式窗口
在街角，在屏幕上）与指定的讯息。

该msgplus ： ： displaytoast功能显示在致祝酒词（弹出式窗口
在街角，在屏幕上）与指定的讯息。

Syntax

[boolean] DisplayToast(
    [string] Title,
    [string] Message,
    [string,optional] SoundFile,
    [string,optional] Callback,
    [var,optional] CallbackParam
);

Parameters

Title

[string] Title displayed on top of the toast. If an empty string is sent in this parameter, "Messenger Plus! Live" is used.

Message

[string] Message displayed in the toast. Carriage returns can be used to force line breaks. A maximum of 4 lines can be displayed in the toast created by this function. Format codes are not parsed in this parameter and must be filtered out with RemoveFormatCodes.

SoundFile

[string,optional] Path to the sound file that will be played when the toast is shown on screen. The path is relative to the script's directory by default, to override this behavior, prefix the path with "\". Example: "\C:\directory\sound.mp3". If the parameter is missing or the string is empty, no sound is played.

Callback

[string,optional] Name of the function in your script that will be called if the toast is clicked by the user. If the parameter is missing or the string is empty, the toast won't be clickable. For more information, see ToastCallbackTemplate.

CallbackParam

[var,optional] Parameter of variable type (can be a number, a string, an object, ...). This value will be sent as parameter of the function specified in Callback when the toast is clicked. It can be omitted if not needed.

Return Value

A boolean value specifying if the toast is going to be displayed.  The toast is not guaranteed to be displayed immediately when the function returns, if Windows Live Messenger is already displaying a toast, Messenger Plus! wait for its turn. Here is a list (not exhaustive) of possible reasons why this function may return false:

一个布尔值，指明如果致祝酒辞，是要被显示。
在致祝酒词是不能保证立即显示当
函数返回，如果Windows Live Messenger的是已经展示了
致祝酒辞，Messenger Plus！等待轮到。这里是一个名单（不
详尽无遗的）可能的原因，这个函数可能返回
虚假：

一个布尔值，指明如果致祝酒辞，是要被显示。
在致祝酒词是不能保证立即显示当
函数返回，如果Windows Live Messenger的是已经展示了
致祝酒辞，Messenger Plus！等待轮到。这里是一个名单（不
详尽无遗的）可能的原因，这个函数可能返回
虚假：

一个布尔值，指明如果致祝酒辞，是要被显示。
在致祝酒词是不能保证立即显示当
函数返回，如果Windows Live Messenger的是已经展示了
致祝酒辞，Messenger Plus！等待轮到。这里是一个名单（不
详尽无遗的）可能的原因，这个函数可能返回
虚假：

• The user's status is Busy and "Show Messenger Plus! popup notifications when Busy" is unchecked in the user's preferences.
• The user has locked out his Windows session.
• A screensaver is currently running.
• The user is playing to a full screen DirectX game.

Remarks

A variety of sound file types is supported by Messenger Plus!, for a complete list, see PlaySound. To display toasts supporting format codes, use DisplayToastContact.

各种各样的声音文件类型的支持，再加上即时通讯！ ，一
完整的清单，见playsound 。至
显示toasts支持格式代码，使用
displaytoastcontact 。

各种各样的声音文件类型的支持，再加上即时通讯！ ，一
完整的清单，见playsound 。至
显示toasts支持格式代码，使用
displaytoastcontact 。

Function Information

See Also

MsgPlus Object, DisplayToastContact, PlaySound, ToastCallbackTemplate.

msgplus对象，
displaytoastcontact ，
playsound ，
toastcallbacktemplate 。

msgplus对象，
displaytoastcontact ，
playsound ，
toastcallbacktemplate 。

  Sponsor

  Links