bbmsp_user_profile_box_item_get_icon_id()

Retrieve the image ID associated with this profile box item.

Synopsis:

#include "bbmsp/bbmsp_user_profile_box.h"

BBMSP_API bbmsp_result_t bbmsp_user_profile_box_item_get_icon_id(const bbmsp_user_profile_box_item_t *item, int32_t *icon_id)

Since:

BlackBerry 10.0.0

Arguments:

item: A pointer to the profile box item.

icon_id: Updated with the image ID.

Library:

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

Description:

An image in a profile box is identified by a unique, non-negative numeric ID. If bbmsp_can_show_profile_box() returns false, this method will return BBMSP_FAILURE.

Returns:

BBMSP_SUCCESS if successful, BBMSP_FAILURE otherwise.