Dial_RemoveNotification (function reference)

Troi Dialog Plug-in > Functions reference > Dial_RemoveNotification
Troi Dialog Plug-in for FileMaker Pro

Dial_RemoveNotification

Removes a (delivered) notification

SyntaxFunction badge

Dial_RemoveNotification ( switches ; notificationID )

Parameters

switchesnot used, reserved for future use. Leave blank or put "-Unused"
notificationIDthe id for the notification that you want to remove

Returned Result

Data type returned

Error code

Result

If successful it returns 0. If unsuccessful it returns an error code starting with $$ and the error code. Returned error codes can be:

$$-4221invalidOSVersionnotifications are not supported on this OS version
$$-4291notificationsNotEnablednotifications are not enabled in the preferences

Originated in

Troi Dialog Plug-in 7.5

Compatibility

FileMaker Pro 14 to 17

Considerations

When you leave the notificationID parameter empty all delivered notifications will be removed.

Example

Set Variable [ $ErrorCode ;  Dial_RemoveNotification ( "-Unused" ; "note123" ) ]

This will remove the notification with notificationID “note123”.

Example 2

Set Variable [ $ErrorCode ;  Dial_RemoveNotification ( "-Unused" ; "" ) ]

When you leave the notificationID parameter empty all delivered notifications will be removed.

Related functionFunction badge

Dial_ScheduleNotification

Related script stepScript step badge

Remove Notification

Related topics

Troi Dialog Plug-in online help (overview)


Online Help Page for Troi Dialog Plug-in for 14 to 17 –> Dial_RemoveNotification (dialp4321) 2018-1114 15:30:41