Reads a number of packets from a packet table.
Procedure:
H5PT_READ_PACKETS(table_id, start, nrecords, data)
Signature:
herr_t H5PTread_packets(hid_t table_id, hsize_t start, size_t nrecords, void* data)
Parameters:
hid_t table_id
IN: Identifier of packet table to read from.
hsize_t start
IN: Packet to start reading 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 at packet number start
from a packet table specified by table_id
. 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 hvl_t
structs, each 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:
--- Last Modified: December 04, 2017 | 07:24 AM