bbmsp_user_profile_box_add_item()

Add an item to a user's profile box.

Synopsis:

#include "bbmsp/bbmsp_user_profile_box.h"
 
BBMSP_API bbmsp_result_t bbmsp_user_profile_box_add_item(const char *text, int32_t icon_id, const char *cookie)

Since:

BlackBerry 10.0.0

Arguments:

text

A pointer to the buffer that contains the item text.

icon_id

The ID of a registered image, or < 0 if this item has no image.

cookie

A pointer to the buffer that contains the cookie.

Library:

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

Description:

A profile box item consists of an image, text, and a customizable string (cookie). text and cookie must be null-terminated C-strings, encoded as UTF-8. The item text must not be null or empty. It can have a maximum of 100 characters, with no more than 2 new line characters. The cookie can be null, with a maximum of 129 characters. The icon_id must be that of a registered image, or < 0 if this item has no image. If bbmsp_can_show_profile_box() returns false, this method returns BBMSP_FAILURE.

Returns:

BBMSP_ASYNC if successful, BBMSP_FAILURE otherwise.