dialog_set_cancel

Specify whether the application is required to cancel a dialog explicitly.

Synopsis:

#include <bps/dialog.h>

BPS_API int dialog_set_cancel_required(dialog_instance_t dialog,
                                       bool cancel_required)

Since:

BlackBerry 10.0.0

Arguments:

dialog: The dialog to update.

cancel_required: If true, the application must cancel the dialog explicitly; if false, the application doesn't cancel the dialog explicitly.

Library:

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

Description:

The dialog_set_cancel_required() function specifies whether the application is required to cancel the dialog or not when the user presses a button. By default, the application is not required to explicitly cancel the dialog but it is no longer displayed once the user presses one of the dialog's buttons. If cancel_required is set to true, then the dialog continues to be displayed, even after one of its buttons has been pressed, until the application calls dialog_cancel() on the dialog.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.