H5TB_READ_RECORDS

Content Layer

id	1195548671

Content Column

width	50.00001%
id	1195578110
class	rm_pagetree_col mobile-hide

Content Block

id	1195578111

Content Column

width	50.00001%
id	1195548673
class	hdf-rm-main-column

Content Block

id	1195548672

Include Content

render-without-blocks	true
page	.rm-navbar

HTML Wrap

class	hdf-print-only

Page Title

HTML Wrap

class	hdf-rm-summary-block

Hdf rm anchor

AnchorName	summary

Excerpt
Reads records

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	procedure

Procedure:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf_procedure

H5TB_READ_RECORDS (loc_id, table_name, start, nrecords, type_size, field_offset, dst_sizes, data )

Hdf rm anchor

AnchorName	signature

Signature:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf-togglebox hdf-c

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-c

HTML

<pre><code class="language-c"> herr_t H5TBread_records ( hid_t loc_id, const char *table_name, hsize_t start, hsize_t nrecords, 
                 size_t type_size,  const size_t *field_offset, const size_t *dst_sizes,  void *data )</code></pre>

Hdf rm anchor

AnchorName	parameters

Parameters:

HTML Wrap

class	hdf-rm-section

hid_t `loc_id`	IN: Identifier of the file or group to read the table within
const char *`table_name`	IN: The name of the dataset to read
hsize_t `start`	IN: The start record to read from
hsize_t `nrecords`	IN: The number of records to read
size_t `type_size`	IN: The size of the structure type, as calculated by sizeof()
const size_t *`field_offset`	IN: An array containing the offsets of the fields. These offsets can be calculated with the HOFFSET macro.
const size_t *`dst_sizes`	IN: An array containing the size in bytes of the fields
void *`data`	OUT: Buffer with data

Hdf rm anchor

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

H5TB_READ_RECORDS reads some records identified from a dataset named table_name attached to the object specified by the identifier loc_id.

Hdf rm anchor

AnchorName	returns

Returns:

HTML Wrap

class	hdf-rm-section

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

Hdf rm anchor

AnchorName	example

Example:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf-togglebox hdf-c

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/hdf5_1_12
projectKey	HDFFV
filepath	hl/test/test_table.c
showLineNumbers	true
lineStart	562559
progLang	plain
lineEnd	565
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

Comment

HTML Wrap

class	hdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	fortran/examples/compound.f90
showLineNumbers	true
lineStart	25
progLang	plain
lineEnd	35
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

Page tree

Versions Compared

Old Version 7

New Version Current

Key

Procedure:

Signature:

Parameters:

Description:

Returns:

Example:

The HDF Group

Site

Resources

Connect