bbmsp_event_user_profile_box_icon_retrieved_get_icon_id()

Retrieve the icon_id for an image that was retrieved from the user's profile box.

Synopsis:

#include "bbmsp/bbmsp_user_profile_box.h"

BBMSP_API bbmsp_result_t bbmsp_event_user_profile_box_icon_retrieved_get_icon_id(bbmsp_event_t *event, int32_t *icon_id)

Since:

BlackBerry 10.0.0

Arguments:

event: A pointer to the event that was triggered when the image was retrieved.

icon_id: Updated with the id of the icon

Library:

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

Description:

When an image is retrieved from a user's profile box, the BBMSP_SP_EVENT_USER_PROFILE_BOX_ICON_RETRIEVED event is triggered. If bbmsp_can_show_profile_box() returns false, this method will return BBMSP_FAILURE.

Returns:

BBMSP_SUCCESS if successful, BBMSP_FAILURE otherwise.