a0FUnpackPosition()

Unpacks data from a buffer, from a given position.


Syntax

a0tError a0FUnpackPosition(
a0tBuffer *buffer,
long *position,
a0tFormat *format,
void *address,
int count );

Arguments

Namerd/wrDescription
buffer read Buffer descriptor to unpack from.
position write Position of the storage to unpack data from.
format read Format of the elements to unpack.
address write Address to unpack to.
count read Number of elements to unpack.

Description

Unpacks from buffer the first count elements of format format and stores in memory, starting at address address. The buffer position pointer is set to the value pointed by position and data unpacked are extracted from any information stored starting that position.

On return of this function, the variable pointed by position contains the buffer position pointer after the un pack.


Return Values

If an error condition occurs, it returns the error code, otherwise it returns A0ErrOk. Possible values are as follows:
Error CodeDescription
A0ErrFailPack It was not possible to unpack all data.
A0ErrOkSuccessful completion.

See Also

a0FPackPosition() a0FUnpack() a0UseFormats() a0NewMapFormat() a0NewFunctionFormat() a0NewBuffer() a0ClearBuffer() a0SendBuffer() a0ReceiveBuffer() a0ISendBuffer() a0IReceiveBuffer()