bbmsp_user_profile_box_item_get_cookie()

#include "bbmsp/bbmsp_user_profile_box.h"
 

BBMSP_API bbmsp_result_t bbmsp_user_profile_box_item_get_cookie(const bbmsp_user_profile_box_item_t *item, char *cookie_buffer, size_t buffer_size)

Since:

BlackBerry 10.0.0

Arguments:

item

A pointer to the profile box item.

cookie_buffer

A pointer to the buffer where the cookie will be stored.

buffer_size

The size of the cookie_buffer.

Library:

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

Description:

A cookie is a string that you can customize for your app. If bbmsp_can_show_profile_box() returns false, this method will return BBMSP_FAILURE. The maximum length of a cookie is 129 characters, including the null terminating character.

Returns:

BBMSP_SUCCESS if successful, BBMSP_FAILURE otherwise.