| Class Identifier | *Class Name | *Comments | *
|---|---|---|
| #H5P_ATTRIBUTE_CREATE | *attribute create | *Properties for attribute creation | *
| #H5P_DATASET_ACCESS | *dataset access | *Properties for dataset access | *
| #H5P_DATASET_CREATE | *dataset create | *Properties for dataset creation | *
| #H5P_DATASET_XFER | *data transfer | *Properties for raw data transfer | *
| #H5P_DATATYPE_ACCESS | *datatype access | *Properties for datatype access | *
| #H5P_DATATYPE_CREATE | *datatype create | *Properties for datatype creation | *
| #H5P_FILE_ACCESS | *file access | *Properties for file access | *
| #H5P_FILE_CREATE | *file create | *Properties for file creation | *
| #H5P_FILE_MOUNT | *file mount | *Properties for file mounting | *
| #H5P_GROUP_ACCESS | *group access | *Properties for group access | *
| #H5P_GROUP_CREATE | *group create | *Properties for group creation | *
| #H5P_LINK_ACCESS | *link access | *Properties governing link traversal when accessing objects | *
| #H5P_LINK_CREATE | *link create | *Properties governing link creation | *
| #H5P_OBJECT_COPY | *object copy | *Properties governing the object copying process | *
| #H5P_OBJECT_CREATE | *object create | *Properties for object creation | *
| #H5P_STRING_CREATE | *string create | *Properties for character encoding when encoding strings or * object names | *
| #H5P_VOL_INITIALIZE | *vol initialize | *Properties for VOL initialization | *
| Class Name (class identifier) Returned | *Property List Class | *Expanded Name of the Property List Class | *The Class Identifier Used with H5Pcreate | *Comments | *
|---|---|---|---|---|
| attribute create | *acpl | *Attribute Creation Property List | *H5P_ATTRIBUTE_CREATE | ** |
| dataset access | *dapl | *Dataset Access Property List | *H5P_DATASET_ACCESS | ** |
| dataset create | *dcpl | *Dataset Creation Property List | *H5P_DATASET_CREATE | ** |
| data transfer | *dxpl | *Data Transfer Property List | *H5P_DATASET_XFER | ** |
| datatype access | ** | * | H5P_DATATYPE_ACCESS | *This class can be created, but there are no properties * in the class currently. * | *
| datatype create | ** | * | H5P_DATATYPE_CREATE | *This class can be created, but there * are no properties in the class currently. | *
| file access | *fapl | *File Access Property List | *H5P_FILE_ACCESS | ** |
| file create | *fcpl | *File Creation Property List | *H5P_FILE_CREATE | ** |
| file mount | *fmpl | *File Mount Property List | *H5P_FILE_MOUNT | ** |
| group access | ** | * | H5P_GROUP_ACCESS | *This class can be created, but there * are no properties in the class currently. | *
| group create | *gcpl | *Group Creation Property List | *H5P_GROUP_CREATE | ** |
| link access | *lapl | *Link Access Property List | *H5P_LINK_ACCESS | ** |
| link create | *lcpl | *Link Creation Property List | *H5P_LINK_CREATE | ** |
| object copy | *ocpypl | *Object Copy Property List | *H5P_OBJECT_COPY | ** |
| object create | *ocpl | *Object Creation Property List | *H5P_OBJECT_CREATE | ** |
| string create | *strcpl | *String Creation Property List | *H5P_STRING_CREATE | ** |
| \ref hid_t \c prop_id | *IN: The identifier of the property list being * modified | *
| \Code{const char * name} | *IN: The name of the property being modified | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{void * value} | *IN: Pointer to new value pointer for the property * being modified | *
| \ref hid_t \c prop_id | *IN: The identifier of the property list being queried | *
| \Code{const char * name} | *IN: The name of the property being queried | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{void * value} | *IN: The value of the property being returned | *
| \ref hid_t \c prop_id | *IN: The identifier of the property list the property is * being deleted from | *
| \Code{const char * name} | *IN: The name of the property in the list | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{void * value} | *IN: The value for the property being deleted | *
| \Code{const char * name} | *IN: The name of the property being copied | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{void * value} | *IN/OUT: The value for the property being copied | *
| \Code{const void * value1} | *IN: The value of the first property to compare | *
| \Code{const void * value2} | *IN: The value of the second property to compare | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{const char * name} | *IN: The name of the property in the list | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{void * value} | *IN: The value for the property being closed | *
| \Code{const char * name} | *IN: The name of the property being modified | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{void * value} | *IN/OUT: The default value for the property being created, * which will be passed to H5Pregister2() | *
| \ref hid_t \c prop_id | *IN: The identifier of the property list being modified | *
| \Code{const char * name} | *IN: The name of the property being modified | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{void *value} | *IN/OUT: Pointer to new value pointer for the property * being modified | *
| \ref hid_t \c prop_id | *IN: The identifier of the property list being * queried | *
| \Code{const char * name} | *IN: The name of the property being queried | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{void * value} | *IN/OUT: The value of the property being returned | *
| \ref hid_t \c prop_id | *IN: The identifier of the property list the property is * being deleted from | *
| \Code{const char * name} | *IN: The name of the property in the list | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{void * value} | *IN: The value for the property being deleted | *
| \Code{const char * name} | *IN: The name of the property being copied | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{void * value} | *IN/OUT: The value for the property being copied | *
| \Code{const void * value1} | *IN: The value of the first property to compare | *
| \Code{const void * value2} | *IN: The value of the second property to compare | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{const char * name} | *IN: The name of the property in the list | *
| \Code{size_t size} | *IN: The size of the property in bytes | *
| \Code{void * value} | *IN: The value for the property being closed | *
| #H5P_CRT_ORDER_TRACKED | *Attribute creation order is tracked but not necessarily * indexed. | *
| #H5P_CRT_ORDER_INDEXED | *Attribute creation order is indexed (requires * #H5P_CRT_ORDER_TRACKED). | *
| #H5Z_FILTER_ALL | *Removes all filters from the filter pipeline | *
| #H5Z_FILTER_DEFLATE | *Data compression filter, employing the gzip * algorithm | *
| #H5Z_FILTER_SHUFFLE | *Data shuffling filter | *
| #H5Z_FILTER_FLETCHER32 | *Error detection filter, employing the Fletcher32 * checksum algorithm | *
| #H5Z_FILTER_SZIP | *Data compression filter, employing the SZIP * algorithm | *
| #H5Z_FILTER_NBIT | *Data compression filter, employing the N-Bit * algorithm | *
| #H5Z_FILTER_SCALEOFFSET | *Data compression filter, employing the scale-offset * algorithm | *
| #H5P_CRT_ORDER_TRACKED | *Attribute creation order is tracked but not necessarily * indexed. | *
| #H5P_CRT_ORDER_INDEXED | *Attribute creation order is indexed (requires * #H5P_CRT_ORDER_TRACKED). | *
| Compression Level | *Gzip Action | *
|---|---|
| 0 | *No compression | *
| 1 | *Best compression speed; least compression | *
| 2 through 8 | *Compression improves; speed degrades | *
| 9 | *Best compression ratio; slowest speed | *
| #H5Z_FLAG_OPTIONAL | *If this bit is set then the filter is optional. If the
* filter fails (see below) during an H5Dwrite() operation
* then the filter is just excluded from the pipeline for
* the chunk for which it failed; the filter will not
* participate in the pipeline during an H5Dread() of the
* chunk. This is commonly used for compression filters:
* if the filter result would be larger than the input,
* then the compression filter returns failure and the
* uncompressed data is stored in the file. * This flag should not be set for the Fletcher32 checksum * filter as it will bypass the checksum filter without * reporting checksum errors to an application. |
*
| #H5Z_FLAG_MANDATORY | *If the filter is required, that is, set to mandatory,
* and the filter fails, the library's behavior depends
* on whether the chunk cache is in use:
* \li If the chunk cache is enabled, data chunks will
* be flushed to the file during H5Dclose() and the
* library will return the failure in H5Dclose().
* \li When the chunk cache is disabled or not big enough,
* or the chunk is being evicted from the cache, the
* failure will happen during H5Dwrite().
*
* In each case, the library will still write to the file
* all data chunks that were processed by the filter
* before the failure occurred. * For example, assume that an application creates a * dataset of four chunks, the chunk cache is enabled and * is big enough to hold all four chunks, and the filter * fails when it tries to write the fourth chunk. The * actual flush of the chunks will happen during * H5Dclose(), not H5Dwrite(). By the time H5Dclose() * fails, the first three chunks will have been written * to the file. Even though H5Dclose() fails, all the * resources will be released and the file can be closed * properly. * If, however, the filter fails on the second chunk, only * the first chunk will be written to the file as nothing * further can be written once the filter fails. |
*
| #H5Z_FILTER_DEFLATE | *Data compression filter, employing the gzip * algorithm | *
| #H5Z_FILTER_SHUFFLE | *Data shuffling filter | *
| #H5Z_FILTER_FLETCHER32 | *Error detection filter, employing the Fletcher32 * checksum algorithm | *
| #H5Z_FILTER_SZIP | *Data compression filter, employing the SZIP * algorithm | *
| #H5Z_FILTER_NBIT | *Data compression filter, employing the N-Bit * algorithm | *
| #H5Z_FILTER_SCALEOFFSET | *Data compression filter, employing the scale-offset * algorithm | *
| * | Required FILTER_X not available | *FILTER_X available | *
|---|---|---|
| H5Pset_ |
* Will fail. | *Will succeed. | *
| H5Dwrite with FILTER_X set | *Will fail. | *Will succeed; FILTER_X will be applied to * the data. | *
| H5Dread with FILTER_X set | *Will fail. | *Will succeed. | *
| * | FILTER_Z not available | *FILTER_Z available with encode and decode |
* FILTER_Z available decode only | *
|---|---|---|---|
| H5Pset_ |
* Will succeed. | *Will succeed. | *Will succeed. | *
| H5Dread with FILTER_Z set | *Will succeed if FILTER_Z has not actually * been applied to data. |
* Will succeed. | *Will succeed. | *
| H5Dwrite with FILTER_Z set | *Will succeed; * FILTER_Z will not be applied to the data. |
* Will succeed; * FILTER_Z will be applied to the data. |
* Will succeed; * FILTER_Z will not be applied to the data. |
*
| #H5O_SHMESG_NONE_FLAG | *No shared messages | *
| #H5O_SHMESG_SDSPACE_FLAG | *Simple dataspace message | *
| #H5O_SHMESG_DTYPE_FLAG | *Datatype message | *
| #H5O_SHMESG_FILL_FLAG | *Fill value message | *
| #H5O_SHMESG_PLINE_FLAG | *Filter pipeline message | *
| #H5O_SHMESG_ATTR_FLAG | *Attribute message | *
| #H5O_SHMESG_ALL_FLAG | *All message types; i.e., equivalent to the following: * (#H5O_SHMESG_SDSPACE_FLAG | #H5O_SHMESG_DTYPE_FLAG | * #H5O_SHMESG_FILL_FLAG | #H5O_SHMESG_PLINE_FLAG | * #H5O_SHMESG_ATTR_FLAG) | *
| 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. | ** |
| Value of \p low and \p high | *Result | *
|---|---|
| \p low=#H5F_LIBVER_EARLIEST * \p high=#H5F_LIBVER_V18 |
* * \li The library will create objects with the earliest * possible format versions. * \li The library will allow objects to be created with the * latest format versions available to library release 1.8.x. * \li API calls that create objects or features that are * available to versions of the library greater than 1.8.x * release will fail. | *
| \p low=#H5F_LIBVER_EARLIEST * \p high=#H5F_LIBVER_V110 |
* * \li The library will create objects with the earliest possible * format versions. * \li The library will allow objects to be created with the latest * format versions available to library release 1.10.x. * \li API calls that create objects or features that are * available to versions of the library greater than 1.10.x * release will fail. | *
| \p low=#H5F_LIBVER_EARLIEST * \p high=#H5F_LIBVER_V112 |
* * \li The library will create objects with the earliest possible * format versions. * \li The library will allow objects to be created with the latest * format versions available to library release 1.12.x. * \li API calls that create objects or features that are * available to versions of the library greater than 1.12.x * release will fail. | *
| \p low=#H5F_LIBVER_EARLIEST * \p high=#H5F_LIBVER_V114 |
* * \li The library will create objects with the earliest possible * format versions. * \li The library will allow objects to be created with the latest * format versions available to library release 1.14.x. * \li API calls that create objects or features that are * available to versions of the library greater than 1.14.x * release will fail. | *
| \p low=#H5F_LIBVER_EARLIEST * \p high=#H5F_LIBVER_V116 |
* * \li The library will create objects with the earliest possible * format versions. * \li The library will allow objects to be created with the latest * format versions available to library release 1.16.x. See * note *H5F_LIBVER_LATEST* below the table. * \li This is the library default setting and provides the greatest * format compatibility. | *
| \p low=#H5F_LIBVER_V18 * \p high=#H5F_LIBVER_V18 |
* * \li The library will create objects with the latest format * versions available to library release 1.8.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.8.x. * \li The objects written with this setting may be * accessible to a smaller range of library versions than * would be the case if low is set to #H5F_LIBVER_EARLIEST. * \li API calls that create objects or features that are available * to versions of the library greater than 1.8.x release will * fail. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V18 * \p high=#H5F_LIBVER_V110 |
* * \li The library will create objects with the latest format * versions available to library release 1.8.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.10.x. * \li API calls that create objects or features that are * available to versions of the library greater than 1.10.x * release will fail. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V18 * \p high=#H5F_LIBVER_V112 |
* * \li The library will create objects with the latest format * versions available to library release 1.8.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.12.x. * \li API calls that create objects or features that are * available to versions of the library greater than 1.12.x * release will fail. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V18 * \p high=#H5F_LIBVER_V114 |
* * \li The library will create objects with the latest format * versions available to library release 1.8.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.14.x. * \li API calls that create objects or features that are * available to versions of the library greater than 1.14.x * release will fail. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V18 * \p high=#H5F_LIBVER_V116 |
* * \li The library will create objects with the latest format * versions available to library release 1.8.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.16.x. See * note *H5F_LIBVER_LATEST* below the table. * \li This setting allows users to take advantage of the latest * features and performance enhancements in the library. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V110 * \p high=#H5F_LIBVER_V110 |
* * \li The library will create objects with the latest format * versions available to library release 1.10.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.10.x. * \li The objects written with this setting may be * accessible to a smaller range of library versions than * would be the case if low is set to #H5F_LIBVER_EARLIEST. * \li API calls that create objects or features that are available * to versions of the library greater than 1.10.x release will * fail. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V110 * \p high=#H5F_LIBVER_V112 |
* * \li The library will create objects with the latest format * versions available to library release 1.10.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.12.x. * \li API calls that create objects or features that are available * to versions of the library greater than 1.12.x release will * fail. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V110 * \p high=#H5F_LIBVER_V114 |
* * \li The library will create objects with the latest format * versions available to library release 1.10.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.14.x. * \li API calls that create objects or features that are available * to versions of the library greater than 1.14.x release will * fail. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V110 * \p high=#H5F_LIBVER_V116 |
* * \li The library will create objects with the latest format * versions available to library release 1.10.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.16.x. See * note *H5F_LIBVER_LATEST* below the table. * \li This setting allows users to take advantage of the latest * features and performance enhancements in the library. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V112 * \p high=#H5F_LIBVER_V112 |
* * \li The library will create objects with the latest format * versions available to library release 1.12.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.12.x. * \li The objects written with this setting may be * accessible to a smaller range of library versions than * would be the case if low is set to #H5F_LIBVER_EARLIEST. * \li API calls that create objects or features that are available * to versions of the library greater than 1.12.x release will * fail. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V112 * \p high=#H5F_LIBVER_V114 |
* * \li The library will create objects with the latest format * versions available to library release 1.12.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.14.x. * \li API calls that create objects or features that are available * to versions of the library greater than 1.14.x release will * fail. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V112 * \p high=#H5F_LIBVER_V116 |
* * \li The library will create objects with the latest format * versions available to library release 1.12.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.16.x. See * note *H5F_LIBVER_LATEST* below the table. * \li This setting allows users to take advantage of the latest * features and performance enhancements in the library. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V114 * \p high=#H5F_LIBVER_V114 |
* * \li The library will create objects with the latest format * versions available to library release 1.14.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.14.x. * \li The objects written with this setting may be * accessible to a smaller range of library versions than * would be the case if low is set to #H5F_LIBVER_EARLIEST. * \li API calls that create objects or features that are available * to versions of the library greater than 1.14.x release will * fail. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V114 * \p high=#H5F_LIBVER_V116 |
* * \li The library will create objects with the latest format * versions available to library release 1.14.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.16.x. See * note *H5F_LIBVER_LATEST* below the table. * \li This setting allows users to take advantage of the latest * features and performance enhancements in the library. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| \p low=#H5F_LIBVER_V116 * \p high=#H5F_LIBVER_V116 |
* * \li The library will create objects with the latest format * versions available to library release 1.16.x. * \li The library will allow objects to be created with the latest * format versions available to library release 1.16.x. See * note *H5F_LIBVER_LATEST* below the table. * \li This setting allows users to take advantage of the latest * features and performance enhancements in the library. * However, objects written with this setting may be * accessible to a smaller range of library versions than * would be the case if low is set to #H5F_LIBVER_EARLIEST. * \li Earlier versions of the library may not be able to access * objects created with this setting. | *
| #H5FD_MEM_SUPER | Super block data | *
| #H5FD_MEM_BTREE | B-tree data | *
| #H5FD_MEM_DRAW | Dataset raw data | *
| #H5FD_MEM_GHEAP | Global heap data | *
| #H5FD_MEM_LHEAP | Local Heap data | *
| #H5FD_MEM_OHDR | Object header data | *
| #H5D_FILL_VALUE_UNDEFINED | *Fill value is undefined. | *
| #H5D_FILL_VALUE_DEFAULT | *Fill value is the library default. | *
| #H5D_FILL_VALUE_USER_DEFINED | *Fill value is defined by the application. | *
| #H5D_ALLOC_TIME_DEFAULT |
* Uses the default allocation time, based on the dataset
* storage method. See the \p alloc_time description in * H5Pset_alloc_time() for default allocation times for * various storage methods. |
*
| #H5D_ALLOC_TIME_EARLY | *All space is allocated when the dataset is created. | *
| #H5D_ALLOC_TIME_INCR | *Space is allocated incrementally as data is written * to the dataset. | *
| #H5D_ALLOC_TIME_LATE | *All space is allocated when data is first written to * the dataset. | *
| #H5D_FILL_TIME_IFSET | *Fill values are written to the dataset when storage * space is allocated only if there is a user-defined fill * value, i.e., one set with H5Pset_fill_value(). (Default) * | *
| #H5D_FILL_TIME_ALLOC | *Fill values are written to the dataset when storage * space is allocated. | *
| #H5D_FILL_TIME_NEVER | *Fill values are never written to the dataset. | *
| #H5D_ALLOC_TIME_DEFAULT | *Allocate dataset storage space at the default time * (Defaults differ by storage method.) |
*
| #H5D_ALLOC_TIME_EARLY | *Allocate all space when the dataset is created * (Default for compact datasets.) |
*
| #H5D_ALLOC_TIME_INCR | *Allocate space incrementally, as data is written to
* the dataset (Default for chunked storage datasets.) * * \li Chunked datasets: Storage space allocation for each * chunk is deferred until data is written to the chunk. * \li Contiguous datasets: Incremental storage space * allocation for contiguous data is treated as late * allocation. * \li Compact datasets: Incremental allocation is not * allowed with compact datasets; H5Pset_alloc_time() * will return an error. |
*
| #H5D_ALLOC_TIME_LATE | *Allocate all space when data is first written to the
* dataset * (Default for contiguous datasets.) |
*
| #H5D_FILL_TIME_IFSET | *Write fill values to the dataset when storage space is * allocated only if there is a user-defined fill value, * i.e.,one set with H5Pset_fill_value(). (Default) | *
| #H5D_FILL_TIME_ALLOC | *Write fill values to the dataset when storage space is * allocated. | *
| #H5D_FILL_TIME_NEVER | *Never write fill values to the dataset. | *
* hid_t nbit_datatype = H5Tcopy(H5T_STD_I32LE); * H5Tset_precision(nbit_datatype, 16); * H5Tset_offset(nbit_datatype, 4); ** * In memory, one value of the N-Bit datatype in the above example * will be stored on a little-endian machine as follows: * *
| byte 3 | *byte 2 | *byte 1 | *byte 0 | *
| ???????? | *????SPPP | *PPPPPPPP | *PPPP???? | *
| 1st value | *2nd value | *... | *
| SPPPPPPPPPPPPPPP | *SPPPPPPPPPPPPPPP | *... | *
| #H5Z_SO_FLOAT_DSCALE (0) | *Floating-point type, using variable MinBits method | *
| #H5Z_SO_FLOAT_ESCALE (1) | *Floating-point type, using fixed MinBits method | *
| #H5Z_SO_INT (2) | *Integer type | *
| \p scale_type value | *\p scale_factor description | *
|---|---|
| #H5Z_SO_FLOAT_DSCALE | *Denotes the decimal scale factor for D-scaling and can be * positive, negative or zero. This is the current * implementation of the library. | *
| #H5Z_SO_FLOAT_ESCALE | *Denotes MinBits for E-scaling and must be a positive integer. * This is not currently implemented by the library. | *
| #H5Z_SO_INT | *Denotes MinBits and it should be a positive integer or * #H5Z_SO_INT_MINBITS_DEFAULT (0). If it is less than 0, the * library will reset it to 0 since it is not implemented. * | *
| Option | *Description (Mutually exclusive; select one.) | *
|---|---|
| #H5_SZIP_EC_OPTION_MASK | *Selects entropy coding method | *
| #H5_SZIP_NN_OPTION_MASK | *Selects nearest neighbor coding method | *
| \Code{"%%"} | *Replaced with a single \Code{"%"} (percent) character. | *
"% |
* Where " is the virtual dataset dimension axis (0-based)
* and \Code{"b"} indicates that the block count of the selection in that
* dimension should be used. The full expression (for example, \Code{"%0b"})
* is replaced with a single numeric value when the mapping is evaluated at
* VDS access time. Example code for many source and virtual dataset mappings
* is available in the "Examples of Source to Virtual Dataset Mapping"
* chapter in the
*
* RFC: HDF5 Virtual Dataset.
* |
*
| #H5P_CRT_ORDER_TRACKED | *Link creation order is tracked but not necessarily * indexed | *
| #H5P_CRT_ORDER_INDEXED | *Link creation order is indexed (requires * #H5P_CRT_ORDER_TRACKED) | *
* unsigned acc_flags; * status = H5Pget_elink_acc_flags(lapl_id, &acc_flags); ** * \since 1.8.3 * */ H5_DLL herr_t H5Pget_elink_acc_flags(hid_t lapl_id, unsigned *flags); /** * \ingroup LAPL * * \brief Retrieves the external link traversal callback function from the * specified link access property list * * \lapl_id * \param[out] func User-defined external link traversal callback * function * \param[out] op_data User-defined input data for the callback function * * \return \herr_t * * \details H5Pget_elink_cb() retrieves the user-defined external link * traversal callback function defined in the specified link * access property list. * * The callback function may adjust the file access property * list and file access flag to use when opening a file through * an external link. The callback will be executed by the HDF5 * library immediately before opening the target file. * * Failure Modes: H5Pget_elink_cb() will fail if the link * access property list identifier, \p lapl_id, is invalid. * * An invalid function pointer or data pointer, \p func or * \p op_data respectively, may cause a segmentation fault or an * invalid memory access. * * Example Usage: The following code retrieves the external * link callback settings on the link access property list * \p lapl_id into local variables: *
* H5L_elink_traverse_t elink_callback_func; * void *elink_callback_udata; * status = H5Pget_elink_cb (lapl_id, &elink_callback_func, * &elink_callback_udata); ** * \since 1.8.3 * */ H5_DLL herr_t H5Pget_elink_cb(hid_t lapl_id, H5L_elink_traverse_t *func, void **op_data); /** * \ingroup LAPL * * \brief Retrieves the file access property list identifier associated * with the link access property list * * \lapl_id * * \return \hid_t{file access property list} * * \details H5Pget_elink_fapl() retrieves the file access property list * identifier that is set for the link access property list * identifier, \p lapl_id. The library uses this file access * property list identifier to open the target file for the * external link access. When no such identifier is set, this * routine returns #H5P_DEFAULT. * * \see H5Pset_elink_fapl() and H5Lcreate_external(). * * \since 1.8.0 * */ H5_DLL hid_t H5Pget_elink_fapl(hid_t lapl_id); /** * \ingroup LAPL * * \brief Retrieves prefix applied to external link paths * * \lapl_id{plist_id} * \param[out] prefix Prefix applied to external link paths * \param[in] size Size of prefix, including null terminator * * \return If successful, returns a non-negative value specifying the size * in bytes of the prefix without the NULL terminator; otherwise * returns a negative value. * * \details H5Pget_elink_prefix() retrieves the prefix applied to the * path of any external links traversed. * * When an external link is traversed, the prefix is retrieved * from the link access property list \p plist_id, returned in * the user-allocated buffer pointed to by \p prefix, and * prepended to the filename stored in the external link. * * The size in bytes of the prefix, including the NULL terminator, * is specified in \p size. If size is unknown, a preliminary * H5Pget_elink_prefix() call with the pointer \p prefix set to * NULL will return the size of the prefix without the NULL * terminator. * * \since 1.8.0 * */ H5_DLL ssize_t H5Pget_elink_prefix(hid_t plist_id, char *prefix, size_t size); /** * \ingroup LAPL * * \brief Retrieves the maximum number of link traversals * * \lapl_id{plist_id} * \param[out] nlinks Maximum number of links to traverse * * \return \herr_t * * \details H5Pget_nlinks() retrieves the maximum number of soft or * user-defined link traversals allowed, \p nlinks, before the * library assumes it has found a cycle and aborts the traversal. * This value is retrieved from the link access property list * \p plist_id. * * The limit on the number of soft or user-defined link traversals * is designed to terminate link traversal if one or more links * form a cycle. User control is provided because some files may * have legitimate paths formed of large numbers of soft or * user-defined links. This property can be used to allow * traversal of as many links as desired. * * \since 1.8.0 * */ H5_DLL herr_t H5Pget_nlinks(hid_t plist_id, size_t *nlinks); /** * \ingroup LAPL * * \brief Sets the external link traversal file access flag in a link * access property list * * \lapl_id * \param[in] flags The access flag for external link traversal * * \return \herr_t * * \details H5Pset_elink_acc_flags() specifies the file access flag to use * to open the target file of an external link. This allows * read-only access of files reached through an external link in * a file opened with write access, or vice-versa. * * Valid values for \p flags include: * \li #H5F_ACC_RDWR - Causes files opened through external links * to be opened with write access * \li #H5F_ACC_RDONLY - Causes files opened through external * links to be opened with read-only access * \li #H5F_ACC_DEFAULT - Removes any external link file access * flag setting from \p lapl_id, causing the file access flag * setting to be taken from the parent file * * The library will normally use the file access flag used to * open the parent file as the file access flag for the target * file. This function provides a way to override that behavior. * The external link traversal callback function set by * H5Pset_elink_cb() can override the setting from * H5Pset_elink_acc_flags(). * * Motivation: H5Pset_elink_acc_flags() is used to adjust the * file access flag used to open files reached through external links. * This may be useful to, for example, prevent modifying files * accessed through an external link. Otherwise, the target file is * opened with whatever flag was used to open the parent. * * Example Usage: The following code sets the link access * property list \p lapl_id to open external link target files with * read-only access: *
* status = H5Pset_elink_acc_flags(lapl_id, H5F_ACC_RDONLY); ** * \since 1.8.3 * */ H5_DLL herr_t H5Pset_elink_acc_flags(hid_t lapl_id, unsigned flags); /** * \ingroup LAPL * * \brief Sets the external link traversal callback function in a link * access property list * * \lapl_id * \param[in] func User-defined external link traversal callback * function * \param[in] op_data User-defined input data for the callback function * * \return \herr_t * * \details H5Pset_elink_cb() sets a user-defined external link traversal * callback function in the link access property list \p lapl_id. * The callback function \p func must conform to the prototype * specified in #H5L_elink_traverse_t. * * The callback function may adjust the file access property * list and file access flags to use when opening a file through * an external link. The callback will be executed by the HDF5 * library immediately before opening the target file. * * The callback will be made after the file access property list * set by H5Pset_elink_fapl() and the file access flag set by * H5Pset_elink_acc_flags() are applied, so changes made by this * callback function will take precedence. * * \attention A file close degree property setting (H5Pset_fclose_degree()) * in this callback function or an associated property list will * be ignored. A file opened by means of traversing an external * link is always opened with the weak file close degree * property setting, #H5F_CLOSE_WEAK. * * Motivation: H5Pset_elink_cb() is used to specify a * callback function that is executed by the HDF5 library when * traversing an external link. This provides a mechanism to set * specific access permissions, modify the file access property * list, modify the parent or target file, or take any other * user-defined action. This callback function is used in * situations where the HDF5 library's default behavior is not * suitable. * * Failure Modes: H5Pset_elink_cb() will fail if the link * access property list identifier, \p lapl_id, is invalid or if * the function pointer, \p func, is NULL. * * An invalid function pointer, \p func, will cause a segmentation * fault or other failure when an attempt is subsequently made to * traverse an external link. * * Example Usage: * This example defines a callback function that prints the name * of the target file every time an external link is followed, and * sets this callback function on \p lapl_id. *
* herr_t elink_callback(const char *parent_file_name, const char
* *parent_group_name, const char *child_file_name, const char
* *child_object_name, unsigned *acc_flags, hid_t fapl_id, void *op_data) {
* puts(child_file_name);
* return 0;
* }
* int main(void) {
* hid_t lapl_id = H5Pcreate(H5P_LINK_ACCESS);
* H5Pset_elink_cb(lapl_id, elink_callback, NULL);
* ...
* }
*
*
*
* \since 1.8.3
*
*/
H5_DLL herr_t H5Pset_elink_cb(hid_t lapl_id, H5L_elink_traverse_t func, void *op_data);
/**
* \ingroup LAPL
*
* \brief Sets a file access property list for use in accessing a file
* pointed to by an external link
*
* \lapl_id
* \fapl_id
*
* \return \herr_t
*
* \details H5Pset_elink_fapl() sets the file access property list,
* \p fapl_id, to be used when accessing the target file of an
* external link associated with \p lapl_id.
*
* \since 1.8.0
*
*/
H5_DLL herr_t H5Pset_elink_fapl(hid_t lapl_id, hid_t fapl_id);
/**
* \ingroup LAPL
*
* \brief Sets prefix to be applied to external link paths
*
* \lapl_id{plist_id}
* \param[in] prefix Prefix to be applied to external link paths
*
* \return \herr_t
*
* \details H5Pset_elink_prefix() sets the prefix to be applied to the
* path of any external links traversed. The prefix is prepended
* to the filename stored in the external link.
*
* The prefix is specified in the user-allocated buffer \p prefix
* and set in the link access property list \p plist_id. The buffer
* should not be freed until the property list has been closed.
*
* \since 1.8.0
*
*/
H5_DLL herr_t H5Pset_elink_prefix(hid_t plist_id, const char *prefix);
/**
* \ingroup LAPL
*
* \brief Sets maximum number of soft or user-defined link traversals
*
* \lapl_id{plist_id}
* \param[in] nlinks Maximum number of links to traverse
*
* \return \herr_t
*
* \details H5Pset_nlinks() sets the maximum number of soft or user-defined
* link traversals allowed, \p nlinks, before the library assumes
* it has found a cycle and aborts the traversal. This value is
* set in the link access property list \p plist_id.
*
* The limit on the number of soft or user-defined link traversals
* is designed to terminate link traversal if one or more links
* form a cycle. User control is provided because some files may
* have legitimate paths formed of large numbers of soft or
* user-defined links. This property can be used to allow
* traversal of as many links as desired.
*
* \since 1.8.0
*
*/
H5_DLL herr_t H5Pset_nlinks(hid_t plist_id, size_t nlinks);
/* Object copy property list (OCPYPL) routines */
/**
* \ingroup OCPYPL
*
* \brief Adds a path to the list of paths that will be searched in the
* destination file for a matching committed datatype
*
* \param[in] plist_id Object copy property list identifier
* \param[in] path The path to be added
*
* \return \herr_t
*
* \details H5Padd_merge_committed_dtype_path() adds a path, \p path,
* which points to a committed datatype, to the current list of
* suggested paths stored in the object copy property list
* \p plist_id. The search as described in the next paragraph is
* effective only if the #H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG is
* enabled in the object copy property list via
* H5Pset_copy_object().
*
* When copying a committed datatype, a dataset with a committed
* datatype, or an object with an attribute of a committed
* datatype, the default behavior of H5Ocopy() is to search for
* a matching committed datatype:
*
* int main(void) {
* hid_t ocpypl_id = H5Pcreate(H5P_OBJECT_COPY);
*
* H5Pset_copy_object(ocpypl_id, H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG);
* H5Padd_merge_committed_dtype_path(ocpypl_id, "/group/committed_dtypeA");
* H5Padd_merge_committed_dtype_path(ocpypl_id, "/group2/committed_dset");
* H5Ocopy(...ocpypl_id...);
* ...
* ...
* }
*
*
* \note H5Padd_merge_committed_dtype_path() will fail if the object
* copy property list is invalid.
* It will also fail if there is insufficient memory when
* duplicating \p path.
*
* \see
* \li H5Ocopy()
* \li #H5O_mcdt_search_cb_t
* \li H5Padd_merge_committed_dtype_path()
* \li H5Pfree_merge_committed_dtype_paths()
* \li H5Pget_mcdt_search_cb()
* \li H5Pset_copy_object()
* \li H5Pset_mcdt_search_cb()
* \li \ref_h5ocopy
*
* \since 1.8.9
*
*/
H5_DLL herr_t H5Padd_merge_committed_dtype_path(hid_t plist_id, const char *path);
/**
* \ingroup OCPYPL
*
* \brief Clears the list of paths stored in the object copy property list
*
* \param[in] plist_id Object copy property list identifier
*
* \return \herr_t
*
* \details H5Pfree_merge_committed_dtype_paths() clears the suggested
* paths stored in the object copy property list \p plist_id.
* These are the suggested paths previously set with
* H5Padd_merge_committed_dtype_path().
*
* \b Example \b Usage: This example adds a suggested path to the
* object copy property list, does the copy, clears the list, and
* then adds a new suggested path to the list for another copy.
*
*
* int main(void) {
* hid_t ocpypl_id = H5Pcreate(H5P_OBJECT_COPY);
*
* H5Pset_copy_object(ocpypl_id, H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG);
* H5Padd_merge_committed_dtype_path(ocpypl_id, "/group/committed_dtypeA");
* H5Ocopy(...ocpypl_id...);
* ...
* ...
* H5Pfree_merge_committed_dtype_paths(ocpypl_id);
* H5Padd_merge_committed_dtype_path(ocpypl_id, "/group2/committed_dtypeB");
* H5Ocopy(...ocpypl_id...);
* ...
* ...
* }
*
*
* \note H5Pfree_merge_committed_dtype_paths() will fail if the
* object copy property list is invalid.
*
* \see
* \li H5Ocopy()
* \li #H5O_mcdt_search_cb_t
* \li H5Padd_merge_committed_dtype_path()
* \li H5Pfree_merge_committed_dtype_paths()
* \li H5Pget_mcdt_search_cb()
* \li H5Pset_copy_object()
* \li H5Pset_mcdt_search_cb()
*
* \since 1.8.9
*
*/
H5_DLL herr_t H5Pfree_merge_committed_dtype_paths(hid_t plist_id);
/**
* \ingroup OCPYPL
*
* \brief Retrieves the properties to be used when an object is copied
*
* \param[in] plist_id Object copy property list identifier
* \param[out] copy_options Copy option(s) set in the object copy property
* list
*
* \return \herr_t
*
* \details H5Pget_copy_object() retrieves the properties currently
* specified in the object copy property list \p plist_id, which
* will be invoked when a new copy is made of an existing object.
*
* \p copy_options is a bit map indicating the flags, or
* properties, governing object copying that are set in the
* property list \p plist_id.
*
* The available flags are described in H5Pset_copy_object().
*
* \since 1.8.0
*
*/
H5_DLL herr_t H5Pget_copy_object(hid_t plist_id, unsigned *copy_options /*out*/);
/**
* \ingroup OCPYPL
*
* \brief Retrieves the callback function from the specified object copy
* property list
*
* \param[in] plist_id Object copy property list identifier
* \param[out] func User-defined callback function
* \param[out] op_data User-defined data for the callback
* function
*
* \return \herr_t
*
* \details H5Pget_mcdt_search_cb() retrieves the user-defined callback
* function and the user data that are set via
* H5Pset_mcdt_search_cb() in the object copy property list
* \p plist_id.
*
* The callback function will be returned in the parameter \p func
* and the user data will be returned in the parameter \p op_data.
*
* \note H5Pget_mcdt_search_cb() will fail if the object copy property
* list is invalid.
*
* \see
* \li H5Ocopy()
* \li #H5O_mcdt_search_cb_t
* \li H5Padd_merge_committed_dtype_path()
* \li H5Pfree_merge_committed_dtype_paths()
* \li H5Pget_mcdt_search_cb()
* \li H5Pset_copy_object()
* \li H5Pset_mcdt_search_cb()
* \li \ref_h5ocopy
*
* \since 1.8.9
*
*/
H5_DLL herr_t H5Pget_mcdt_search_cb(hid_t plist_id, H5O_mcdt_search_cb_t *func, void **op_data);
/**
* \ingroup OCPYPL
*
* \brief Sets properties to be used when an object is copied
*
* \param[in] plist_id Object copy property list identifier
* \param[out] copy_options Copy option(s) to be set
*
* \return \herr_t
*
* \details H5Pset_copy_object() sets properties in the object copy
* property list \p plist_id. When an existing object is copied,
* that property list will determine how the new copy is created.
*
* The following flags are available for use in an object copy
* property list:
*
* | #H5O_COPY_SHALLOW_HIERARCHY_FLAG | *Copy only immediate members of a group * Default behavior, without flag: Recursively * copy all objects in and below the group. |
*
| #H5O_COPY_EXPAND_SOFT_LINK_FLAG | *Expand soft links into new objects * Default behavior, without flag: Copy soft * links as they are. |
*
| #H5O_COPY_EXPAND_EXT_LINK_FLAG | *Expand external link into new objects * Default behavior, without flag: Copy external * links as they are. |
*
| #H5O_COPY_EXPAND_REFERENCE_FLAG | *Copy objects that are pointed to by references and
* update reference values in destination file * Default behavior, without flag: Set reference * values in destination file to zero (0) |
*
| #H5O_COPY_WITHOUT_ATTR_FLAG | *Copy object without copying attributes * Default behavior, without flag: Copy object * with all its attributes |
*
| #H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG | *Use a matching committed datatype in the destination
* file when copying a committed datatype, a dataset with
* a committed datatype, or an object with an attribute
* of committed datatype * Default behavior without flag: * * \li A committed datatype in the source will be copied to * the destination as a committed datatype. * \li If a dataset in the source uses a committed * datatype or an object in the source has an attribute * of a committed datatype, that committed datatype will * be written to the destination as an anonymous * committed datatype. * If copied in a single H5Ocopy() operation, objects * that share a committed datatype in the source will * share an anonymous committed datatype in the * destination copy. Subsequent H5Ocopy() operations, * however, will be unaware of prior anonymous committed * datatypes and will create new ones. * * See the “See Also” section immediately below for * functions related to the use of this flag. |
*
* static H5O_mcdt_search_ret_t
* mcdt_search_cb(void *_udata)
* {
* H5O_mcdt_search_ret_t action = *((H5O_mcdt_search_ret_t *)_udata);
*
* return(action);
* }
*
* int main(void) {
* hid_t ocpypl_id = H5Pcreate(H5P_OBJECT_COPY);
*
* H5Pset_copy_object(ocpypl_id, H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG);
* H5Padd_merge_committed_dtype_path(ocpypl_id, "/group/committed_dtypeA");
*
* action = H5O_MCDT_SEARCH_STOP;
* H5Pset_mcdt_search_cb(ocpypl_id, mcdt_search_cb, &action);
* H5Ocopy(...ocpypl_id...);
* ...
* ...
* }
*
*
* \note H5Pset_mcdt_search_cb() will fail if the
* object copy property list is invalid.
*
* \warning If the callback function return value causes H5Ocopy() to
* abort, the destination file may be left in an inconsistent or
* corrupted state.
*
* \see
* \li H5Ocopy()
* \li #H5O_mcdt_search_cb_t
* \li H5Padd_merge_committed_dtype_path()
* \li H5Pfree_merge_committed_dtype_paths()
* \li H5Pget_mcdt_search_cb()
* \li H5Pset_copy_object()
* \li H5Pset_mcdt_search_cb()
* \li \ref_h5ocopy
*
* \since 1.8.9
*
*/
H5_DLL herr_t H5Pset_mcdt_search_cb(hid_t plist_id, H5O_mcdt_search_cb_t func, void *op_data);
/* Symbols defined for compatibility with previous versions of the HDF5 API.
*
* Use of these symbols is deprecated.
*/
#ifndef H5_NO_DEPRECATED_SYMBOLS
/* Macros */
/* We renamed the "root" of the property list class hierarchy */
#define H5P_NO_CLASS H5P_ROOT
/* Typedefs */
/**
* \ingroup PLCRA
*
* \brief Registers a permanent property with a property list class
*
* \plistcls_id{cls_id}
* \param[in] name Name of property to register
* \param[in] size Size of property in bytes
* \param[in] def_value Default value for property in newly created
* property lists
* \param[in] prp_create Callback routine called when a property list is
* being created and the property value will be
* initialized
* \param[in] prp_set Callback routine called before a new value is
* copied into the property's value
* \param[in] prp_get Callback routine called when a property value is
* retrieved from the property
* \param[in] prp_del Callback routine called when a property is deleted
* from a property list
* \param[in] prp_copy Callback routine called when a property is copied
* from a property list
* \param[in] prp_close Callback routine called when a property list is
* being closed and the property value will be
* disposed of
*
* \return \herr_t
*
* \deprecated As of HDF5-1.8 this function was deprecated in favor of
* H5Pregister2() or the macro H5Pregister().
*
* \details H5Pregister1() registers a new property with a property list
* class. The property will exist in all property list objects
* of that class after this routine is finished. The name of
* the property must not already exist. The default property
* value must be provided and all new property lists created
* with this property will have the property value set to the
* default provided. Any of the callback routines may be set
* to NULL if they are not needed.
*
* Zero-sized properties are allowed and do not store any data in
* the property list. These may be used as flags to indicate the
* presence or absence of a particular piece of information. The
* default pointer for a zero-sized property may be set to NULL.
* The property \p prp_create and \p prp_close callbacks are called for
* zero-sized properties, but the \p prp_set and \p prp_get callbacks
* are never called.
*
* The \p prp_create routine is called when a new property list with
* this property is being created. The #H5P_prp_create_func_t
* callback function is defined as #H5P_prp_cb1_t.
*
* The \p prp_create routine may modify the value to be set and those
* changes will be stored as the initial value of the property.
* If the \p prp_create routine returns a negative value, the new
* property value is not copied into the property and the
* \p prp_create routine returns an error value.
*
* The \p prp_set routine is called before a new value is copied into
* the property. The #H5P_prp_set_func_t callback function is defined
* as #H5P_prp_cb2_t.
*
* The \p prp_set routine may modify the value pointer to be set and
* those changes will be used when setting the property's value.
* If the \p prp_set routine returns a negative value, the new property
* value is not copied into the property and the \p prp_set routine
* returns an error value. The \p prp_set routine will not be called
* for the initial value; only the \p prp_create routine will be
* called.
*
* \b Note: The \p prp_set callback function may be useful to range
* check the value being set for the property or may perform some
* transformation or translation of the value set. The \p prp_get
* callback would then reverse the transformation or translation.
* A single \p prp_get or \p prp_set callback could handle multiple
* properties by performing different actions based on the property
* name or other properties in the property list.
*
* The \p prp_get routine is called when a value is retrieved from a
* property value. The #H5P_prp_get_func_t callback function is
* defined as #H5P_prp_cb2_t.
*
* The \p prp_get routine may modify the value to be returned from the
* query and those changes will be returned to the calling routine.
* If the \p prp_set routine returns a negative value, the query
* routine returns an error value.
*
* The \p prp_del routine is called when a property is being
* deleted from a property list. The #H5P_prp_delete_func_t
* callback function is defined as #H5P_prp_cb2_t.
*
* The \p prp_del routine may modify the value passed in, but the
* value is not used by the library when the \p prp_del routine
* returns. If the \p prp_del routine returns a negative value,
* the property list deletion routine returns an error value but
* the property is still deleted.
*
* The \p prp_copy routine is called when a new property list with
* this property is being created through a \p prp_copy operation.
* The #H5P_prp_copy_func_t callback function is defined as
* #H5P_prp_cb1_t.
*
* The \p prp_copy routine may modify the value to be set and those
* changes will be stored as the new value of the property. If
* the \p prp_copy routine returns a negative value, the new
* property value is not copied into the property and the \p prp_copy
* routine returns an error value.
*
* The \p prp_close routine is called when a property list with this
* property is being closed. The #H5P_prp_close_func_t callback
* function is defined as #H5P_prp_cb1_t.
*
* The \p prp_close routine may modify the value passed in, but the
* value is not used by the library when the \p prp_close routine
* returns. If the \p prp_close routine returns a negative value, the
* property list close routine returns an error value but the property
* list is still closed.
*
* The #H5P_prp_cb1_t is as follows:
* \snippet this H5P_prp_cb1_t_snip
*
* The #H5P_prp_cb2_t is as follows:
* \snippet this H5P_prp_cb2_t_snip
*
*/
/* Function prototypes */
H5_DLL herr_t H5Pregister1(hid_t cls_id, const char *name, size_t size, void *def_value,
H5P_prp_create_func_t prp_create, H5P_prp_set_func_t prp_set,
H5P_prp_get_func_t prp_get, H5P_prp_delete_func_t prp_del,
H5P_prp_copy_func_t prp_copy, H5P_prp_close_func_t prp_close);
/**
* \ingroup PLCRA
*
* \brief Registers a temporary property with a property list
*
* \plist_id
* \param[in] name Name of property to create
* \param[in] size Size of property in bytes
* \param[in] value Initial value for the property
* \param[in] prp_set Callback routine called before a new value is copied
* into the property's value
* \param[in] prp_get Callback routine called when a property value is
* retrieved from the property
* \param[in] prp_delete Callback routine called when a property is deleted
* from a property list
* \param[in] prp_copy Callback routine called when a property is copied
* from an existing property list
* \param[in] prp_close Callback routine called when a property list is
* being closed and the property value will be disposed
* of
*
* \return \herr_t
*
* \deprecated As of HDF5-1.8 this function was deprecated in favor of
* H5Pinsert2() or the macro H5Pinsert().
*
* \details H5Pinsert1() creates a new property in a property
* list. The property will exist only in this property list and
* copies made from it.
*
* The initial property value must be provided in \p value and
* the property value will be set accordingly.
*
* The name of the property must not already exist in this list,
* or this routine will fail.
*
* The \p prp_set and \p prp_get callback routines may be set to NULL
* if they are not needed.
*
* Zero-sized properties are allowed and do not store any data
* in the property list. The default value of a zero-size
* property may be set to NULL. They may be used to indicate the
* presence or absence of a particular piece of information.
*
* The \p prp_set routine is called before a new value is copied
* into the property. The #H5P_prp_set_func_t callback function
* is defined as #H5P_prp_cb2_t.
* The \p prp_set routine may modify the value pointer to be set and
* those changes will be used when setting the property's value.
* If the \p prp_set routine returns a negative value, the new property
* value is not copied into the property and the \p set routine
* returns an error value. The \p prp_set routine will be called for
* the initial value.
*
* \b Note: The \p prp_set callback function may be useful to range
* check the value being set for the property or may perform some
* transformation or translation of the value set. The \p prp_get
* callback would then reverse the transformation or translation.
* A single \p prp_get or \p prp_set callback could handle multiple
* properties by performing different actions based on the
* property name or other properties in the property list.
*
* The \p prp_get routine is called when a value is retrieved from
* a property value. The #H5P_prp_get_func_t callback function
* is defined as #H5P_prp_cb2_t.
*
* The \p prp_get routine may modify the value to be returned from
* the query and those changes will be preserved. If the \p prp_get
* routine returns a negative value, the query routine returns
* an error value.
*
* The \p prp_delete routine is called when a property is being
* deleted from a property list. The #H5P_prp_delete_func_t
* callback function is defined as #H5P_prp_cb2_t.
*
* The \p prp_copy routine is called when a new property list with
* this property is being created through a \p prp_copy operation.
* The #H5P_prp_copy_func_t callback function is defined as
* #H5P_prp_cb1_t.
*
* The \p prp_copy routine may modify the value to be set and those
* changes will be stored as the new value of the property. If the
* \p prp_copy routine returns a negative value, the new property value
* is not copied into the property and the prp_copy routine returns an
* error value.
*
* The \p prp_close routine is called when a property list with this
* property is being closed.
* The #H5P_prp_close_func_t callback function is defined as
* #H5P_prp_cb1_t.
*
* The \p prp_close routine may modify the value passed in, the
* value is not used by the library when the close routine
* returns. If the \p prp_close routine returns a negative value,
* the property list \p prp_close routine returns an error value
* but the property list is still closed.
*
* \b Note: There is no \p prp_create callback routine for temporary
* property list objects; the initial value is assumed to
* have any necessary setup already performed on it.
*
* The #H5P_prp_cb1_t is as follows:
* \snippet this H5P_prp_cb1_t_snip
*
* The #H5P_prp_cb2_t is as follows:
* \snippet this H5P_prp_cb2_t_snip
*
*/
H5_DLL herr_t H5Pinsert1(hid_t plist_id, const char *name, size_t size, void *value,
H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get,
H5P_prp_delete_func_t prp_delete, H5P_prp_copy_func_t prp_copy,
H5P_prp_close_func_t prp_close);
/**
* \ingroup PLCRA
*
* \brief Encodes the property values in a property list into a binary
* buffer
*
* \plist_id
* \param[out] buf Buffer into which the property list will be encoded.
* If the provided buffer is NULL, the size of the
* buffer required is returned through \p nalloc; the
* function does nothing more.
* \param[out] nalloc The size of the required buffer
*
* \return \herr_t
*
* \deprecated As of HDF5-1.12 this function has been deprecated in favor of
* H5Pencode2() or the macro H5Pencode().
*
* \details H5Pencode1() encodes the property list \p plist_id into the
* binary buffer \p buf.
*
* If the required buffer size is unknown, \p buf can be passed
* in as NULL and the function will set the required buffer size
* in \p nalloc. The buffer can then be created and the property
* list encoded with a subsequent H5Pencode1() call.
*
* If the buffer passed in is not big enough to hold the encoded
* properties, the H5Pencode1() call can be expected to fail with
* a segmentation fault.
*
* Properties that do not have encode callbacks will be skipped.
* There is currently no mechanism to register an encode callback for
* a user-defined property, so user-defined properties cannot currently
* be encoded.
*
* Some properties cannot be encoded, particularly properties that are
* reliant on local context.
*
* \since 1.10.0
*
*/
H5_DLL herr_t H5Pencode1(hid_t plist_id, void *buf, size_t *nalloc);
/**
* \ingroup DCPL
*
* \brief Returns information about a filter in a pipeline (DEPRECATED)
*
*
*
* \plist_id{plist_id}
* \param[in] filter Sequence number within the filter pipeline of
* the filter for which information is sought
* \param[out] flags Bit vector specifying certain general properties
* of the filter
* \param[in,out] cd_nelmts Number of elements in \p cd_values
* \param[out] cd_values Auxiliary data for the filter
* \param[in] namelen Anticipated number of characters in \p name
* \param[out] name Name of the filter
*
* \return Returns the filter identifier if successful; Otherwise returns
* a negative value. See: #H5Z_filter_t
*
* \deprecated When was this function deprecated?
*
* \details H5Pget_filter1() returns information about a filter, specified
* by its filter number, in a filter pipeline, specified by the
* property list with which it is associated.
*
* \p plist_id must be a dataset or group creation property list.
*
* \p filter is a value between zero and N-1, as described in
* H5Pget_nfilters(). The function will return a negative value
* if the filter number is out of range.
*
* The structure of the \p flags argument is discussed in
* H5Pset_filter().
*
* On input, \p cd_nelmts indicates the number of entries in the
* \p cd_values array, as allocated by the caller; on return,
* \p cd_nelmts contains the number of values defined by the filter.
*
* If \p name is a pointer to an array of at least \p namelen
* bytes, the filter name will be copied into that array. The name
* will be null terminated if \p namelen is large enough. The
* filter name returned will be the name appearing in the file, the
* name registered for the filter, or an empty string.
*
* \version 1.8.5 Function extended to work with group creation property
* lists.
* \version 1.8.0 N-bit and scale-offset filters added.
* \version 1.8.0 Function H5Pget_filter() renamed to H5Pget_filter1() and
* deprecated in this release.
* \version 1.6.4 \p filter parameter type changed to unsigned.
*
*/
H5_DLL H5Z_filter_t H5Pget_filter1(hid_t plist_id, unsigned filter, unsigned int *flags /*out*/,
size_t *cd_nelmts /*out*/, unsigned cd_values[] /*out*/, size_t namelen,
char name[]);
/**
* \ingroup DCPL
*
* \brief Returns information about the specified filter
*
* \plist_id{plist_id}
* \param[in] id Filter identifier
* \param[out] flags Bit vector specifying certain general properties
* of the filter
* \param[in,out] cd_nelmts Number of elements in \p cd_values
* \param[out] cd_values Auxiliary data for the filter
* \param[in] namelen Anticipated number of characters in \p name
* \param[out] name Name of the filter
*
*
* \return Returns a non-negative value if successful; Otherwise returns
* a negative value.
*
* \deprecated As of HDF5-1.8 this function was deprecated in favor of
* H5Pget_filter_by_id2() or the macro H5Pget_filter_by_id().
*
* \details H5Pget_filter_by_id1() returns information about a filter, specified
* in \p id, a filter identifier.
*
* \p plist_id must be a dataset or group creation property list and
* \p id must be in the associated filter pipeline.
*
* The \p id and \p flags parameters are used in the same
* manner as described in the discussion of H5Pset_filter().
*
* Aside from the fact that they are used for output, the parameters
* \p cd_nelmts and \p cd_values[] are used in the same manner as
* described in the discussion of H5Pset_filter().
* On input, the \p cd_nelmts parameter indicates the number of entries
* in the \p cd_values[] array allocated by the calling program;
* on exit it contains the number of values defined by the filter.
*
* On input, the \p namelen parameter indicates the number of
* characters allocated for the filter name by the calling program
* in the array \p name[]. On exit \p name[] contains the name of the
* filter with one character of the name in each element of the array.
*
* If the filter specified in \p id is not set for the property
* list, an error will be returned and this function will fail.
*
*
* \version 1.8.5 Function extended to work with group creation property
* lists.
* \version 1.8.0 Function H5Pget_filter_by_id() renamed to
* H5Pget_filter_by_id1() and deprecated in this release.
* \version 1.6.0 Function introduced in this release.
*/
H5_DLL herr_t H5Pget_filter_by_id1(hid_t plist_id, H5Z_filter_t id, unsigned int *flags /*out*/,
size_t *cd_nelmts /*out*/, unsigned cd_values[] /*out*/, size_t namelen,
char name[] /*out*/);
/**
* \ingroup FCPL
*
* \brief Retrieves the version information of various objects
* for a file creation property list(deprecated)
*
* \plist_id
* \param[out] boot Pointer to location to return super block version number
* \param[out] freelist Pointer to location to return global freelist version number
* \param[out] stab Pointer to location to return symbol table version number
* \param[out] shhdr Pointer to location to return shared object header version
* number
*
* \return \herr_t
*
* \deprecated Deprecated in favor of the function H5Fget_info()
*
* \details H5Pget_version() retrieves the version information of various objects
* for a file creation property list. Any pointer parameters which are
* passed as NULL are not queried.
*
* \version 1.6.4 \p boot, \p freelist, \p stab, \p shhdr parameter types
* changed to unsigned.
*
*/
H5_DLL herr_t H5Pget_version(hid_t plist_id, unsigned *boot /*out*/, unsigned *freelist /*out*/,
unsigned *stab /*out*/, unsigned *shhdr /*out*/);
/**
* \ingroup FCPL
*
* \brief Sets the file space handling strategy and the free-space section
* size threshold.
*
* \fcpl_id{plist_id}
* \param[in] strategy The file space handling strategy to be used. See:
* #H5F_fspace_strategy_t
* \param[in] threshold The smallest free-space section size that the free
* space manager will track
*
* \return \herr_t
*
* \deprecated When was this function deprecated?
*
* \details Maps to the function H5Pset_file_space_strategy().
*
*/
H5_DLL herr_t H5Pset_file_space(hid_t plist_id, H5F_file_space_type_t strategy, hsize_t threshold);
/**
* \ingroup FCPL
*
* \brief Retrieves the file space handling strategy, and threshold value for
* a file creation property list
*
* \fcpl_id{plist_id}
* \param[out] strategy Pointer to the file space handling strategy
* \param[out] threshold Pointer to the free-space section size threshold value
*
* \return \herr_t
*
* \deprecated When was this function deprecated?
*
* \details Maps to the function H5Pget_file_space_strategy()
*
*
*/
H5_DLL herr_t H5Pget_file_space(hid_t plist_id, H5F_file_space_type_t *strategy, hsize_t *threshold);
#endif /* H5_NO_DEPRECATED_SYMBOLS */
#ifdef __cplusplus
}
#endif
#endif /* H5Ppublic_H */