navigator_set_close_prompt()

#include <bps/navigator.h>
 

BPS_API int navigator_set_close_prompt(const char *title,
                                       const char *message)

Since:

BlackBerry 10.0.0

Arguments:

title

The title of the close prompt dialog to set.

message

The message of the close prompt dialog to set.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

The navigator_set_close_prompt() function sends a navigator closePrompt request to set the contents of the close prompt dialog. This function allows an application to prevent the user from closing the application without warning. If the user tries to close the application, a dialog will be displayed with the title and message specified. The user will have 2 buttons: "Cancel" and "Close". If the user selects Close, the application will receive an "exit" message. If the user selects Cancel, the dialog will close and the application will continue running. This function can be called as many times as needed if the application's state changes.

Neither title nor message support the use of commas (,) or quotes ("). Inserting either of these characters may make it impossible to close your application using the Navigator.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.