bbmsp_user_profile_box_item_get_item_id()

Retrieve the ID associated with a profile box item.

Synopsis:

#include "bbmsp/bbmsp_user_profile_box.h"

BBMSP_API bbmsp_result_t bbmsp_user_profile_box_item_get_item_id(const bbmsp_user_profile_box_item_t *item, char *item_id_buffer, size_t buffer_size)

Since:

BlackBerry 10.0.0

Arguments:

item: A pointer to the profile box item.

item_id_buffer: A pointer to the buffer where the ID will be stored.

buffer_size: The size of the itemid buffer.

Library:

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

Description:

Each profile box item 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.