arm_subbuffer_diag_detail Struct Reference [ARM 4.0 Sub-buffers]

used to provide diagnostic detail information for not good transactions. More...

#include <arm4.h>

Data Fields
arm_subbuffer_t	header
const arm_char_t *	diag_detail

---

Detailed Description

used to provide diagnostic detail information for not good transactions.

When a transaction completion is reported with arm_stop_transaction() or arm_report_transaction(), and the transaction status is not ARM_STATUS_GOOD, the application may provide a character string containing any arbitrary diagnostic data. The string may not be longer than 4096 characters, including the null-termination character. For example, the application might provide the SQL query text for a failing database transaction.

---

Field Documentation

const arm_char_t* arm_subbuffer_diag_detail::diag_detail

A null-terminated string containing the diagnostic data. Each string has a maximum length of 4096 characters, including the termination character. If the pointer is null, it is equivalent to not providing the sub-buffer at all.

arm_subbuffer_t arm_subbuffer_diag_detail::header

header.format must be set to ARM_SUBBUFFER_DIAG_DETAIL

---

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

• arm4.h