Detailed Description
Buffer for storing options.
The following describes the memory layout of the optionBuffer structure:
It contains header of each individual entry at top of the buffer, then area of string which would be pointed by option entry header using offset bytes Since option buffer is caller allocated, it may contains unused bytes at end of the buffer. The structure layout would be initialized by library code.
To obtain size needed for buffer, pass NULL to corresponding API call and a minimal size would be filled in size parameter. The minimal size would also be filled in size parameter if the buffer size is too small, under this case ERR_BufferTooSmall would be returned.
A null byte in string area does not mark the end of that string.
Data Fields | |
| uint32_t | numEntries |
| Number of entries in this buffer. More... | |
| optionEntry * | pEntry |
| Pointer to first optionEntry. More... | |
Field Documentation
◆ numEntries
| uint32_t optionBuffer::numEntries |
◆ pEntry
| optionEntry* optionBuffer::pEntry |
Pointer to first optionEntry.
The documentation for this struct was generated from the following file: