arm_subbuffer_user Struct Reference [ARM 4.0 Sub-buffers]

used to associate an user name and/or ID to a transaction instance. More...

#include <arm4.h>

Data Fields
arm_subbuffer_t	header
const arm_char_t *	name
arm_boolean_t	id_valid
arm_id_t	id

---

Detailed Description

used to associate an user name and/or ID to a transaction instance.

An user name and/or ID may be optionally associated with each transaction instance. A name is a null-terminated character string. An ID is a 16-byte binary value, such as a UUID. Either or both may be provided.

---

Field Documentation

arm_subbuffer_t arm_subbuffer_user::header

header.format must be set to ARM_SUBBUFFER_USER

arm_id_t arm_subbuffer_user::id

16-byte ID (16 bytes) that is associated with and can be used as an alias for the user name.

arm_boolean_t arm_subbuffer_user::id_valid

A boolean indicating whether the ID field contains a valid ID.

const arm_char_t* arm_subbuffer_user::name

A null-terminated character string with a maximum length of 128 characters, including the termination character. A null value indicates no name is provided.

---

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

• arm4.h