FLCBYTBF-API FLUC C++ Stream Buffer Interface

Data Structures | Macros
Structures

Definition of structures for FLAM's APIs. More...

## Data Structures
struct | FlmElmRec0
| FLAM 5 serialized element structure (version 0) More...

## Macros
#define | FLMELMREC0_LENGTH(element)
| Macro that calculates the length of an element of type FlmElmRec0. More...
#define | FLMELMREC0_ATTRPTR(element)
| Convenience macro that calculates the correct starting address of the attribute data within FlmElmRec0::buffer. More...
#define | FLMELMREC0_DATAPTR(element)
| Convenience macro that calculates the correct starting address of the element's data payload within FlmElmRec0::buffer. More...
#define | FLMELMREC0_HASHPTR(element)
| Convenience macro that calculates the correct starting address of the hash data within FlmElmRec0::buffer. More...

## Detailed Description

Definition of structures for FLAM's APIs.

## Macro Definition Documentation

## ◆ FLMELMREC0_LENGTH

#define FLMELMREC0_LENGTH | ( |  | element | ) |

Macro that calculates the length of an element of type FlmElmRec0.

This macro calculates the correct length in bytes of a serialized element structure of type FlmElmRec0 by passing a pointer the element.

The macro may be used to conveniently calculate the correct buffer size e.g. to pass to fcbwrite() or FCRPUT() when writing elements.

## ◆ FLMELMREC0_ATTRPTR

#define FLMELMREC0_ATTRPTR | ( |  | element | ) |

Convenience macro that calculates the correct starting address of the attribute data within FlmElmRec0::buffer.

## ◆ FLMELMREC0_DATAPTR

#define FLMELMREC0_DATAPTR | ( |  | element | ) |

Convenience macro that calculates the correct starting address of the element's data payload within FlmElmRec0::buffer.

## ◆ FLMELMREC0_HASHPTR

#define FLMELMREC0_HASHPTR | ( |  | element | ) |

Convenience macro that calculates the correct starting address of the hash data within FlmElmRec0::buffer.