File Creation Properties

Functions
H5_DLL herr_t	H5Pget_sizes (hid_t plist_id, size_t *sizeof_addr, size_t *sizeof_size)
	Retrieves the size of the offsets and lengths used in an HDF5 file. More...
H5_DLL herr_t	H5Pget_userblock (hid_t plist_id, hsize_t *size)
	Retrieves the size of a user block. More...
H5_DLL herr_t	H5Pset_sizes (hid_t plist_id, size_t sizeof_addr, size_t sizeof_size)
	Sets the byte size of the offsets and lengths used to address objects in an HDF5 file. More...
H5_DLL herr_t	H5Pset_userblock (hid_t plist_id, hsize_t size)
	Sets user block size. More...

Detailed Description

Function Documentation

H5Pget_sizes()

herr_t H5Pget_sizes	(	hid_t	plist_id,
		size_t *	sizeof_addr,
		size_t *	sizeof_size
	)

Retrieves the size of the offsets and lengths used in an HDF5 file.

---

Parameters

[in]	plist_id	File creation property list identifier
[out]	sizeof_addr	Pointer to location to return offset size in bytes
[out]	sizeof_size	Pointer to location to return length size in bytes

Returns

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

H5Pget_sizes() retrieves the size of the offsets and lengths used in an HDF5 file. This function is only valid for file creation property lists.

Since

1.0.0

H5Pget_userblock()

herr_t H5Pget_userblock	(	hid_t	plist_id,
		hsize_t *	size
	)

Retrieves the size of a user block.

---

Parameters

[in]	plist_id	File creation property list identifier
[out]	size	Pointer to location to return user-block size

Returns

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

H5Pget_userblock() retrieves the size of a user block in a file creation property list.

Since

1.0.0

H5Pset_sizes()

herr_t H5Pset_sizes	(	hid_t	plist_id,
		size_t	sizeof_addr,
		size_t	sizeof_size
	)

Sets the byte size of the offsets and lengths used to address objects in an HDF5 file.

---

Parameters

[in]	plist_id	File creation property list identifier
[in]	sizeof_addr	Size of an object offset in bytes
[in]	sizeof_size	Size of an object length in bytes

Returns

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

H5Pset_sizes() sets the byte size of the offsets and lengths used to address objects in an HDF5 file. This function is only valid for file creation property lists. Passing in a value of 0 for one of the parameters retains the current value. The default value for both values is the same as sizeof(hsize_t) in the library (normally 8 bytes). Valid values currently are 2, 4, 8 and 16.

Since

1.0.0

H5Pset_userblock()

herr_t H5Pset_userblock	(	hid_t	plist_id,
		hsize_t	size
	)

Sets user block size.

---

Parameters

[in]	plist_id	File creation property list identifier
[in]	size	Size of the user-block in bytes

Returns

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

H5Pset_userblock() sets the user block size of a file creation property list. The default user block size is 0; it may be set to any power of 2 equal to 512 or greater (512, 1024, 2048, etc.).

Since

1.0.0