Displays a user notification dialog and waits for a user response.
SDK
- macOS 10.0+
Framework
- Core Foundation
Declaration
SInt32 CFUserNotificationDisplayAlert(CFTime Interval timeout, CFOption Flags flags, CFURLRef iconURL, CFURLRef soundURL, CFURLRef localizationURL, CFString Ref alertHeader, CFString Ref alertMessage, CFString Ref defaultButtonTitle, CFString Ref alternateButtonTitle, CFString Ref otherButtonTitle, CFOption Flags *responseFlags);
Parameters
timeout
The amount of time to wait for the user to dismiss the notification dialog before the dialog dismisses itself. Pass
0
to have the dialog never time out.flags
A set of flags describing the type of notification dialog to display. The value is normally just the alert level from Alert Levels. If you don’t want a default button displayed, perform a bitwise-OR operation with the alert level and the constant
k
.CFUser Notification No Default Button Flag iconURL
A file URL pointing to the icon to display in the dialog. If
NULL
, a default icon is used based on the notification’s alert level specified inflags
.soundURL
Not used.
localizationURL
A file URL pointing to a bundle that contains localized versions of the strings displayed in the dialog. Can be
NULL
.alertHeader
The title of the notification dialog. Cannot be
NULL
.alertMessage
The message string to display in the dialog. Can be
NULL
.defaultButtonTitle
The title of the default button. If
NULL
, the stringOK
is used.alternateButtonTitle
The title of an optional alternate button. Can be
NULL
.otherButtonTitle
The title of an optional third button. Can be
NULL
.responseFlags
On return, contains flags identifying how the notification was dismissed. See Response Codes for details.
Return Value
0
if the cancel was successful; a non-0
value otherwise.
Discussion
This function blocks the current thread’s execution until the dialog is dismissed, either by the user or by timing out.