H5R_GET_OBJ_TYPE3

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
Retrieves the type of object that an object reference points to

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	procedure

Procedure:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf_procedure

H5R_GET_OBJ_TYPE3 (ref_ptr, rapl_id, obj_type)

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 H5Rget_obj_type3 ( const H5R_ref_t ref_ptr, hid_t rapl_id, H5O_type_t obj_type )</code></pre>

Comment

HTML Wrap

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

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-fortran

HTML
<pre><code class="language-fortran">Replace this text with the Fortran function signature</code></pre>

Hdf rm anchor

AnchorName	parameters

Parameters:

HTML Wrap

class	hdf-rm-section

const H5R_ref_t * `ref_ptr`	IN: Pointer to reference to query H5R_ref_t is defined in `H5Rpublic.h` as: `typedef unsigned char H5R_ref_t[H5R_REF_BUF_SIZE];`
hid_t `rapl_id`	IN: Valid reference access property list identifier
H5O_type_t * `obj_type`	OUT: Type of referenced object

Hdf rm anchor

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

Given a reference, ref_ptr, H5R_GET_OBJ_TYPE3 retrieves the type of the referenced object in obj_type.

The parameter rapl id is a reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).

The referenced object type, or the type of the referenced object, is the type of the object that the reference points to. When the function completes successfully, it returns one of the following valid object type values (defined in H5Opublic.h):

Object Type Value	Description
`H5O_TYPE_GROUP`	Object is a group
`H5O_TYPE_DATASET`	Object is a dataset
`H5O_TYPE_NAMED_DATATYPE`	Object is a named datatype

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

None

Comment

HTML Wrap

class	hdf-togglebox hdf-c

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	examples/h5_subset.c
showLineNumbers	true
lineStart	32
progLang	cpp
lineEnd	42
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

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

Hdf rm anchor

AnchorName	history

History:

HTML Wrap

class	hdf-rm-section

Release	Change
1.12.0	C function was introduced in this release.

Page tree

Versions Compared

Old Version 7

New Version Current

Key

Procedure:

Signature:

Parameters:

Description:

Returns:

Example:

History:

The HDF Group

Site

Resources

Connect