IterRead
- Macro
- August 22, 2025
Table of Contents
IterRead
IterRead
Description
Read object from memory iter, given that - Provided Iter object is not NULL_ITER(mi). - There’s space left to read. - Length of object data is being read into is an integral multiple of size of data type this memory iter is iterating over.
Success
Data is copied from current read position to provided dst
, and mi
is returned
Failure
NULL_ITER(mi) returned
Usage example (Cross-references)
- In
StrIter.h:152
:
///
/// TAGS: StrIter, Read, Character, Iter
#define StrIterRead(mi, dst) IterRead(mi)
///