uds_account_data_set_locked_icon()

Set the locked icon for the specified account data.

Synopsis:

#include "bb/pim/unified/unified_data_source.h"
 

void uds_account_data_set_locked_icon(uds_account_data_t *account, const char *locked_icon)

Since:

BlackBerry 10.2.0

Arguments:

account

The account to set the locked icon for. This account is represented by a uds_account_data_t and is created using uds_account_data_create().

locked_icon

The file name of the locked icon to set.

Library:

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

Description:

If an account is associated with the enterprise perimeter, it's possible that this perimeter may be locked. If this perimeter is locked when a user views the BlackBerry Hub, any accounts associated with it are not accessible, and these accounts display a different icon on the account tab in the BlackBerry Hub. This function lets you specify the icon that appears when an account's perimeter is locked. The icon that you want to use must be located in the asset directory that you specify when you call uds_register_client(). The icon should also be 81x81 pixels and in PNG format.

This icon is required only for enterprise (UDS_ACCOUNT_ENTERPRISE) and hybrid (UDS_ACCOUNT_HYBRID) accounts. The string value that you pass in as the locked_icon parameter must remain valid until the data is used in a call to uds_account_added() or uds_account_updated().

Returns:

Parent topic: Account functions in unified_data_source.h