bbmsp_contact_get_display_picture()

#include <bbmsp/bbmsp_contactlist.h>
 

BBMSP_API bbmsp_result_t bbmsp_contact_get_display_picture(const bbmsp_contact_t *contact, bbmsp_image_t *display_picture)

Since:

BlackBerry 10.0.0

Arguments:

contact

A pointer to the contact whose display picture to get.

display_picture

is updated to the contact's display picture, created with bbmsp_image_create(). If a null pointer is provided, this method returns BBMSP_FAILURE.

Library:

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

Description:

If the contact's display picture has been previously retrieved, this function will return BBMSP_SUCCESS. If the contact's display picture has not been retrieved, this will return BBMSP_ASYNC and the data will come back through an event of category BBMSP_CONTACT_LIST, type BBMSP_SP_EVENT_CONTACT_CHANGED, and the field BBMSP_DISPLAY_PICTURE. If there is an error, BBMSP_FAILURE is returned.

Returns:

BBMSP_SUCCESS if successful, BBMSP_ASYNC if the response will come back asynchronously, and BBMSP_FAILURE otherwise.