Last modified: 9 October 2014
Name: H5Dget_access_plist

Signature:
hid_t H5Dget_access_plist( hid_t dataset_id )

Purpose:
Returns the dataset access property list associated with a dataset.

Description:
H5Dget_access_plist returns a copy of the dataset access property list used to open the specified dataset. Modifications to the returned property list will have no effect on the dataset it was retrieved from.

The chunk cache parameters in the returned property lists will be those used by the dataset. If the properties in the file access property list were used to determine the dataset's chunk cache configuration, then those properties will be present in the returned dataset access property list. If the dataset does not use a chunked layout, then the chunk cache properties will be set to the default. The chunk cache properties in the returned list are considered to be “set”, and any use of this list will override the corresponding properties in the file’s file access property list.

All link access properties in the returned list will be set to the default values.

The access property list identifier should be released with H5Pclose when the identifier is no longer needed so that resource leaks will not develop.

Parameters:
hid_t dataset_id      IN: Identifier of the dataset to get access property list of.

Returns:
Returns a dataset access property list identifier if successful; otherwise returns a negative value.

Example Usage:
The following code retrieves the dataset access property list used to open the dataset dataset_id into dapl_id: 
dapl_id = H5Dget_access_plist(dataset_id);

See Also:
“Dataset Access Properties” in the “H5P: Property List Interface” chapter of the HDF5 Reference Manual
“Using Identifiers”

History:
Release     Change
1.8.3 C function introduced in this release.