Page tree

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

 

JAVA

FORTRAN

C++

C

 

Link

H5R_GET_FILE_NAME

Retrieves the file name for a referenced object

Procedure:

H5R_GET_FILE_NAME ( ref_ptr, name, size )

Signature:

ssize_t H5Rget_file_name ( const H5R_ref_t *ref_ptr, char *name, size_t size)

Replace this text with the Fortran function signature

Parameters:
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];

char * nameIN/OUT: A buffer to place the file name of the reference
size_t sizeIN: The size of the name buffer

Description:

H5R_GET_FILE_NAME retrieves the file name for the object, region or attribute reference pointed to by ref_ptr. Up to size characters of the name are returned in name; additional characters, if any, are not returned to the user application. If the length of the name, which determines the required value of size, is unknown, a preliminary H5R_GET_FILE_NAME call can be made. The return value of this call will be the size of the file name. That value can then be assigned to size for a second H5R_GET_FILE_NAME call, which will retrieve the actual name.

Returns:

Returns the length of the name if successful. Otherwise returns a negative value.

Example:

Coming Soon!

History:
ReleaseChange
1.12.0C function was introduced in this release.

--- Last Modified: October 21, 2019 | 01:25 PM