Return Values
www.ti.com
130
SWRU271H–October 2010–Revised April 2019
Submit Documentation Feedback
Copyright © 2010–2019, Texas Instruments Incorporated
GATT/ATT API
bStatus_t GATT_WriteCharDesc ( uint16 connHandle, attWriteReq_t *pReq, uint8 taskId )
Used to write a characteristic descriptor value to a server when the client knows
the characteristic descriptor handle.
Parameters connHandle: connection to use
pReq: pointer to request to be sent
taskId: task to be notified of response
bStatus_t GATT_WriteLongCharDesc ( uint16 connHandle, gattPrepareWriteReq_t *pReq, uint8
taskId )
Used to write a Characteristic Value to a server when the client knows the
Characteristic Value Handle but the length of the Characteristic Value is longer
than can be sent in a single Write Request Attribute Protocol message.
Parameters connHandle: connection to use
pReq: pointer to request to be sent
taskId: task to be notified of response
Notes If the return status is SUCCESS, the calling application task receives multiple
GATT_MSG_EVENT messages with type ATT_PREPARE_WRITE_RSP,
ATT_EXECUTE_WRITE_RSP or ATT_ERROR_RSP (if an error occurred on the
server). This sub-procedure is complete when either ATT_PREPARE_WRITE_RSP (with
bleTimeout status), ATT_EXECUTE_WRITE_RSP (with SUCCESS or bleTimeout
status), or the calling application task recieves the ATT_ERROR_RSP (with SUCCESS
status).
D.4 Return Values
• SUCCESS (0x00): Command was executed as expected. For corresponding events to expect, see the
command API.
• INVALIDPARAMETER (0x02): Invalid connection handle or request field
• ATT_ERR_INSUFFICIENT_AUTHEN (0x05): The attribute requires authentication
• ATT_ERR_INSUFFICIENT_KEY_SIZE (0x0C): The key size for encrypting is insufficient
• ATT_ERR_INSUFFICIENT_ENCRYPT (0x0F): The attribute requires encryption
• MSG_BUFFER_NOT_AVAIL (0x04): An HCI buffer is unavailable. Retry later.
• bleNotConnected (0x14): The device is unconnected.
• blePending (0x17):
– When returned to a client function, a response is pending with the server or the GATT sub-
procedure is in progress.
– When returned to server function, confirmation from a client is pending.
• bleTimeout (0x16): The previous transaction timed out. No ATT or GATT messages can send until
reconnected.
• bleMemAllocError (0x13): A memory allocation error occurred
• bleLinkEncrypted (0x19): The link is encrypted. Do not send an attribute PDU includes an
authentication signature on an encrypted link