Name: H5Pset_space_time

Signature:

herr_t H5Pset_space_time(hid_t plist, H5D_space_time_t alloc_time)

Purpose:

Set the time of data space allocation for a dataset when a dataset is created.

Description:

This function is mainly used with fill value and fill value write time properties. It tells when to allocate data space for a dataset. Valid values alloc_time are:

H5D_EARLY

Allocate dataset space as early as the dataset is created.

H5D_LATE

Allocate dataset space as late as dataset is needed for writing user data.

Parameters:

hid_t plist

IN: Identifier of dataset creation property list to set.

H5D_space_time_t alloc_time

IN: Time to allocate space for dataset.

Return:

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

Name: H5Pget_space_time

Signature:

herr_t H5Pget_space_time(hid_t plist, H5D_space_time_t *alloc_time)

Purpose:

Retrieve the time of data space allocation for a dataset.

Description:

This function gets the space allocation time property for a dataset creation property list. Valid values alloc_time are:

H5D_EARLY

Allocate dataset space as early as the dataset is created.

H5D_LATE

Allocate dataset space as late as dataset is needed for writing user data.

Parameters:

hid_t plist

IN: Identifier of dataset creation property list to query.

H5D_space_time_t *alloc_time

OUT: When to allocate space for dataset.

Return:

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

Name: H5Pset_fill_time

Signature:

herr_t H5Pset_fill_time(hid_t plist, H5D_fill_time_t fill_time)

Purpose:

Set the time of writing fill value for a dataset.

Description:

This function is mainly use with space allocation time and fill value properties. It tells when to write fill value to a dataset. Valid values fill_time are:

H5D_NEVER

Never write fill value to dataset.

H5D_ALLOC

Write fill value to entire dataset once data space is allocated.

Parameters:

hid_t plist

IN: Identifier of dataset creation property list to set.

H5D_fill_time_t fill_time

IN: When to write fill value to a dataset.

Return:

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

Name: H5Pget_fill_time

Signature:

herr_t H5Pget_fill_time(hid_t plist, H5D_fill_time_t *fill_time)

Purpose:

Retrieve the time of writing fill value property.

Description:

This function gets the fill value writing time property for a dataset creation property list. Valid values fill_time are:

H5D_NEVER

Never write fill value to dataset.

H5D_ALLOC

Write fill value to entire dataset once data space is allocated.

Parameters:

hid_t plist

IN: Identifier of dataset creation property list to query.

H5D_fill_time_t *fill_time

OUT: When to write fill value for dataset.

Return:

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

Name: H5Pset_fill_value

Signature:

herr_t H5Pset_fill_value(hid_t plist, hid_t type_id, const void *value)

Purpose:

Sets a dataset fill value.

Description:

H5Pset_fill_value sets the fill value for a dataset creation property list. The value

is integrated as being of type type_id. This needs not be the same type as the dataset, but the library must be able to convert value to the dataset type when the dataset is created.

The library define 0 as the default fill value. If user sets the fill value as NULL (type_id can be any value), the library will interpret it as undefined.

Parameters:

hid_t plist

IN: Dataset creation property list identifier.

hid_t type_id

IN: The datatype identifier of value.

const void *value

IN: The fill value.

Returns:

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

Name: H5Pfill_value_defined

Signature:

htri_t H5Pfill_value_defined(hid_t plist)

Purpose:

Check if fill value is defined.

Description:

This function checks if the fill value property in dataset creation property list is defined.

Parameters:

hid_t plist

IN: Dataset creation property list identifier.

Returns:

Returns a positive value for TRUE, or 0(zero) for FALSE if successful; otherwise

Returns negative.

Name: H5Pget_fill_value

Signature:

herr_t H5Pget_fill_value(hid_t plist, hid_t type_id, void *value)

Purpose:

Retrieves a dataset fill value.

Description:

H5Pget_fill_value queries the fill value property of a dataset creation property list if the fill value is defined(use H5Pfill_value_defined to check). The fill value is returned through the value pointer. Memory is supposed to be allocated by caller. The fill value will be converted from its current datatype to the type specified by type_id.

Parameters:

hid_t plist

IN: Dataset creation property list identifier.

hid_t type_id

IN: The datatype identifier of value.

void *value

OUT: The fill value to be returned.

Returns:

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

Name:

H5Dget_space_status

Signature:

herr_t H5Dget_space_status(hid_t dataset, H5D_space_status_t *allocation)

Purpose:

Check the status of space allocation.

Description:

This function returns the status of space allocation for both contiguous and chunked dataspace. Valid values for allocation are:

H5D_ALLOCATED

Dataset space has been allocated. For chunked dataset, it means all

chunked space are allocated.

H5D_NOT_ALLOCATED

Dataset space has not been allocated.

H5D_PART_ALLOCATED

This value is only for chunked dataset, which means only some, not all of dataset chunks have been allocated.

Parameters:

hid_t dataset

IN: Identifier of dataset to be querried.

H5D_space_status_t *allocation

OUT: Whether dataspace has been allocated.

Return:

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