H5P_SET_FCLOSE_DEGREE

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
Sets the file close degree

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	procedure

Procedure:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf_procedure

H5P_SET_FCLOSE_DEGREE ( fapl_id, fc_degree )

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 H5Pset_fclose_degree( hid_t fapl_id, H5F_close_degree_t fc_degree ) </code></pre>

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">Fortran90 Interface: h5pset_fclose_degree_f
    
SUBROUTINE h5pset_fclose_degree_f(fapl_id, degree, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: fapl_id  ! File access property list identifier
  INTEGER, INTENT(IN) :: degree          ! Info about file close behavior 
                                         ! Possible values:
                                         !    H5F_CLOSE_DEFAULT_F
                                         !    H5F_CLOSE_WEAK_F
                                         !    H5F_CLOSE_SEMI_F
                                         !    H5F_CLOSE_STRONG_F
  INTEGER, INTENT(OUT) :: hdferr         ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pset_fclose_degree_f
    </code></pre>

Hdf rm anchor

AnchorName	parameters

Parameters:

HTML Wrap

class	hdf-rm-section

hid_t `fapl_id`	IN: File access property list identifier
H5F_close_degree_t `fc_degree`	IN: Pointer to a location containing the file close degree property, the value of `fc_degree`

Hdf rm anchor

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

H5P_SET_FCLOSE_DEGREE sets the file close degree property fc_degree in the file access property list fapl_id.

The value of fc_degree determines how aggressively H5F_CLOSE deals with objects within a file that remain open when H5F_CLOSE is called to close that file. fc_degree can have any one of four valid values:

Degree name	`H5Fclose` behavior with no open object in file	`H5Fclose` behavior with open object(s) in file
`H5F_CLOSE_WEAK`	Actual file is closed.	Access to file identifier is terminated; actual file close is delayed until all objects in file are closed
`H5F_CLOSE_SEMI`	Actual file is closed.	Function returns FAILURE
`H5F_CLOSE_STRONG`	Actual file is closed.	All open objects remaining in the file are closed then file is closed
`H5F_CLOSE_DEFAULT`	The VFL driver chooses the behavior. Currently, all VFL drivers set this value to `H5F_CLOSE_WEAK`, except for the MPI-I/O driver, which sets it to `H5F_CLOSE_SEMI`.

Note that if a file is opened multiple times without being closed, each open operation must use the same file close degree setting. For example, if a file is already open with H5F_CLOSE_WEAK, an

H5Fopen

H5F_OPEN call with H5F_CLOSE_STRONG will fail.

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

Coming Soon!

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

C

Change
1.6.0	Function introduced in this release.

Page tree

Versions Compared

Old Version 3

New Version Current

Key

Procedure:

Signature:

Parameters:

Description:

Returns:

Example:

History:

The HDF Group

Site

Resources

Connect