bbmsp_contact_get_handle()

#include <bbmsp/bbmsp_contactlist.h>
 

BBMSP_API bbmsp_result_t bbmsp_contact_get_handle(const bbmsp_contact_t *contact, char *handle, size_t handle_buffer_size)

Since:

BlackBerry 10.0.0

Arguments:

contact

A pointer to the contact whose handle to get.

handle

A buffer that will be updated with the handle encoded as Base64. The resulting buffer will be null-terminated on success.

handle_buffer_size

The size of the handle buffer. This should be BBMSP_CONTACT_HANDLE_MAX.

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.

A 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.