H5_core_filehandling

Functions
h5_err_t	h5_check_filehandle (h5_file_t *const f)
h5_err_t	h5_close_file (h5_file_t *const f)
h5_err_t	h5_set_stepname_fmt (h5_file_t *const f, const char *name, int width)
h5_err_t	h5_get_stepname_fmt (h5_file_t *const f, char *name, int l_name, int *width)
h5_id_t	h5_get_step (h5_file_t *const f)
int	h5_get_num_procs (h5_file_t *const f)
hid_t	h5_get_hdf5_file (h5_file_t *const f)
h5_size_t	h5_get_num_steps (h5_file_t *const f)
h5_err_t	h5_start_traverse_steps (h5_file_t *const f)
h5_err_t	h5_traverse_steps (h5_file_t *const f)

---

Function Documentation

h5_err_t h5_check_filehandle

(

h5_file_t *const

f )

Check whether f points to a valid file handle.

Returns:

H5_SUCCESS or error code

Parameters:

f	filehandle to check validity of

h5_err_t h5_close_file

(

h5_file_t *const

f )

The h5_close_file() call writes all buffered data to disk, releases all previously allocated memory and terminates access to the associated HDF5 file.

Returns:

H5_SUCCESS or error code

Parameters:

f	file handle

h5_err_t h5_set_stepname_fmt	(	h5_file_t *const	f,
		const char *	name,
		int	width
	)

Define format of the step names.

Example: ==H5FedDefineStepNameFormat( f, "Step", 6 )== defines step names like ==Step#000042==.

Returns:

H5_SUCCESS or error code

h5_err_t h5_get_stepname_fmt	(	h5_file_t *const	f,
		char *	name,
		int	l_name,
		int *	width
	)

Get format of the step names.

Returns:

H5_SUCCESS or error code

Parameters:

f	Handle to file
name	OUT: Prefix
l_name	length of buffer name
width	OUT: Width of the number

h5_id_t h5_get_step

(

h5_file_t *const

f )

Get current step number.

Returns:

Current step number or error code

Parameters:

f	file handle

int h5_get_num_procs

(

h5_file_t *const

f )

Get number of processes.

Returns:

Number of processes or error code

Parameters:

f	file handle

hid_t h5_get_hdf5_file

(

h5_file_t *const

f )

Provides access to the underlying HDF5 file handle.

Returns:

Number of steps or error code

Parameters:

f	file handle

h5_size_t h5_get_num_steps

(

h5_file_t *const

f )

Get number of steps.

Returns:

Number of steps or error code

Parameters:

f	file handle

h5_err_t h5_start_traverse_steps

(

h5_file_t *const

f )

Start traversing steps.

Returns:

H5_SUCCESS or error code

Parameters:

f	file handle

h5_err_t h5_traverse_steps

(

h5_file_t *const

f )

Go to next step.

Returns:

H5_SUCCESS or error code

Parameters:

f	file handle