navigator_event_get_card_closed_reason()

Retrieve the reason for a card closure.

Synopsis:

#include <bps/navigator.h>

BPS_API const char* navigator_event_get_card_closed_reason(bps_event_t *event)

Since:

BlackBerry 10.0.0

Arguments:

event: The NAVIGATOR_CHILD_CARD_CLOSED or NAVIGATOR_CARD_CLOSED event that informed the application of the card closure.

Library:

libbps

Description:

The navigator_event_get_card_closed_reason() function extracts the reason for which a card has been closed using the navigator_card_close() function. Call this function in the application upon receiving a NAVIGATOR_CHILD_CARD_CLOSED event to identify why the child card was closed, or upon receiving a NAVIGATOR_CARD_CLOSED event to identify why the card itself was closed. This function doesn't copy data and the returned value is released once the bps_get_event() function is called again.

Returns:

The reason why the card was closed upon success, NULL with errno set otherwise.