Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5O_GET_NATIVE_INFO_BY_IDX

Retrieve native file format information about an object according to the order of an index

Procedure:

H5O_GET_NATIVE_INFO_BY_IDX ( loc_id, group_name, idx_type, order, n, oinfo, fields, lapl_id )

Signature:

herr_t H5Oget_native_info_by_idx ( hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, 
           hsize_t n, H5O_native_info_t *oinfo, unsigned fields, hid_t lapl_id )

Parameters:
hid_t loc_idIN: Location identifier of the object
const char *group_nameIN: Name of group in which object is located
H5_index_t idx_typeIN: Index or field that determines the order
H5_iter_order_t orderIN: Order within field or index
hsize_t nIN: Object for which information is to be returned
H5O_native_info_t *oinfoOUT: Buffer in which to return native object information
unsigned fieldsIN: Flags to determine which fields in oinfo are filled in
hid_t lapl_idIN: Link access property list

Description:

H5O_GET_NATIVE_INFO_BY_IDX retrieves the native file format information for an object specified by loc_id, group name, group_name, the index by which objects in the group are tracked, idx_type, the order by which the index is to be traversed, order , and an object's position n within that index. The information is retrieved into the buffer specified by oinfo, which is defined as a struct of type H5O_native_info_t:

Include Bitbucket Server for Confluence: Application link to Bitbucket Server is missing

You need an application link to Bitbucket Server to use this functionality. Please contact your system administrator to create one.

idx_type is of type H5_index_t, defined in H5public.h as:

Include Bitbucket Server for Confluence: Application link to Bitbucket Server is missing

You need an application link to Bitbucket Server to use this functionality. Please contact your system administrator to create one.

order is of type H5_iter_order_t defined in H5public.h as:

Include Bitbucket Server for Confluence: Application link to Bitbucket Server is missing

You need an application link to Bitbucket Server to use this functionality. Please contact your system administrator to create one.

The fields parameter indicates which fields to fill in H5O_native_info_t. Possible values are:

Include Bitbucket Server for Confluence: Application link to Bitbucket Server is missing

You need an application link to Bitbucket Server to use this functionality. Please contact your system administrator to create one.

Returns:

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

Example:

History:
ReleaseChange
1.12.0Function released in this version.

--- Last Modified: June 02, 2020 | 09:16 AM