C++ Syntax

bool

MKI_FeedbackNotification(

__int32 f_nMode,

DWORD f_dwDuration,

const LPCWSTR f_pszShortText,

const LPCWSTR f_pszLongText );

Displays a notification and adds it of the list of temporarily stored notifications. The application holds a list of the most recent 1,000 notifications while running. Use only in case of non-critical errors since the user may have switched any notification display off!

Parameters

Mode

[__int32] Type of notification to be displayed. Possible values are:

MKI_NOTIFICATIONMODE_DEFAULT

The notification will be permanently added to the list of notifications as read without further visual notification.

MKI_NOTIFICATIONMODE_BLINKING

The notification will be displayed with a blinking attention sign at the cross-hair and/or in the status window for the duration given in Duration. In addition, it will be permanently added to the list of notification.

MKI_NOTIFICATIONMODE_AUTOREAD

The notification will be displayed with a non-blinking information sign at the cross-hair and/or in the status window for the duration given in Duration. Afterwards, it will be automatically marked as "read". In addition, it will be permanently added to the list of notifications.

Duration

[DWORD] Duration for which a blinking / short-term notification shall be displayed in milliseconds. The usual durations are:

MKI_NOTIFICATIONTIME_LONG

Major notifications that the user should see in any case (10 seconds).

MKI_NOTIFICATIONTIME_NORMAL

Normal notifications that the user should usually see (5 seconds).

MKI_NOTIFICATIONTIME_SHORT

Minor notifications that are interesting only for the attentive user (2 seconds).

ShortText

[const LPCWSTR] Short text to be displayed at the cross-hair and/or in the status window. Maximum allowed length is 63 characters.

LongText

[const LPCWSTR] Full text to be displayed in the notification dialog. Unlimited length. Use "\n" for a forced line break. Use a line break in front of and after each contained file name. If this is nullptr, only the short text will be used.

Return Value

Returns true if successful, or false if unable to display the notification (due to invalid parameters).