Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kSerializer_BeginRead ( kSerializer  serializer,
kType  sizeType,
kBool  includeSize 
)

Begins reading a measured data section.

BeginRead can be called multiple times before calling EndRead, in order to nest read sections. Each call to BeginRead pushes information onto a stack; this information is popped from the stack by calling EndRead.

Accordingly, it is the caller's responsibility to ensure that either 1) EndRead is called once for each call to BeginRead, or 2) the kSerializer_Reset method is called to clear serialization state in the event of errors. Note that some kSerializer subclasses, including kDat5Serializer and kDat6Serializer, will automatically call kSerializer_Reset if errors are encountered during object deserialization. However, this behaviour not guaranteed for other serialization classes.

Parameters
serializerSerializer object.
sizeTypeType of size field (k8u, k16u, k32u, or k64u)
includeSizeSize of the size field was included in the recorded size?
Returns
Operation status.