bbmsp_profile_get_handle()

#include "bbmsp/bbmsp_userprofile.h"
 

BBMSP_API bbmsp_result_t bbmsp_profile_get_handle(bbmsp_profile_t *profile, char *handle, size_t buffer_size)

Since:

BlackBerry 10.0.0

Arguments:

profile

A pointer to the user's BBM profile.

handle

An updated pointer to the handle buffer array, encoded as UTF-8.

buffer_size

The size of the handle buffer array.

Library:

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

Description:

The handle is an identifier for a user on the BBM Social Platform whose device is running BlackBerry 7 or earlier. It is provided for backwards compatibility and should NOT be used as a persistent identifier for a user. Use the PPID instead.

The user's handle is the same for each instance of BBM (for example, on a BlackBerry smartphone and a BlackBerry tablet). Handle is encoded as a Base64 string using the ASCII character set.

Returns:

BBMSP_SUCCESS if successful, BBMSP_FAILURE otherwise.