bbmsp_event_user_profile_box_icon_retrieved_get_icon_image()

#include "bbmsp/bbmsp_user_profile_box.h"
 

BBMSP_API bbmsp_result_t bbmsp_event_user_profile_box_icon_retrieved_get_icon_image(bbmsp_event_t *event, bbmsp_image_t **icon_image)

Since:

BlackBerry 10.0.0

Arguments:

event

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

icon_image

An updated pointer to the image. If a null pointer is provided, this method returns BBMSP_FAILURE.

Library:

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

Description:

When a user's profile box image is retrieved, 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.