bbmsp_user_profile_box_retrieve_icon()

Retrieve a profile box image that is registered with the BBM Social Platform.

Synopsis:

#include "bbmsp/bbmsp_user_profile_box.h"
 
BBMSP_API bbmsp_result_t bbmsp_user_profile_box_retrieve_icon(const int32_t icon_id)

Since:

BlackBerry 10.0.0

Arguments:

icon_id

The ID of the requested icon

Library:

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

Description:

Retrieves the image that was uploaded to the user's BlackBerry device when the image was registered. This process takes place asynchronously. If bbmsp_can_show_profile_box() returns false, this method will return BBMSP_FAILURE.

Returns:

BBMSP_ASYNC if successful, BBMSP_FAILURE otherwise.