Page tree

The license could not be verified: License Certificate has expired!

 

JAVA

FORTRAN

C++

C

 

Link

H5O_GET_NATIVE_INFO_BY_NAME

Retrieve native file format information about an object given its name

Procedure:

H5O_GET_NATIVE_INFO_BY_NAME ( loc_id, name, oinfo, fields, lapl_id )

Signature:

herr_t H5Oget_native_info_by_name(hid_t loc_id, const char *name, H5O_native_info_t *oinfo, 
           unsigned fields, hid_t lapl_id )

Parameters:
hid_t loc_idIN: Identifier of the object
const char *nameIN: Name of object
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_NAME retrieves the native file format information for an object specified by loc_id and the name name. The information is retrieved into the buffer specified by oinfo, which is defined as a struct of type H5O_native_info_t:

src / H5Opublic.h [143:152]  hdf5_1_12  HDFFV/hdf5
/* Native file format information struct for objects */
/* (For H5Oget_native_info / H5Oget_native_info_by_name / H5Oget_native_info_by_idx) */
typedef struct H5O_native_info_t {
    H5O_hdr_info_t      hdr;            /* Object header information */
    /* Extra metadata storage for obj & attributes */
    struct {
        H5_ih_info_t   obj;             /* v1/v2 B-tree & local/fractal heap for groups, B-tree for chunked datasets */
        H5_ih_info_t   attr;            /* v2 B-tree & heap for attributes */
    } meta_size;
} H5O_native_info_t;

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

src / H5Opublic.h [89:91]  hdf5_1_12  HDFFV/hdf5
#define H5O_NATIVE_INFO_HDR            0x0008u         /* Fill in the hdr field */
#define H5O_NATIVE_INFO_META_SIZE      0x0010u         /* Fill in the meta_size field */
#define H5O_NATIVE_INFO_ALL            (H5O_NATIVE_INFO_HDR | H5O_NATIVE_INFO_META_SIZE)

Returns:

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

Example:

test / tfile.c [5247:5250]  hdf5_1_12  HDFFV/hdf5
    /*
     * Make sure the root group still has the correct object header version
     */
    ret = H5Oget_native_info_by_name(file, "/", &ninfo, H5O_NATIVE_INFO_HDR, H5P_DEFAULT);

History:
ReleaseChange
1.12.0Function released in this version.

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