ble_gap_cfg_device_name_t Struct Reference

Device name and its properties, set with sd_ble_cfg_set. More...

#include <ble_gap.h>

Data Fields
ble_gap_conn_sec_mode_t	write_perm
uint8_t	vloc:2
uint8_t *	p_value
uint16_t	current_len
uint16_t	max_len

Detailed Description

Device name and its properties, set with sd_ble_cfg_set.

Note

If the device name is not configured, the default device name will be BLE_GAP_DEVNAME_DEFAULT, the maximum device name length will be BLE_GAP_DEVNAME_DEFAULT_LEN, vloc will be set to BLE_GATTS_VLOC_STACK and the device name will have no write access.

If max_len is more than BLE_GAP_DEVNAME_DEFAULT_LEN and vloc is set to BLE_GATTS_VLOC_STACK, the attribute table size must be increased to have room for the longer device name (see sd_ble_cfg_set and ble_gatts_cfg_attr_tab_size_t).

If vloc is BLE_GATTS_VLOC_STACK :

• p_value must point to non-volatile memory (flash) or be NULL.
• If p_value is NULL, the device name will initially be empty.

If vloc is BLE_GATTS_VLOC_USER :

• p_value cannot be NULL.
• If the device name is writable, p_value must point to volatile memory (RAM).

Return values

NRF_ERROR_INVALID_PARAM	One or more of the following is true: Invalid device name location (vloc). Invalid device name security mode.
NRF_ERROR_INVALID_LENGTH	One or more of the following is true: The device name length is invalid (must be between 0 and BLE_GAP_DEVNAME_MAX_LEN). The device name length is too long for the given Attribute Table.
NRF_ERROR_NOT_SUPPORTED	Device name security mode is not supported.

Definition at line 1080 of file ble_gap.h.

Field Documentation

uint16_t ble_gap_cfg_device_name_t::current_len

Current length in bytes of the memory pointed to by p_value.

Definition at line 1085 of file ble_gap.h.

uint16_t ble_gap_cfg_device_name_t::max_len

Maximum length in bytes of the memory pointed to by p_value.

Definition at line 1086 of file ble_gap.h.

uint8_t* ble_gap_cfg_device_name_t::p_value

Pointer to where the value (device name) is stored or will be stored.

Definition at line 1084 of file ble_gap.h.

uint8_t ble_gap_cfg_device_name_t::vloc

Value location, see GATT Value Locations.

Definition at line 1083 of file ble_gap.h.

ble_gap_conn_sec_mode_t ble_gap_cfg_device_name_t::write_perm

Write permissions.

Definition at line 1082 of file ble_gap.h.

---

The documentation for this struct was generated from the following file:

• ble_gap.h