Reads packets from a packet table starting at the current index.

Procedure:

H5PT_GET_NEXT(table_id, nrecords, data)

Signature:

<pre><code class="language-c">herr_t H5PTget_next(hid_t table_id, size_t nrecords, void *data)</code></pre>

Parameters:

hid_t table_id

    IN: Identifier of packet table to read from.

size_t nrecords

    IN: Number of packets to be read.

void * data

    OUT: Buffer into which to read data.

Description:

H5PTread_packets reads nrecords packets starting with the "current index" from a packet table specified by table_id. The packet table's index is set and reset with H5PTset_index and H5PTcreate_index. data is a buffer into which the data should be read.

For a packet table holding variable-length records, the data returned in the buffer will be in form of a hvl_t struct containing the length of the data and a pointer to it in memory. The memory used by this data must be freed using H5PTfree_vlen_buff.

Returns:

Returns a non-negative value if successful, otherwise returns a negative value.

Example:

Coming Soon!