navigator_card_close()

#include <bps/navigator.h>
 

BPS_API int navigator_card_close(const char *reason,
                                 const char *type,
                                 const char *data)

Since:

BlackBerry 10.0.0

Arguments:

reason

The application level description of why the card was closed. The reason member can be NULL.

type

The type and encoding of the closed card's response data. The type member can't be NULL if the data member isn't NULL.

data

The data being returned to the parent from the closed card. The data member can be NULL.

Library:

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

Description:

The navigator_card_close() function sends a request to the Navigator to perform a card close action, along with response data to return to the parent. Call this function from the card application to close the card and have the Navigator notify the parent with a NAVIGATOR_CHILD_CARD_CLOSED event. The closed card may also be pooled instead for later use, at which point the Navigator will send a NAVIGATOR_CARD_CLOSED event to the card application.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.