HDF.PInvoke

Cache configuration struct used by H5F.[get,set]_mdc_config()

Value for the default error stack

Determines type of error stack. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-AutoIsV2

The error stack identifier A flag indicating which error stack typedef the specified error stack conforms to. Returns a non-negative value if successful; otherwise returns a negative value.

Clears the specified error stack or the error stack for the current thread. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-Clear2

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

Closes an error message identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-CloseMsg

Error message identifier. Returns a non-negative value on success; otherwise returns a negative value.

Closes object handle for error stack. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-CloseStack

Error stack identifier. Returns a non-negative value on success; otherwise returns a negative value.

Add major error message to an error class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-CreateMsg

Error class identifier. The type of the error message. Major error message. Returns a message identifier on success; otherwise returns a negative value. ASCII strings ONLY.

Creates a new empty error stack. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-CreateStack

Returns an error stack identifier on success; otherwise returns a negative value.

Returns the settings for the automatic error stack traversal function and its data. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-GetAuto2

Error stack identifier. H5E_DEFAULT indicates the current stack. The function currently set to be called upon an error condition. Data currently set to be passed to the error function.

Retrieves error class name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-GetClassName

Error class identifier. The name of the class to be queried. The length of class name to be returned by this function. Returns non-negative value as on success; otherwise returns negative value. ASCII strings ONLY!

Returns copy of current error stack. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-GetCurrentStack

Returns an error stack identifier on success; otherwise returns a negative value.

Retrieves an error message. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-GetMsg

Idenfier for error message to be queried. The type of the error message. Error message buffer. The length of error message to be returned by this function. Returns the size of the error message in bytes on success; otherwise returns a negative value.

Retrieves the number of error messages in an error stack. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-GetNum

Error stack identifier. Returns a non-negative value on success; otherwise returns a negative value.

Deletes specified number of error messages from the error stack. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-Pop

Error stack identifier. The number of error messages to be deleted from the top of error stack.

Prints the specified error stack in a default manner. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-Print2

Identifier of the error stack to be printed. File pointer, or stderr if NULL. Returns a non-negative value if successful; otherwise returns a negative value.

Pushes new error record onto error stack. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-Push2

Identifier of the error stack to which the error record is to be pushed. If the identifier is H5E.DEFAULT , the error record will be pushed to the current stack. Name of the file in which the error was detected. Name of the function in which the error was detected. Line number within the file at which the error was detected. Error class identifier. Major error identifier. Minor error identifier. Error description string. Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Registers a client library or application program to the HDF5 error API. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-RegisterClass

Name of the error class. Name of the client library or application to which the error class belongs. Version of the client library or application to which the error class belongs. A NULL can be passed in. Returns a class identifier on success; otherwise returns a negative value.

Turns automatic error printing on or off. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-SetAuto2

Error stack identifier. Function to be called upon an error condition. Data passed to the error function. Returns a non-negative value on success; otherwise returns a negative value.

Replaces the current error stack. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-SetCurrentStack

Error stack identifier. Returns a non-negative value on success; otherwise returns a negative value.

Removes an error class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-UnregisterClass

Error class identifier. Returns a non-negative value on success; otherwise returns a negative value.

Walks the specified error stack, calling the specified function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5E.html#Error-Walk2

Error stack identifier. Direction in which the error stack is to be walked. Function to be called for each error encountered. Data to be passed with .

Different kinds of error information

Information about an error; element of error stack

class ID

major error ID

minor error ID

line in file where error occurs

function in which error occurred

file in which error occurred

optional supplied description

Callback for error handling.

Error stack identifier Pointer to client data in the format expected by the user-defined function. Returns a non-negative value if successful; otherwise returns a negative value.

Callback for H5E.walk

Indexed position of the error in the stack. Reference to a data structure describing the error. Pointer to client data in the format expected by the user-defined function. Returns a non-negative value if successful; otherwise returns a negative value.

Error stack traversal direction

begin deep, end at API function [value = 0]

begin at API function, end deep [value = 1]

Default value for all property list classes

Adds a path to the list of paths that will be searched in the destination file for a matching committed datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-AddMergeCommittedDtypePath

Object copy property list identifier. The path to be added. Returns a non-negative value if successful; otherwise returns a negative value.

Object copy property list identifier. The path to be added. Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Verifies that all required filters are available. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-AllFiltersAvail

Dataset or group creation property list identifier. Returns 1 if all filters are available and 0 if one or more is not currently available. Returns a negative value on error.

Terminates access to a property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Close

Identifier of the property list to which access is terminated. Returns a non-negative value if successful; otherwise returns a negative value.

Closes an existing property list class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-CloseClass

Property list class to close Returns a non-negative value if successful; otherwise returns a negative value.

Copies an existing property list to create a new property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Copy

Identifier of property list to duplicate. Returns a property list identifier if successful; otherwise returns a negative value.

Copies a property from one list or class to another. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-CopyProp

Identifier of the destination property list or class Identifier of the source property list or class Name of the property to copy Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Creates a new property list as an instance of a property list class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Create

The class of the property list to create. Returns a property list identifier (plist) if successful; otherwise Fail (-1).

Creates a new property list class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-CreateClass

Property list class to inherit from or NULL Name of property list class to register Callback routine called when a property list is created Pointer to user-defined class create data, to be passed along to class create callback Callback routine called when a property list is copied Pointer to user-defined class copy data, to be passed along to class copy callback Callback routine called when a property list is being closed Pointer to user-defined class close data, to be passed along to class close callback On success, returns a valid property list class identifier; otherwise returns a negative value. ASCII strings ONLY!

Compares two property lists or classes for equality. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Equal

First property object to be compared Second property object to be compared Returns 1 if equal; 0 if unequal. Returns a negative value on error.

Queries whether a property name exists in a property list or class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Exist

Identifier for the property to query Name of property to check for Returns 1 if the property exists in the property object; 0 if the property does not exist. Returns a negative value on error. ASCII strings ONLY!

Determines whether fill value is defined. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-FillValueDefined

Dataset creation property list identifier. Status of fill value in property list. Returns a non-negative value if successful; otherwise returns a negative value.

Clears the list of paths stored in the object copy property list . See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-FreeMergeCommittedDtypePaths

Object copy property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Queries the value of a property. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Get

Identifier of the property list to query Name of property to query Pointer to a location to which to copy the value of of the property Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Retrieves the current settings for alignment properties from a file access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetAlignment

Identifier of a file access property list. Pointer to location of return threshold value. Pointer to location of return alignment value.

Retrieves the timing for storage space allocation. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetAllocTime

Dataset creation property list identifier. When to allocate dataset storage space. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the values of the append property that is set up in the dataset access property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Pget_append_flush.htm

Dataset access property list identifier. The number of elements for . The dimension sizes used to determine the boundary. The user-defined callback function. The user-defined input data. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves tracking and indexing settings for attribute creation order. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetAttrCreationOrder

Object (group or dataset) creation property list identifier Flags specifying whether to track and index attribute creation order Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves attribute storage phase change thresholds. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetAttrPhaseChange

Object creation property list identifier Maximum number of attributes to be stored in compact storage Minimum number of attributes to be stored in dense storage Returns a non-negative value if successful; otherwise returns a negative value.

Gets B-tree split ratios for a dataset transfer property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetBTreeRatios

The dataset transfer property list identifier. The B-tree split ratio for left-most nodes. The B-tree split ratio for right-most nodes and lone nodes. The B-tree split ratio for all other nodes. Returns a non-negative value if successful; otherwise returns a negative value.

Reads buffer settings. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetBuffer

Identifier for the dataset transfer property list. Address of the pointer to application-allocated type conversion buffer. Address of the pointer to application-allocated background buffer. Returns buffer size, in bytes, if successful; otherwise 0 on failure.

Queries the raw data chunk cache parameters. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetCache

Identifier of the file access property list. UNUSED. Number of elements (objects) in the raw data chunk cache. Total size of the raw data chunk cache, in bytes. Preemption policy. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the character encoding used to create a link or attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetCharEncoding

Link creation or attribute creation property list identifier String encoding character set Returns a non-negative valule if successful; otherwise returns a negative value.

Retrieves the size of chunks for the raw data of a chunked layout dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetChunk

Identifier of property list to query. Length of the array. Array to store the chunk dimensions. Returns chunk dimensionality if successful; otherwise returns a negative value.

Retrieves the raw data chunk cache parameters. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetChunkCache

Dataset access property list identifier. Number of chunk slots in the raw data chunk cache hash table. Total size of the raw data chunk cache, in bytes. Preemption policy. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the edge chunk option setting from a dataset creation property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/PartialEdgeChunks/H5Pget_chunk_opts.htm

Dataset creation property list identifier. Edge chunk option flag. Returns a non-negative value if successful; otherwise returns a negative value.

Returns the property list class identifier for a property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetClass

Identifier of property list to query. Returns a property list class identifier if successful. Otherwise returns a negative value.

Retrieves the name of a class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetClassName

Identifier of the property class to query If successful returns a pointer to an allocated string containing the class name; NULL if unsuccessful. The pointer to the name must be freed by the user after each successful call.

Retrieves the parent class of a property class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetClassParent

Identifier of the property class to query If successful, returns a valid parent class object identifier; returns a negative value on failure.

Retrieves the properties to be used when an object is copied. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetCopyObject

Object copy property list identifier Copy option(s) set in the object copy property list Returns a non-negative value if successful; otherwise returns a negative value.

Gets information about the write tracking feature used by the core VFD. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetCoreWriteTracking

File access property list identifier. Whether the feature is enabled. Size, in bytes, of write aggregation pages. Returns a non-negative value if successful. Otherwise returns a negative value.

Determines whether property is set to enable creating missing intermediate groups. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetCreateIntermediateGroup

Link creation property list identifier Flag specifying whether to create intermediate groups upon creation of an object Returns a non-negative valule if successful; otherwise returns a negative value.

Retrieves a data transform expression. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetDataTransform

Identifier of the property list or class Pointer to memory where the transform expression will be copied Number of bytes of the transform expression to copy to If successful, returns the size of the transform expression. Otherwise returns a negative value.

Returns low-lever driver identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetDriver

File access or data transfer property list identifier. Returns a valid low-level driver identifier if successful. Otherwise returns a negative value.

Returns a pointer to file driver information. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetDriverInfo

File access or data transfer property list identifier. Returns a pointer to a struct containing low-level driver information. Otherwise returns NULL. NULL is also returned if no driver-specific properties have been registered. No error is pushed on the stack in this case.

Determines whether error-detection is enabled for dataset reads. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetEdcCheck

Dataset transfer property list identifier. Returns H5Z_ENABLE_EDC or H5Z_DISABLE_EDC if successful; otherwise returns a negative value.

Retrieves the prefix for external raw data storage files as set in the dataset access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetEfilePrefix

Dataset access property list identifier. Dataset external storage prefix. Size of prefix buffer in bytes. Returns the size of and the prefix string will be stored in if successful. Otherwise returns a negative value and the contents of will be undefined.

Retrieves the external link traversal file access flag from the specified link access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetELinkAccFlags

Link access property list identifier File access flag for link traversal. Returns a non-negative value if successful; otherwise returns a negative value

Retrieves the external link traversal callback function from the specified link access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetELinkCb

Link access property list identifier. User-defined external link traversal callback function. User-defined input data for the callback function. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the file access property list identifier associated with the link access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetELinkFapl

Link access property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the size of the external link open file cache. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetELinkFileCacheSize

File access property list identifier External link open file cache size in number of files. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves prefix applied to external link paths. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetELinkPrefix

Link access property list identifier Prefix applied to external link paths Size of prefix, including null terminator If successful, returns a non-negative value specifying the size in bytes of the prefix without the NULL terminator; otherwise returns a negative value.

Queries data required to estimate required local heap or object header size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetEstLinkInfo

Group creation property list identifier Estimated number of links to be inserted into group Estimated average length of link names Returns a non-negative value if successful; otherwise returns a negative value.

Returns information about an external file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetExternal

Identifier of a dataset creation property list. External file index. Maximum length of array. Name of the external file. Pointer to a location to return an offset value. Pointer to a location to return the size of the external file data. Returns a non-negative value if successful; otherwise returns a negative value.

Returns the number of external files for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetExternalCount

Identifier of a dataset creation property list. Returns the number of external files if successful; otherwise returns a negative value.

Retrieves a data offset from the file access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFamilyOffset

File access property list identifier. Offset in bytes within the HDF5 file. Returns a non-negative value if successful; otherwise returns a negative value.

Queries core file driver properties. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFaplCore

File access property list identifier. Size, in bytes, of memory increments. Boolean flag indicating whether to write the file contents to disk when the file is closed. Returns a non-negative value if successful. Otherwise returns a negative value.

Retrieves direct I/O driver settings. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFaplDirect

File access property list identifier Required memory alignment boundary File system block size Copy buffer size Returns a non-negative value if successful; otherwise returns a negative value.

Returns file access property list information. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFaplFamily

File access property list identifier. Size in bytes of each file member. Identifier of file access property list for each family member. Returns a non-negative value if successful; otherwise returns a negative value.

Returns the file close degree. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFcloseDegree

File access property list identifier. Pointer to a location to which to return the file close degree property, the value of fc_degree. Returns a non-negative value if successful. Otherwise returns a negative value.

Retrieves a copy of the file image designated as the initial content and structure of a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFileImage

File access property list identifier. On input, NULL or a pointer to a pointer to a buffer that contains the file image. On input, NULL or a pointer to a buffer specifying the required size of the buffer to hold the file image. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves callback routines for working with file images. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFileImageCallbacks

File access property list identifier. Pointer to the instance of the H5FD.file_image_callbacks_t struct in which the callback routines are to be returned. Returns a non-negative value if successful; otherwise returns a negative value. Struct fields must be initialized to NULL before the call is made.

Retrieves the file space management strategy and/or free-space section threshold for an HDF5 file. See https://www.hdfgroup.org/HDF5/docNewFeatures/FileSpace/H5Pget_file_space.htm

The file creation property list identifier. The current file space management strategy in use for the file. The current free-space section threshold. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the time when fill value are written to a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFillTime

Dataset creation property list identifier. Setting for the timing of writing fill values to the dataset. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves a dataset fill value. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFillValue

Dataset creation property list identifier. Datatype identifier for the value passed via value. Pointer to buffer to contain the returned fill value. Returns a non-negative value if successful; otherwise returns a negative value.

Returns information about a filter in a pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFilter2

Dataset or group creation property list identifier. Sequence number within the filter pipeline of the filter for which information is sought. Bit vector specifying certain general properties of the filter. Number of elements in . Auxiliary data for the filter. Anticipated number of characters in . Name of the filter. Bit field. Returns the filter identifier if successful. Otherwise returns a negative value.

Returns information about a filter in a pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFilter2

Returns information about the specified filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFilterById2

Dataset or group creation property list identifier. Filter identifier. Bit vector specifying certain general properties of the filter. Number of elements in . Auxiliary data for the filter. Anticipated number of characters in . Name of the filter. Bit field. Returns the filter identifier if successful. Otherwise returns a negative value.

Returns garbage collecting references setting. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetGCReferences

File access property list identifier. Flag returning the state of reference garbage collection. A returned value of 1 indicates that garbage collection is on while 0 indicates that garbage collection is off. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves number of I/O vectors to be read/written in hyperslab I/O. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetHyperVectorSize

Dataset transfer property list identifier. Number of I/O vectors to accumulate in memory for I/O operations. Returns a non-negative value if successful; otherwise returns a negative value.

Queries the 1/2 rank of an indexed storage B-tree. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetIstoreK

File creation property list identifier Pointer to location to return the chunked storage B-tree 1/2 rank Returns a non-negative value if successful; otherwise returns a negative value.

Returns the layout of the raw data for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetLayout

Identifier for property list to query. Returns the layout type (a non-negative value) of a dataset creation property list if successful. Otherwise, returns a negative value indicating failure.

Retrieves library version bounds settings that indirectly control the format versions used when creating objects. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetLibverBounds

File access property list identifier The earliest version of the library that will be used for writing objects. The latest version of the library that will be used for writing objects. Returns a non-negative value if successful; otherwise returns a negative value.

Queries whether link creation order is tracked and/or indexed in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetLinkCreationOrder

Group creation property list identifier Creation order flag(s) Returns a non-negative value if successful; otherwise returns a negative value.

Queries the settings for conversion between compact and dense groups. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetLinkPhaseChange

Group creation property list identifier Maximum number of links for compact storage Minimum number of links for dense storage Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the anticipated size of the local heap for original-style groups. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetLocalHeapSizeHint

Group creation property list identifier Anticipated size of local heap Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the callback function from the specified object copy property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetMcdtSearchCb

Object copy property list identifier User-defined callback function User-defined input data for the callback function Returns a non-negative value if successful; otherwise returns a negative value.

Get the current initial metadata cache configuration from the indicated File Access Property List. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetMdcConfig

Identifier of the file access property list. Pointer to the instance of H5AC.cache_config_t in which the current metadata cache configuration is to be reported. Returns a non-negative value if successful; otherwise returns a negative value.

Gets metadata cache logging options. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Pget_mdc_log_options.htm

File access property list identifier. Whether logging is enabled. Log file location. Size in bytes of the location string. Whether the logging begins as soon as the file is opened or created. Returns a non-negative value if successful. Otherwise returns a negative value. ASCII strings ONLY!

Returns the current metadata block size setting. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetMetaBlockSize

File access property list identifier. Minimum size, in bytes, of metadata block allocations. Returns a non-negative value if successful. Otherwise returns a negative value.

Retrieves the number of read attempts from a file access property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Pget_metadata_read_attempts.htm

Identifier for a file access property list. The number of read attempts. Returns a non-negative value if successful; otherwise returns a negative value.

Returns the number of filters in the pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetNFilters

Property list identifier. Returns the number of filters in the pipeline if successful; otherwise returns a negative value.

Retrieves the maximum number of link traversals. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetNLinks

File access property list identifier Maximum number of links to traverse Returns a non-negative value if successful; otherwise returns a negative value.

Queries the number of properties in a property list or class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetNProps

Identifier for property object to query Number of properties in object Returns a non-negative value if successful; otherwise returns a negative value.

Determines whether times associated with an object are being recorded. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetObjTrackTimes

Object creation property list identifier Boolean value, 1 or 0, specifying whether object times are being recorded Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the object flush property values from the file access property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Pget_object_flush_cb.htm

Identifier for a file access property list. The user-defined callback function. The user-defined input data for the callback function. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the configuration settings for a shared message index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSharedMesgIndex

File creation property list identifier. Index being configured. Types of messages that may be stored in this index. Minimum message size. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves number of shared object header message indexes in file creation property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSharedMesgNIndexes

File creation property list Number of shared object header message indexes available in files created with this property list Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves shared object header message phase change information. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSharedMesgPhaseChange

File creation property list identifier Threshold above which storage of a shared object header message index shifts from list to B-tree Threshold below which storage of a shared object header message index reverts to list format Returns a non-negative value if successful; otherwise returns a negative value.

Returns maximum data sieve buffer size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSieveBufSize

File access property list identifier. Maximum size, in bytes, of data sieve buffer. Returns a non-negative value if successful. Otherwise returns a negative value.

Queries the size of a property value in bytes. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSize

Identifier of property object to query Name of property to query Size of property in bytes Returns a non-negative value if successful. Otherwise returns a negative value. ASCII strings ONLY!

Retrieves the size of the offsets and lengths used in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSizes

Identifier of property list to query. Pointer to location to return offset size in bytes. Pointer to location to return length size in bytes. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the current small data block size setting. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSmallData

File access property list identifier. Maximum size, in bytes, of the small data block. Returns a non-negative value if successful; otherwise a negative value.

Retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSymK

File creation property list identifier Pointer to location to return the symbol table's B-tree 1/2 rank Pointer to location to return the symbol table's leaf node 1/2 size Returns a non-negative value if successful; otherwise returns a negative value.

Gets user-defined datatype conversion callback function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetTypeConvCb

Dataset transfer property list identifier. User-defined type conversion callback function. User-defined input data for the callback function. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the size of a user block. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetUserblock

Identifier for property list to query. Pointer to location to return user-block size. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the version information of various objects for a file creation property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetVersion

Identifier of the file creation property list. Pointer to location to return super block version number. Pointer to location to return global freelist version number. Pointer to location to return symbol table version number. Pointer to location to return shared object header version number. Returns a non-negative value if successful; otherwise returns a negative value.

Gets the number of mappings for the virtual dataset. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_count.htm

The identifier of the virtual dataset creation property list. The number of mappings. Returns a non-negative value if successful; otherwise returns a negative value.

Gets the name of a source dataset used in the mapping. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_dsetname.htm

The identifier of the virtual dataset creation property list. Mapping index. A buffer containing the name of the source dataset. The size, in bytes, of the buffer. Returns the length of the dataset name if successful; otherwise returns a negative value.

Gets the name of a source dataset used in the mapping. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_dsetname.htm

Gets the filename of a source dataset used in the mapping. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_filename.htm

The identifier of the virtual dataset creation property list. Mapping index. A buffer containing the name of the file containing the source dataset. The size, in bytes, of the name buffer. Returns the length of the dataset name if successful; otherwise returns a negative value. ASCII strings ONLY!

Returns the maximum number of missing source files and/or datasets with the printf-style names when getting the extent for an unlimited virtual dataset. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_printf_gap.htm

Dataset access property list identifier for the virtual dataset Maximum number of the files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings. Returns a non-negative value if successful; otherwise returns a negative value.

Gets a dataspace identifier for the selection within the source dataset used in the mapping. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_srcspace.htm

The identifier of the virtual dataset creation property list. Mapping index. Returns a valid dataspace identifier if successful; otherwise returns a negative value.

Retrieves the view of a virtual dataset accessed with . See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_view.htm

Dataset access property list identifier for the virtual dataset The flag specifying the view of the virtual dataset. Returns a non-negative value if successful; otherwise returns a negative value.

Gets a dataspace identifier for the selection within the virtual dataset used in the mapping. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_vspace.htm

The identifier of the virtual dataset creation property list. Mapping index. Returns a valid dataspace identifier if successful; otherwise returns a negative value.

Gets the memory manager for variable-length datatype allocation in H5D.read and H5D.vlen_reclaim.

Identifier for the dataset transfer property list. User’s allocate routine, or NULL for system malloc. Extra parameter for user’s allocation routine. Contents are ignored if preceding parameter is NULL. User’s free routine, or NULL for system free. Extra parameter for user’s free routine. Contents are ignored if preceding parameter is NULL. Returns a non-negative value if successful; otherwise returns a negative value.

Registers a temporary property with a property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Insert2

Property list identifier to create temporary property within Name of property to create Size of property in bytes Initial value for the property Callback routine called before a new value is copied into the property's value Callback routine called when a property value is retrieved from the property Callback routine called when a property is deleted from a property list Callback routine called when a property is copied from an existing property list Callback routine called when a property is compared with another property list Callback routine called when a property list is being closed and the property value will be disposed of Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Determines whether a property list is a member of a class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-IsAClass

Property list identifier Property list class identifier Returns a positive value if true or zero if false; returns a negative value on failure.

Iterates over properties in a property class or list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Iterate

Identifier of property object to iterate over Index of the property to begin with Function pointer to function to be called with each property iterated over Pointer to iteration data from user Returns the value of the last call to iter_func if it was non-zero; zero if all properties have been processed. Returns a negative value on failure.

Modifies a filter in the filter pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-ModifyFilter

Dataset or group creation property list identifier Filter to be modified. Bit vector specifying certain general properties of the filter. Number of elements in cd_values. Auxiliary data for the filter. Returns a non-negative value if successful; otherwise returns a negative value.

Registers a permanent property with a property list class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Register2

Property list class to register permanent property within Name of property to register Size of property in bytes Default value for property in newly created property lists Callback routine called when a property list is being created and the property value will be initialized Callback routine called before a new value is copied into the property's value Callback routine called when a property value is retrieved from the property Callback routine called when a property is deleted from a property list Callback routine called when a property is copied from a property list Callback routine called when a property is compared with another property list Callback routine called when a property list is being closed and the property value will be disposed of Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Removes a property from a property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Remove

Identifier of the property list to modify Name of property to remove Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Delete one or more filters in the filter pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-RemoveFilter

Dataset or group creation property list identifier. Filter to be deleted. Returns a non-negative value if successful; otherwise returns a negative value.

Sets a property list value. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Set

Property list identifier to modify Name of property to modify Pointer to value to set the property to Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Sets alignment properties of a file access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetAlignment

Identifier for a file access property list. Threshold value. Alignment value. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the timing for storage space allocation. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetAllocTime

Dataset creation property list identifier. When to allocate dataset storage space. Returns a non-negative value if successful; otherwise returns a negative value.

Sets two actions to perform when the size of a dataset’s dimension being appended reaches a specified boundary. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Pset_append_flush.htm

Dataset access property list identifier. The number of elements for boundary. The dimension sizes used to determine the boundary. The user-defined callback function. The user-defined input data. Returns a non-negative value if successful; otherwise returns a negative value.

Sets tracking and indexing of attribute creation order. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetAttrCreationOrder

Object creation property list identifier Flags specifying whether to track and index attribute creation order Returns a non-negative value if successful; otherwise returns a negative value.

Sets attribute storage phase change thresholds. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetAttrPhaseChange

Sets B-tree split ratios for a dataset transfer property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetBTreeRatios

Sets type conversion and background buffers. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetBuffer

Identifier for the dataset transfer property list. Size, in bytes, of the type conversion and background buffers. Pointer to application-allocated type conversion buffer. Pointer to application-allocated background buffer. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the raw data chunk cache parameters. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetCache

File access property list identifier. UNSUSED The number of chunk slots in the raw data chunk cache for this dataset. Total size of the raw data chunk cache in bytes. The chunk preemption policy for all datasets. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the character encoding used to encode link and attribute names. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetCharEncoding

Link creation or attribute creation property list identifier String encoding character set Returns a non-negative valule if successful; otherwise returns a negative value.

Sets the size of the chunks used to store a chunked layout dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetChunk

Dataset creation property list identifier. The number of dimensions of each chunk. An array defining the size, in dataset elements, of each chunk. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the size of the chunks used to store a chunked layout dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetChunk

Sets the edge chunk option in a dataset creation property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/PartialEdgeChunks/H5Pset_chunk_opts.htm

Dataset creation property list identifier. Edge chunk option flag. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the raw data chunk cache parameters. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetChunkCache

Dataset access property list identifier. The number of chunk slots in the raw data chunk cache for this dataset. The total size of the raw data chunk cache for this dataset. The chunk preemption policy for this dataset. Returns a non-negative value if successful; otherwise returns a negative value.

Sets properties to be used when an object is copied. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetCopyObject

Object copy property list identifier Copy option(s) to be set Returns a non-negative value if successful; otherwise returns a negative value.

Sets write tracking information for core driver, H5FD_CORE.

File access property list identifier. Boolean value specifying whether feature is enabled. Positive integer specifying size, in bytes, of write aggregation pages. Returns a non-negative value if successful. Otherwise returns a negative value.

Specifies in property list whether to create missing intermediate groups. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetCreateIntermediateGroup

Link creation property list identifier Flag specifying whether to create intermediate groups upon the creation of an object Returns a non-negative valule if successful; otherwise returns a negative value.

Sets a data transform expression.

Identifier of the property list or class Pointer to the null-terminated data transform expression Returns a non-negative valule if successful; otherwise returns a negative value. ASCII strings ONLY!

Sets deflate (GNU gzip) compression method and compression level. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetDeflate

Dataset or group creation property list identifier. Compression level. Returns a non-negative value if successful; otherwise returns a negative value.

Sets a file driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetDriver

File access or data transfer property list identifier. Driver identifier. Optional struct containing driver properties. Returns a non-negative value if successful. Otherwise returns a negative value.

Sets whether to enable error-detection when reading a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetEdcCheck

Dataset transfer property list identifier. Specifies whether error checking is enabled or disabled for dataset read operations. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the external dataset storage file prefix in the dataset access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetEfilePrefix

Dataset access property list identifier. Dataset external storage prefix. Returns a non-negative value if successful; otherwise returns a negative value. /// ASCII strings ONLY!

Sets the external link traversal file access flag in a link access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetELinkAccFlags

Link access property list identifier The access flag for external link traversal. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the external link traversal callback function in a link access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetELinkCb

Sets a file access property list for use in accessing a file pointed to by an external link. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetELinkFapl

Link access property list identifier File access property list identifier Returns a non-negative value if successful; otherwise returns a negative value.

Sets the number of files that can be held open in an external link open file cache. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetELinkFileCacheSize

File access property list identifier External link open file cache size in number of files. Returns a non-negative value if successful; otherwise returns a negative value.

Sets prefix to be applied to external link paths. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetELinkPrefix

Link access property list identifier Prefix to be applied to external link paths Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Sets estimated number of links and length of link names in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetEstLinkInfo

Adds an external file to the list of external files. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetExternal

Identifier of a dataset creation property list. Name of an external file. Offset, in bytes, from the beginning of the file to the location in the file where the data starts. Number of bytes reserved in the file for the data. Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Sets offset property for low-level access to a file in a family of files.

File access property list identifier. Offset in bytes within the HDF5 file. Returns a non-negative value if successful; otherwise returns a negative value.

Modifies the file access property list to use the H5FD_CORE driver.

Sets the file access property list to use the family driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplFamily

Sets up use of the direct I/O driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplDirect

File access property list identifier Required memory alignment boundary File system block size Copy buffer size Returns a non-negative value if successful; otherwise returns a negative value.

Sets up the logging virtual file driver (H5FD_LOG) for use. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplLog

File access property list identifier. Name of the log file. Flags specifying the types of logging activity. The size of the logging buffers, in bytes. Returns non-negative if successful. Otherwise returns negative. ASCII strings ONLY!

Modifies the file access property list to use the H5FD_SEC2 driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplSec2

File access property list identifier. Returns a non-negative value if successful. Otherwise returns a negative value.

Emulates the old split file driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplSplit

File access property list identifier. Metadata filename extension. File access property list identifier for the metadata file. Raw data filename extension. File access property list identifier for the raw data file. Returns a non-negative value if successful. Otherwise returns a negative value. ASCII strings ONLY!

Sets the standard I/O driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplStdio

File access property list identifier. Returns a non-negative value if successful. Otherwise returns a negative value.

Sets the Windows I/O driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplWindows

File access property list identifier Returns a non-negative value if successful; otherwise returns a negative value.

Sets the file close degree. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFcloseDegree

File access property list identifier. The file close degree property. Returns a non-negative value if successful. Otherwise returns a negative value.

Sets an initial file image in a memory buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFileImage

File access property list identifier Pointer to the initial file image, or NULL if no initial file image is desired Size of the supplied buffer, or 0 (zero) if no initial image is desired Returns a non-negative value if successful; otherwise returns a negative value.

Sets the callbacks for working with file images. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFileImageCallbacks

File access property list identifier Pointer to an instance of the H5FD.file_image_callbacks_t structure. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the file space management strategy and/or free-space section threshold for an HDF5 file. See https://www.hdfgroup.org/HDF5/docNewFeatures/FileSpace/H5Pset_file_space.htm

The file creation property list identifier. The strategy for file space management. The free-space section threshold. The library default is 1, which is to track all free-space sections. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the time when fill values are written to a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFillTime

Dataset creation property list identifier. When to write fill values to a dataset. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the fill value for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFillValue

Dataset creation property list identifier. Datatype of . Pointer to buffer containing value to use as fill value. Returns a non-negative value if successful; otherwise returns a negative value.

Adds a filter to the filter pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFilter

Dataset or group creation property list identifier. Filter identifier for the filter to be added to the pipeline. Bit vector specifying certain general properties of the filter. Number of elements in cd_values. Auxiliary data for the filter. Returns a non-negative value if successful; otherwise returns a negative value.

Sets user-defined filter callback function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFilterCallback

Dataset transfer property list identifier. User-defined filter callback function. User-defined input data for the callback function. Returns a non-negative value if successful; otherwise returns a negative value.

Sets up use of the Fletcher32 checksum filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFletcher32

Dataset or group creation property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Sets garbage collecting references flag.

File access property list identifier. Flag setting reference garbage collection to on (1) or off (0). Returns a non-negative value if successful; otherwise returns a negative value.

Sets number of I/O vectors to be read/written in hyperslab I/O. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetHyperVectorSize

Dataset transfer property list identifier. Number of I/O vectors to accumulate in memory for I/O operations. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the size of the parameter used to control the B-trees for indexing chunked datasets. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetIstoreK

File creation property list identifier 1/2 rank of chunked storage B-tree Returns a non-negative value if successful; otherwise returns a negative value.

Sets the type of storage used to store the raw data for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLayout

Identifier of property list to query. Type of storage layout for raw data. Returns a non-negative value if successful; otherwise returns a negative value.

Sets bounds on library versions, and indirectly format versions, to be used when creating objects. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLibverBounds

File access property list identifier The earliest version of the library that will be used for writing objects, indirectly specifying the earliest object format version that can be used when creating objects in the file. The latest version of the library that will be used for writing objects, indirectly specifying the latest object format version that can be used when creating objects in the file. Returns a non-negative value if successful; otherwise returns a negative value.

Sets creation order tracking and indexing for links in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLinkCreationOrder

Group creation property list identifier Creation order flag(s) Returns a non-negative value if successful; otherwise returns a negative value.

Sets the parameters for conversion between compact and dense groups. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLinkPhaseChange

Specifies the anticipated maximum size of a local heap. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLocalHeapSizeHint

Group creation property list identifier Anticipated maximum size in bytes of local heap Returns a non-negative value if successful; otherwise returns a negative value.

Sets the callback function that H5Ocopy will invoke before searching the entire destination file for a matching committed datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetMcdtSearchCb

Object copy property list identifier User-defined callback function User-defined input data for the callback function Returns a non-negative value if successful; otherwise returns a negative value.

Set the initial metadata cache configuration in the indicated File Access Property List to the supplied value. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetMdcConfig

Identifier of the file access property list. Pointer to the instance of H5AC.cache_config_t containing the desired configuration. Returns a non-negative value if successful; otherwise returns a negative value.

Sets metadata cache logging options. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Pset_mdc_log_options.htm

File access property list identifier. Whether logging is enabled. Log file name. Whether the logging will begin as soon as the file is opened or created. Returns a non-negative value if successful. Otherwise returns a negative value. ASCII strings ONLY!

Sets the minimum metadata block size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetMetaBlockSize

File access property list identifier. Minimum size, in bytes, of metadata block allocations. Returns a non-negative value if successful. Otherwise returns a negative value.

Retrieves the number of read attempts from a file access property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Pset_metadata_read_attempts.htm

Identifier for a file access property list. The number of read attempts. Returns a non-negative value if successful; otherwise returns a negative value.

Sets up the use of the N-Bit filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetNbit

Dataset creation property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Sets maximum number of soft or user-defined link traversals. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetNLinks

File access property list identifier Maximum number of links to traverse Returns a non-negative value if successful; otherwise returns a negative value.

Sets the recording of times associated with an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetObjTrackTimes

Object creation property list identifier Boolean value, 1 or 0, specifying whether object times are to be tracked Returns a non-negative value if successful; otherwise returns a negative value.

Sets a callback function to invoke when an object flush occurs in the file. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Pset_object_flush_cb.htm

Sets up the use of the scale-offset filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetScaleoffset

Dataset creation property list identifier. Flag indicating compression method. Parameter related to scale. Must be non-negative. Returns a non-negative value if successful; otherwise returns a negative value.

Configures the specified shared object header message index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSharedMesgIndex

File creation property list identifier. Index being configured Types of messages that should be stored in this index. Minimum message size. Returns a non-negative value if successful; otherwise returns a negative value.

Sets number of shared object header message indexes. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSharedMesgNIndexes

File creation property list Number of shared object header message indexes to be available in files created with this property list Returns a non-negative value if successful; otherwise returns a negative value.

Sets shared object header message storage phase change thresholds. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSharedMesgPhaseChange

Sets up use of the shuffle filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetShuffle

Dataset creation property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the maximum size of the data sieve buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSieveBufSize

File access property list identifier. Maximum size, in bytes, of data sieve buffer. Returns a non-negative value if successful. Otherwise returns a negative value.

Sets the byte size of the offsets and lengths used to address objects in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSizes

Identifier of property list to modify. Size of an object offset in bytes. Size of an object length in bytes. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the size of a contiguous block reserved for small data. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSmallData

File access property list identifier. Maximum size, in bytes, of the small data block. Returns a non-negative value if successful; otherwise a negative value.

Sets the size of parameters used to control the symbol table nodes. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSymK

File creation property list identifier Symbol table tree rank Symbol table node size Returns a non-negative value if successful; otherwise returns a negative value.

Sets up use of the SZIP compression filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSzip

Dataset creation property list identifier. A bit-mask conveying the desired SZIP options. The number of pixels or data elements in each data block. Returns a non-negative value if successful; otherwise returns a negative value.

Sets user-defined datatype conversion callback function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetTypeConvCb

Sets user block size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetUserblock

Identifier of property list to modify. Size of the user-block in bytes. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the mapping between virtual and source datasets. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pset_virtual.htm

The identifier of the dataset creation property list that will be used when creating the virtual dataset. The dataspace identifier with the selection within the virtual dataset applied, possibly an unlimited selection. The name of the HDF5 file where the source dataset is or will be located. The path to the HDF5 dataset in the file specified by . The source dataset’s dataspace identifier with a selection applied, possibly an unlimited selection Returns a non-negative value if successful; otherwise returns a negative value.

Sets the maximum number of missing source files and/or datasets with the printf-style names when getting the extent of an unlimited virtual dataset. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pset_virtual_printf_gap.htm

Dataset access property list identifier for the virtual dataset Maximum number of files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings Returns a non-negative value if successful; otherwise returns a negative value.

Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pset_virtual_view.htm

Identifier of the virtual dataset access property list. Flag specifying the extent of the data to be included in the view. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the memory manager for variable-length datatype allocation in H5Dread and H5Dvlen_reclaim. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetVLMemManager

Identifier for the dataset transfer property list. User's allocate routine, or NULL for system malloc. Extra parameter for user's allocation routine. Contents are ignored if preceding parameter is NULL. User's free routine, or NULL for system free. Extra parameter for user's free routine. Contents are ignored if preceding parameter is NULL. Returns a non-negative value if successful; otherwise returns a negative value.

Removes a property from a property list class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Unregister

Property list class from which to remove permanent property Name of property to remove Returns a non-negative value if successful; otherwise returns a negative value.

Creates a reference. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-Create

Reference created by the function call. Location identifier used to locate the object being pointed to. Name of object at location . Type of reference. Dataspace identifier with selection. Used only for dataset region references; pass as -1 if reference is an object reference. Returns a non-negative value if successful; otherwise returns a negative value.

Creates a reference. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-Create

Opens the HDF5 object referenced.

Valid identifier for the file containing the referenced object or any object in that file. The reference type of . Reference to open. Returns identifier of referenced object if successful; otherwise returns a negative value.

Retrieves a name for a referenced object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-GetName

Identifier for the file containing the reference or for any object in that file. Type of reference. An object or dataset region reference. A buffer to place the name of the referenced object or dataset region. If NULL, then this call will return the size in bytes of the name. The size of the buffer. Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value.

Retrieves a name for a referenced object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-GetName

Retrieves the type of object that an object reference points to. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-GetObjType2

The dataset containing the reference object or the group containing that dataset. Type of reference to query. Reference to query. Type of referenced object. Returns a non-negative value if successful; otherwise returns a negative value.

Sets up a dataspace and selection as specified by a region reference. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-GetRegion

File identifier or identifier for any object in the file containing the referenced region Reference type of , which must be DATASET_REGION. Region reference to open Returns a valid dataspace identifier if successful; otherwise returns a negative value.

Reference types allowed.

invalid Reference Type

Object reference

Dataset Region Reference

highest type (Invalid as true type)

Query state of the loading of dynamic plugins. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5PL.html

List of dynamic plugin types that are enabled or disabled. Returns a non-negative value if successful; otherwise returns a negative value.

Control the loading of dynamic plugins. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5PL.html

The list of dynamic plugin types to enable or disable. Returns a non-negative value if successful; otherwise returns a negative value.

Bit flags for the H5Pset_chunk_opts() and H5Pget_chunk_opts()

Closes the specified dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Close

Identifier of the dataset to close access to. Returns a non-negative value if successful; otherwise returns a negative value.

Creates a new dataset and links it into the file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Create2

Location identifier Dataset name Datatype identifier Dataspace identifier Link creation property list Dataset creation property list Dataset access property list Returns a dataset identifier if successful; otherwise returns a negative value.

Creates a new dataset and links it into the file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Create2

Creates a dataset in a file without linking it into the file structure. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-CreateAnon

Identifier of the file or group within which to create the dataset. Identifier of the datatype to use when creating the dataset. Identifier of the dataspace to use when creating the dataset. Dataset creation property list identifier. Dataset access property list identifier. Returns a dataset identifier if successful; otherwise returns a negative value.

Fills dataspace elements with a fill value in a memory buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Fill

Pointer to the fill value to be used. Fill value datatype identifier. Pointer to the memory buffer containing the selection to be filled. Datatype of dataspace elements to be filled. Dataspace describing memory buffer and containing the selection to be filled. Returns a non-negative value if successful; otherwise returns a negative value.

Flushes all buffers associated with a dataset to disk. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Dflush.htm

Identifier of the dataset to be flushed. Returns a non-negative value if successful; otherwise returns a negative value.

Identifier of the dataset to be flushed.

Gathers data from a selection within a memory buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Gather

Identifier for the dataspace describing both the dimensions of the source buffer and the selection within the source buffer to gather data from. Source buffer which the data will be gathered from. Identifier for the datatype describing the data in both the source and definition buffers. This is only used to calculate the element size. Size in bytes of . Destination buffer where the gathered data will be placed. Callback function which handles the gathered data. Optional if is large enough to hold all of the gathered data; required otherwise. User-defined pointer to data required by . Returns a non-negative value if successful; otherwise returns a negative value.

Returns the dataset access property list associated with a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetAccessPlist

Identifier of the dataset to get access property list of. Returns a dataset access property list identifier if Ssuccessful; otherwise returns a negative value.

Returns an identifier for a copy of the dataset creation property list for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetCreatePlist

Identifier of the dataset to query. Returns a dataset creation property list identifier if successful; otherwise returns a negative value.

Returns dataset address in file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetOffset

Dataset identifier. Returns the offset in bytes; otherwise returns HADDR_UNDEF, a negative value.

Returns an identifier for a copy of the dataspace for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetSpace

Identifier of the dataset to query. Returns a dataspace identifier if successful; otherwise returns a negative value.

Determines whether space has been allocated for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetSpaceStatus

Identifier of the dataset to query. Space allocation status. Returns a non-negative value if successful; otherwise returns a negative value.

Returns the amount of storage allocated for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetStorageSize

Identifier of the dataset to query. Returns the amount of storage space, in bytes, allocated for the dataset, not counting metadata; otherwise returns 0 (zero).

Returns an identifier for a copy of the datatype for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetType

Identifier of the dataset to query. Returns a datatype identifier if successful; otherwise returns a negative value.

Iterates over all selected elements in a dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Iterate

Pointer to the buffer in memory containing the elements to iterate over Datatype identifier for the elements stored in buf Dataspace identifier for buf Function pointer to the routine to be called for each element in buf iterated over Pointer to any user-defined data associated with the operation Returns the return value of the last operator if it was non-zero, or zero if all elements have been processed. Otherwise returns a negative value.

Opens an existing dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Open2

Location identifier Dataset name Dataset access property list Returns a dataset identifier if successful; otherwise returns a negative value.

Opens an existing dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Open2

Location identifier Dataset name Dataset access property list Returns a dataset identifier if successful; otherwise returns a negative value. ASCII strings ONLY!

Reads raw data from a dataset into a buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Read

Identifier of the dataset read from. Identifier of the memory datatype. Identifier of the memory dataspace. Identifier of the dataset's dataspace in the file. Identifier of a transfer property list for this I/O operation. Buffer to receive data read from file. Returns a non-negative value if successful; otherwise returns a negative value.

Refreshes all buffers associated with a dataset. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Drefresh.htm

Identifier of the dataset to be refreshed. Returns a non-negative value if successful; otherwise returns a negative value.

Scatters data into a selection within a memory buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Scatter

Callback function which provides data to be scattered. User-defined pointer to data required by op. Identifier for the datatype describing the data in both the source and definition buffers. This is only used to calculate the element size. Identifier for the dataspace describing both the dimensions of the destination buffer and the selection within the destination buffer that data will be scattered to. Destination buffer which the data will be scattered to. Returns a non-negative value if successful; otherwise returns a negative value.

Changes the sizes of a dataset’s dimensions. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-SetExtent

Dataset identifier Array containing the new magnitude of each dimension of the dataset. Returns a non-negative value if successful; otherwise returns a negative value.

Changes the sizes of a dataset’s dimensions. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-SetExtent

Dataset identifier Array containing the new magnitude of each dimension of the dataset. Returns a non-negative value if successful; otherwise returns a negative value.

Determines the number of bytes required to store variable-length (VL) data. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-VLGetBuf

Identifier of the dataset to query. Datatype identifier. Dataspace identifier. The size in bytes of the memory buffer required to store the VL data. Returns non-negative value if successful; otherwise returns a negative value.

Reclaims variable-length (VL) datatype memory buffers. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-VLReclaim

Identifier of the datatype. Identifier of the dataspace. Identifier of the property list used to create the buffer. Pointer to the buffer to be reclaimed. Returns non-negative value if successful; otherwise returns a negative value.

Writes raw data from a buffer to a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Write

Identifier of the dataset to write to. Identifier of the memory datatype. Identifier of the memory dataspace. Identifier of the dataset's dataspace in the file. Identifier of a transfer property list for this I/O operation. Buffer with data to be written to the file. Returns a non-negative value if successful; otherwise returns a negative value.

Values for the H5D_LAYOUT property

Types of chunk index data structures

v1 B-tree index [value = 0]

Implicit: No Index (H5D_ALLOC_TIME_EARLY, non-filtered, fixed dims)

Fixed array (for 0 unlimited dims)

Extensible array (for 1 unlimited dim)

v2 B-tree index (for >1 unlimited dims)

Values for the space allocation time property

Values for the status of space allocation

Values for time of writing fill value property

Values for fill value status

Values for VDS bounds option

Callback for H5P.set_append_flush in a dataset access property list

Delegate for H5Dgather() callback See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Gather

Pointer to the destination buffer which has been filled with the next set of elements gathered. Pointer to the number of valid bytes in . User-defined pointer to data required by the callback function. The callback function should return zero (0) to indicate success, and a negative value to indicate failure.

Delegate for H5Diterate() callback See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Iterate

Pointer to the memory buffer containing the current data element Datatype identifier for the elements stored in Number of dimensions for the array Array containing the location of the element within the original dataspace Pointer to any user-defined data associated with the operation Zero causes the iterator to continue, returning zero when all data elements have been processed. A positive value causes the iterator to immediately return that positive value, indicating short-circuit success. A negative value causes the iterator to immediately return that value, indicating failure.

Delegate for H5Dscatter() See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Scatter

Pointer to the buffer holding the next set of elements to scatter. Pointer to the number of valid bytes in . User-defined pointer to data required by the callback function. The callback function should return zero (0) to indicate success, and a negative value to indicate failure.

Closes the specified attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Close

Attribute to release access to. Returns a non-negative value if successful; otherwise returns a negative value.

Creates an attribute attached to a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Create2

Location or object identifier Attribute name Attribute datatype identifier Attribute dataspace identifier Attribute creation property list identifier Attribute access property list identifier Returns an attribute identifier if successful; otherwise returns a negative value.

Creates an attribute attached to a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Create2

Creates an attribute attached to a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-CreateByName

Location or object identifier; may be dataset or group Name, relative to , of object that attribute is to be attached to Attribute name Attribute datatype identifier Attribute dataspace identifier Attribute creation property list identifier Attribute access property list identifier Link access property list Returns an attribute identifier if successful; otherwise returns a negative value.

Creates an attribute attached to a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-CreateByName

Deletes an attribute from a specified location. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Delete

Identifier of the dataset, group, or named datatype to have the attribute deleted from. Name of the attribute to delete. Returns a non-negative value if successful; otherwise returns a negative value.

Deletes an attribute from a specified location. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Delete

Deletes an attribute from an object according to index order. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-DeleteByIdx

Location or object identifier; may be dataset or group Name of object, relative to location, from which attribute is to be removed Type of index Order in which to iterate over index Offset within index Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Deletes an attribute from an object according to index order. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-DeleteByIdx

Removes an attribute from a specified location. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-DeleteByName

Location or object identifier; may be dataset or group Name of object, relative to location, from which attribute is to be removed Name of attribute to delete Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Removes an attribute from a specified location. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-DeleteByName

Determines whether an attribute with a given name exists on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Exists

Object identifier Attribute name When successful, returns a positive value, for TRUE, or 0 (zero), for FALSE. Otherwise returns a negative value.

Determines whether an attribute with a given name exists on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Exists

Object identifier Attribute name When successful, returns a positive value, for TRUE, or 0 (zero), for FALSE. Otherwise returns a negative value. ASCII strings ONLY!

Determines whether an attribute with a given name exists on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-ExistsByName

Location identifier Object name Attribute name Link access property list identifier When successful, returns a positive value, for TRUE, or 0 (zero), for FALSE. Otherwise returns a negative value.

Determines whether an attribute with a given name exists on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-ExistsByName

Gets an attribute creation property list identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetCreatePlist

Identifier of the attribute. Returns an identifier for the attribute’s creation property list if successful. Otherwise returns a negative value.

Retrieves attribute information, by attribute identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetInfo

Attribute identifier Attribute information struct Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves attribute information, by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetInfoByIdx

Location of object to which attribute is attached Name of object to which attribute is attached, relative to location Type of index Index traversal order Attribute’s position in index Struct containing returned attribute information Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves attribute information, by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetInfoByIdx

Retrieves attribute information, by attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetInfoByName

Location of object to which attribute is attached Name of object to which attribute is attached, relative to location Attribute name Struct containing returned attribute information Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves attribute information, by attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetInfoByName

Gets an attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetName

Identifier of the attribute. The size of the buffer to store the name in. Buffer to store name in. Returns the length of the attribute's name, which may be longer than buf_size, if successful. Otherwise returns a negative value.

Gets an attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetName

Gets an attribute name, by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetNameByIdx

Location of object to which attribute is attached Name of object to which attribute is attached, relative to location Type of index Index traversal order Attribute’s position in index Attribute name Size, in bytes, of attribute name Link access property list Returns attribute name size, in bytes, if successful; otherwise returns a negative value.

Gets an attribute name, by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetNameByIdx

Location of object to which attribute is attached Name of object to which attribute is attached, relative to location Type of index Index traversal order Attribute’s position in index Attribute name Size, in bytes, of attribute name Link access property list Returns attribute name size, in bytes, if successful; otherwise returns a negative value. ASCII strings ONLY!

Gets an attribute name, by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetNameByIdx

Location of object to which attribute is attached Name of object to which attribute is attached, relative to location Type of index Index traversal order Attribute’s position in index Attribute name Size, in bytes, of attribute name Link access property list Returns attribute name size, in bytes, if successful; otherwise returns a negative value. ASCII strings ONLY!

Gets a copy of the dataspace for an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetSpace

Identifier of an attribute. Returns attribute dataspace identifier if successful; otherwise returns a negative value.

Returns the amount of storage required for an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetStorageSize

Identifier of the attribute to query. Returns the amount of storage size allocated for the attribute; otherwise returns 0 (zero).

Returns the amount of storage required for an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetType

Identifier of an attribute. Returns a datatype identifier if successful; otherwise returns a negative value.

Calls user-defined function for each attribute on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Iterate2

Identifier for object to which attributes are attached; may be group, dataset, or named datatype. Type of index Order in which to iterate over index Initial and returned offset within index User-defined function to pass each attribute to User data to pass through to and to be returned by iterator operator function Returns a non-negative value if successful; otherwise returns a negative value. Further note that this function returns the return value of the last operator if it was non-zero, which can be a negative value, zero if all attributes were processed, or a positive value indicating short-circuit success

Calls user-defined function for each attribute on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-IterateByName

Location or object identifier; may be dataset or group Name of object, relative to location Type of index Order in which to iterate over index Initial and returned offset within index User-defined function to pass each attribute to User data to pass through to and to be returned by iterator operator function Link access property list Returns a non-negative value if successful; otherwise returns a negative value. Further note that this function returns the return value of the last operator if it was non-zero, which can be a negative value, zero if all attributes were processed, or a positive value indicating short-circuit success

Calls user-defined function for each attribute on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-IterateByName

Opens an attribute for an object specified by object identifier and attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Open

Identifer for object to which attribute is attached Name of attribute to open Attribute access property list Returns an attribute identifier if successful; otherwise returns a negative value.

Opens an attribute for an object specified by object identifier and attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Open

Identifer for object to which attribute is attached Name of attribute to open Attribute access property list Returns an attribute identifier if successful; otherwise returns a negative value. ASCII strings ONLY!

Opens an attribute for an object specified by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-OpenByIdx

Location of object to which attribute is attached Name of object to which attribute is attached, relative to location Type of index Index traversal order Attribute’s position in index Attribute access property list Link access property list Returns an attribute identifier if successful; otherwise returns a negative value.

Opens an attribute for an object specified by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-OpenByIdx

Location of object to which attribute is attached Name of object to which attribute is attached, relative to location Type of index Index traversal order Attribute’s position in index Attribute access property list Link access property list Returns an attribute identifier if successful; otherwise returns a negative value. ASCII strings ONLY!

Opens an attribute for an object by object name and attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-OpenByName

Location from which to find object to which attribute is attached Name of object to which attribute is attached, relative to Name of attribute to open Attribute access property list Link access property list Returns an attribute identifier if successful; otherwise returns a negative value.

Opens an attribute for an object by object name and attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-OpenByName

Reads an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Read

Identifier of an attribute to read. Identifier of the attribute datatype (in memory). Buffer for data to be read. Returns a non-negative value if successful; otherwise returns a negative value.

Renames an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Rename

Location of the attribute. Name of the attribute to be changed. New name for the attribute. Returns a non-negative value if successful; otherwise returns a negative value.S

Renames an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Rename

Location of the attribute. Name of the attribute to be changed. New name for the attribute. Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Renames an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-RenameByName

Location or object identifier; may be dataset or group Name of object, relative to location, whose attribute is to be renamed Prior attribute name New attribute name Link access property list identifier Returns a non-negative value if successful; otherwise returns a negative value.

Renames an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-RenameByName

Writes data to an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Write

Identifier of an attribute to write. Identifier of the attribute datatype (in memory). Data to be written.

Information struct for attribute (for H5Aget_info/H5Aget_info_by_idx)

Indicate if creation order is valid

Creation order

Character set of attribute name

Size of raw data

Delegate for H5Aiterate2() callbacks See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Iterate2

The location identifier for the group or dataset being iterated over The name of the current object attribute. The attribute’s infostruct A pointer referencing operator data passed to iterate Valid return values from an operator and the resulting H5Aiterate2 and op behavior are as follows: Zero causes the iterator to continue, returning zero when all attributes have been processed. A positive value causes the iterator to immediately return that positive value, indicating short-circuit success. The iterator can be restarted at the next attribute, as indicated by the return value of n. A negative value causes the iterator to immediately return that value, indicating failure. The iterator can be restarted at the next attribute, as indicated by the return value of n.

Helper class used to fetch public variables (e.g. native type values) exported by the HDF5 DLL

Writes a raw data chunk from a buffer directly to a dataset. See https://www.hdfgroup.org/HDF5/doc/HL/RM_HDF5Optimized.html

Identifier for the dataset to write to UNUSED Mask for identifying the filters in use Logical position of the chunk’s first element in the dataspace Size of the actual data to be written in bytes Buffer containing data to be written to the file Returns a non-negative value if successful; otherwise returns a negative value.

Appends data to a dataset along a specified dimension. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5DOappend.htm

Dataset identifier. Dataset transfer property list identifier. Dimension number (0-based). Number of elements to add along the dimension. Memory type identifier. Data buffer. Returns a non-negative value if successful; otherwise returns a negative value.

absence of rdwr => rd-only

open for read and write

overwrite existing files

fail if file already exists

create non-existing files

indicate that this file is open for writing in a single-writer/multi-reader (SWMR) scenario. Note that the process(es) opening the file for reading must open the file with RDONLY access, and use the special SWMR_READ access flag.

indicate that this file is open for reading in a single-writer/multi-reader (SWMR) scenario. Note that the process(es) opening the file for SWMR reading must also open the file with the RDONLY flag.

Value passed to H5P.set_elink_acc_flags to cause flags to be taken from the parent file.

File objects

Dataset objects

Group objects

Named datatype objects

Attribute objects

All objects: H5F_OBJ_FILE|H5F_OBJ_DATASET|H5F_OBJ_GROUP|H5F_OBJ_DATATYPE|H5F_OBJ_ATTR)

All local objects: Restrict search to objects opened through current file ID (as opposed to objects opened through any file ID accessing this file)

Unlimited file size for H5P.set_external()

Clears the external link open file cache. https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-ClearELinkFileCache

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

Terminates access to an HDF5 file. https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Close

Identifier of a file to which access is terminated. Returns a non-negative value if successful; otherwise returns a negative value.

Creates an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-CreateS

Name of the file to access. File access flags (H5.ACC_*). File creation property list identifier. File access property list identifier. Returns a file identifier if successful; otherwise returns a negative value. MUST be an ASCII string.

Flushes all buffers associated with a file to disk. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Flush

Identifier of object used to identify the file. Specifies the scope of the flushing action. Returns a non-negative value if successful; otherwise returns a negative value.

Returns a file access property list identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetAccessPlist

Identifier of file of which to get access property list Returns a file access property list identifier if successful; otherwise returns a negative value.

Returns a file creation property list identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetCreatePlist

Identifier of file of which to get creation property list Returns a file access property list identifier if successful; otherwise returns a negative value.

Retrieves a copy of the image of an existing, open file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetFileImage

Target file identifier Pointer to the buffer into which the image of the HDF5 file is to be copied Size of the supplied buffer If successful, returns the size in bytes of the buffer required to store the file image if successful; otherwise returns a negative value.

Returns the size of an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetFilesize

Identifier of a currently-open HDF5 file Size of the file, in bytes. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves free-space section information for a file. See https://www.hdfgroup.org/HDF5/docNewFeatures/FileSpace/H5Fget_free_sections.htm

Identifier of a currently-open HDF5 file The file memory allocation type. The number of free-space sections. Array of instances of H5F.sect_info_t in which the free-space section information is to be returned.

Returns the amount of free space in a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetFreespace

Identifier of a currently-open HDF5 file Returns the amount of free space in the file if successful; otherwise returns a negative value.

Returns global information for a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetInfo

Object identifier for any object in the file. Struct containing global file information. Returns a non-negative value if successful; otherwise returns a negative value.

Determines the read/write or read-only status of a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetIntent

File identifier for a currently-open HDF5 file. Intended access mode flag as originally passed with H5Fopen. Returns a non-negative value if successful; otherwise returns a negative value.

Obtain current metadata cache configuration for target file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetMdcConfig

Identifier of the target file Pointer to the instance of H5AC_cache_config_t in which the current metadata cache configuration is to be reported. Returns a non-negative value if successful; otherwise returns a negative value.

Obtain target file's metadata cache hit rate. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetMdcHitRate

Identifier of the target file Pointer to the double in which the hit rate is returned. Returns a non-negative value if successful; otherwise returns a negative value.

Gets the current metadata cache logging status. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Fget_mdc_logging_status.htm

Identifier of an open HDF5 file. Whether logging is enabled. Whether events are currently being logged. Returns a non-negative value if successful. Otherwise returns a negative value.

Obtain current metadata cache size data for specified file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetMdcSize

Identifier of the target file Pointer to the location in which the current cache maximum size is to be returned, or NULL if this datum is not desired. Pointer to the location in which the current cache minimum clean size is to be returned, or NULL if that datum is not desired. Pointer to the location in which the current cache size is to be returned, or NULL if that datum is not desired. Pointer to the location in which the current number of entries in the cache is to be returned, or NULL if that datum is not desired. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the collection of read retries for metadata entries with checksum. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Fget_metadata_read_retry_info.htm

Identifier for a currently opened HDF5 file. Struct containing the collection of read retries for metadata entries with checksum. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves name of file to which object belongs. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetName

Identifier of the object for which the associated filename is sought. Buffer to contain the returned filename. Buffer size, in bytes. Returns the length of the filename if successful; otherwise returns a negative value.

Returns the number of open object identifiers for an open file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetObjCount

Identifier of a currently-open HDF5 file. Type of object for which identifiers are to be returned. Returns the number of open objects if successful; otherwise returns a negative value.

Returns a list of open object identifiers. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetObjIDs

Identifier of a currently-open HDF5 file. Type of object for which identifiers are to be returned. Maximum number of object identifiers to be returned. Pointer to the returned list of open object identifiers. Returns number of objects placed into obj_id_list if successful; otherwise returns a negative value.

Returns pointer to the file handle from the virtual file driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetVfdHandle

Identifier of the file to be queried. File access property list identifier. Pointer to the file handle being used by the low-level virtual file driver. Returns a non-negative value if successful; otherwise returns a negative value.

Determines whether a file is in the HDF5 format. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-IsHDF5

When successful, returns a positive value, for TRUE, or 0 (zero), for FALSE. On any error, including the case that the file does not exist, returns a negative value. MUST be an ASCII string.

Mounts a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Mount

Identifier for of file or group in which name is defined. Name of the group onto which the file specified by is to be mounted. Identifier of the file to be mounted. File mount property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Mounts a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Mount

Opens an existing HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Open

Name of the file to be opened. File access flags. (H5F_ACC_RDWR or H5F_ACC_RDONLY) Identifier for the file access properties list. Returns a file identifier if successful; otherwise returns a negative value. MUST be an ASCII string!

Returns a new identifier for a previously-opened HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Reopen

Identifier of a file for which an additional identifier is required. Returns a new file identifier if successful; otherwise returns a negative value.

Reset hit rate statistics counters for the target file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-ResetMdcHitRateStats

Identifier of the target file. Returns a non-negative value if successful; otherwise returns a negative value.

Attempt to configure metadata cache of target file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-SetMdcConfig

Identifier of the target file Pointer to the instance of H5AC_cache_config_t containing the desired configuration. Returns a non-negative value if successful; otherwise returns a negative value.

Starts logging metadata cache events if logging was previously enabled. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Fstart_mdc_logging.htm

Identifier of an open HDF5 file. Returns a non-negative value if successful. Otherwise returns a negative value.

Enables SWMR writing mode for a file. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Fstart_swmr_write.htm

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

Stops logging metadata cache events if logging was previously enabled and is currently ongoing. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Fstop_mdc_logging.htm

Identifier of an open HDF5 file. Returns a non-negative value if successful. Otherwise returns a negative value.

Unmounts a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Unmount

File or group identifier for the location at which the specified file is to be unmounted. Name of the mount point. Returns a non-negative value if successful; otherwise returns a negative value.

Unmounts a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Unmount

File or group identifier for the location at which the specified file is to be unmounted. Name of the mount point. Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

The difference between a single file and a set of mounted files

specified file handle only [value = 0].

entire virtual file [value = 1].

Flags that control the behavior of H5F.close()

Use the degree pre-defined by underlining VFL [value = 0].

file closes only after all opened objects are closed [value = 1].

if no opened objects, file is close; otherwise, file close fails [value = 2].

if there are opened objects, close them first, then close file [value = 3].

Current "global" information about a file (just size info currently)

Superblock version #

Superblock size

Superblock extension size

Version # of file free space management

Free space manager metadata size

Amount of free space in the file

Version # of shared object header info

Shared object header message header size

Types of allocation requests

Data should not appear in the free list. [value = -1].

Value not yet set. Can also be the datatype set in a larger allocation that will be suballocated by the library. Must be zero. [value = 0].

Superblock data [value = 1].

B-tree data [value = 2].

Raw data (content of datasets, etc.) [value = 3].

Global heap data [value = 4].

Local heap data [value = 5].

Object header data [value = 6].

Sentinel value [value = 7].

Free space section information

Address of free space section

Size of free space section

Library's file format versions

Use the earliest possible format for storing objects

Use the latest possible format available for storing objects

File space handling strategy

Default (or current) free space strategy setting

Persistent free space managers, aggregators, virtual file driver

Non-persistent free space managers, aggregators, virtual file driver. This is the library default

Aggregators, Virtual file driver

Virtual file driver

Data structure to report the collection of read retries for metadata items with checksum. Used by public routine H5F.get_metadata_read_retry_info

Callback for H5P.set_object_flush_cb in a file access property list

Closes the specified group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-Close

Group identifier to release. Returns a non-negative value if successful; otherwise returns a negative value.

Creates a new group and links it into the file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-Create2

File or group identifier Absolute or relative name of the link to the new group Link creation property list identifier Group creation property list identifier Group access property list identifier Returns a group identifier if successful; otherwise returns a negative value.

Creates a new group and links it into the file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-Create2

Creates a new empty group without linking it into the file structure. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-CreateAnon

File or group identifier specifying the file in which the new group is to be created Group creation property list identifier Group access property list identifier Returns a new group identifier if successful; otherwise returns a negative value.

Gets a group creation property list identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-GetCreatePlist

Identifier of the group. Returns an identifier for the group’s creation property list if successful. Otherwise returns a negative value.

Flushes all buffers associated with a group to disk. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Gflush.htm

Identifier of the group to be flushed. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves information about a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-GetInfo

Group identifier Struct in which group information is returned Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves information about a group, according to the group’s position within an index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-GetInfoByIdx

File or group identifier Name of group containing group for which information is to be retrieved Index type Order of the count in the index Position in the index of the group for which information is retrieved Struct in which group information is returned Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves information about a group, according to the group’s position within an index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-GetInfoByIdx

Retrieves information about a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-GetInfoByName

File or group identifier Name of group for which information is to be retrieved Struct in which group information is returned Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves information about a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-GetInfoByName

Opens an existing group with a group access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-Open2

File or group identifier specifying the location of the group to be opened Name of the group to open Group access property list identifier Returns a group identifier if successful; otherwise returns a negative value.

Opens an existing group with a group access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-Open2

Refreshes all buffers associated with a group. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Grefresh.htm

Identifier of the group to be refreshed. Returns a non-negative value if successful; otherwise returns a negative value.

Types of link storage for groups

Unknown link storage type [value = -1].

Links in group are stored with a "symbol table" (this is sometimes called "old-style" groups) [value = 0].

Links are stored in object header [value = 1].

Links are stored in fractal heap and indexed with v2 B-tree [value = 2].

Information struct for group (for H5Gget_info/H5Gget_info_by_name/H5Gget_info_by_idx)

Type of storage for links in group

Number of links in group

Current max. creation order value for group

Whether group has a file mounted on it

An invalid object ID. This is also negative for error return.

Deletes all identifiers of the given type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-ClearType

Identifier of identifier type which is to be cleared of identifiers Whether or not to force deletion of all identifiers Returns non-negative on success, negative on failure.

Decrements the reference count for an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-DecRef

Object identifier whose reference count will be modified. Returns a non-negative reference count of the object identifier after decrementing it, if successful; otherwise a negative value is returned.

Decrements the reference count on an identifier type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-DecTypeRef

The identifier of the type whose reference count is to be decremented Returns the current reference count on success, negative on failure.

Removes the type type and all identifiers within that type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-DestroyType

Identifier of identifier type which is to be destroyed Returns non-negative on success, negative on failure.

Retrieves an identifier for the file containing the specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-GetFileId

Identifier of the object whose associated file identifier will be returned. Returns a file identifier on success, negative on failure.S

Retrieves a name of an object based on the object identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-GetName

Identifier of the object. This identifier can refer to a group, dataset, or named datatype. A name associated with the identifier. The size of the name buffer; must be the size of the name in bytes plus 1 for a NULL terminator. Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value. ASCII strings ONLY! This function does not work with UTF-8 encoded strings. See JIRA issue HDF5/HDFFV-9686.

Retrieves the reference count for an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-GetRef

Object identifier whose reference count will be retrieved. Returns a non-negative current reference count of the object identifier if successful; otherwise a negative value is returned.

Retrieves the type of an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-GetType

Object identifier whose type is to be determined. Returns the object type if successful; otherwise H5I_BADID.

Retrieves the reference count on an ID type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-GetTypeRef

The identifier of the type whose reference count is to be retrieved Returns the current reference count on success, negative on failure.

Increments the reference count for an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-IncRef

Object identifier whose reference count will be modified. Returns a non-negative reference count of the object ID after incrementing it if successful; otherwise a negative value is returned.

Increments the reference count on an ID type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-IncTypeRef

The identifier of the type whose reference count is to be incremented Returns the current reference count on success, negative on failure.

Determines whether an identifier is valid. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-IsValid

Identifier to validate Returns TRUE if is valid and FALSE if invalid. Otherwise returns a negative value.

Returns the number of identifiers in a given identifier type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-NMembers

Identifier for the identifier type whose member count will be retrieved Number of identifiers of the specified identifier type. Returns a non-negative value on success; otherwise returns negative value.

Returns the object referenced by id. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-ObjectVerify

ID to be dereferenced ID type to which id should belong Pointer to the object referenced by id on success, NULL on failure.

Creates and returns a new ID. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-Register

The identifier of the type to which the new ID will belong Pointer to memory for the library to store Returns the new ID on success, negative on failure.

Creates and returns a new ID type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-RegisterType

Size of the hash table (in entries) used to store IDs for the new type Number of reserved IDs for the new type Function used to deallocate space for a single ID Returns the type identifier on success, negative on failure.

Removes an ID from internal storage. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-RemoveVerify

The ID to be removed from internal storage The identifier of the type whose reference count is to be retrieved Returns a pointer to the memory referred to by id on success, NULL on failure.

Finds the memory referred to by an ID within the given ID type such that some criterion is satisfied. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-Search

The identifier of the type to be searched The function defining the search criteria A key for the search function Returns a pointer to the object which satisfies the search function on success, NULL on failure.

Determines whether an identifier type is registered. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5I.html#Identify-TypeExists

Identifier type. Returns 1 if the type is registered and 0 if not. Returns a negative value on failure.

uninitialized type [value = -2]

invalid Type [value = -1]

type ID for File objects [value = 1]

type ID for Group objects [value = 2]

type ID for Datatype objects [value = 3]

type ID for Dataspace objects [value = 4]

type ID for Dataset objects [value = 5]

type ID for Attribute objects [value = 6]

type ID for Reference objects [value = 7]

type ID for virtual file layer [value = 8]

type ID for generic property list classes [value = 9]

type ID for generic property lists [value = 10]

type ID for error classes [value = 11]

type ID for error messages [value = 12]

type ID for error stacks [value = 13]

number of library types, MUST BE LAST! [value = 14]

Function for freeing objects. This function will be called with an object ID type number and a pointer to the object. The function should free the object and return non-negative to indicate that the object can be removed from the ID type. If the function returns negative (failure) then the object will remain in the ID type.

Type of the function to compare objects and keys

Copy only immediate members

Expand soft links into new objects

Expand external links into new objects

Copy objects that are pointed by references

Copy object without copying attributes

Copy NULL messages (empty space)

Merge committed datatypes in dest file

All object copying flags (for internal checking

No shared messages

Simple Dataspace Message.

Datatype Message.

Fill Value Message.

Filter pipeline message.

Attribute Message.

2-bit field indicating # of bytes to store the size of chunk 0's data

Attribute creation order is tracked

Attribute creation order has index

Non-default attribute storage phase change values stored

Store access, modification, change and birth times for object

Determines if an HDF5 object (dataset, group, committed datatype) has had flushes of metadata entries disabled. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Oare_mdc_flushes_disabled.htm

Identifier of an object in the cache. Flushes enabled/disabled. Returns a non-negative value if successful; otherwise returns a negative value.

Closes an object in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Close

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

Copies an object in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Copy

Object identifier indicating the location of the source object to be copied Name of the source object to be copied Location identifier specifying the destination Name to be assigned to the new copy Object copy property list Link creation property list for the new hard link Returns a non-negative value if successful; otherwise returns a negative value.

Copies an object in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Copy

Decrements an object's reference count. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-DecrRefCount

Object identifier Returns a non-negative value if successful; otherwise returns a negative value. This function must be used with care! Improper use can lead to inaccessible data, wasted space in the file, or file corruption.

Prevents metadata entries for an HDF5 object from being flushed from the metadata cache to storage. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Odisable_mdc_flushes.htm

Identifier of the object that will have flushes disabled. Returns a non-negative value if successful; otherwise returns a negative value.

Allow metadata entries for an HDF5 object to be flushed from the metadata cache to storage. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Oenable_mdc_flushes.htm

Identifier of the object that will have flushes (re-)enabled. Returns a non-negative value if successful; otherwise returns a negative value.

Determines whether a link resolves to an actual object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-ExistsByName

Identifier of the file or group to query. The name of the link to check. Link access property list identifier. Returns 1 or 0 if successful; otherwise returns a negative value.

Flushes all buffers associated with an HDF5 object to disk. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Oflush.htm

Identifier of the object to be flushed. Returns a non-negative value if successful; otherwise returns a negative value.

Determines whether a link resolves to an actual object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-ExistsByName

Identifier of the file or group to query. The name of the link to check. Link access property list identifier. Returns 1 or 0 if successful; otherwise returns a negative value. ASCII strings ONLY!

Retrieves comment for specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetComment

Identifier for the target object. The comment. Size of the buffer. Upon success, returns the number of characters in the comment, not including the NULL terminator, or zero (0) if the object has no comment. The value returned may be larger than size. Otherwise returns a negative value.

Retrieves comment for specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetCommentByName

Identifier of a file, group, dataset, or named datatype. Name of the object whose comment is to be retrieved, specified as a path relative to . The comment. Size of the buffer. Link access property list identifier. Upon success, returns the number of characters in the comment, not including the NULL terminator, or zero (0) if the object has no comment. The value returned may be larger than . Otherwise returns a negative value.

Retrieves comment for specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetCommentByName

Retrieves the metadata for an object specified by an identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetInfo

Identifier for object of type specified by H5O.type_t Buffer in which to return object information Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the metadata for an object, identifying the object by an index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetInfoByIdx

File or group identifier specifying location of group in which object is located Name of group in which object is located Index or field that determines the order Order within field or index Object for which information is to be returned Buffer in which to return object information Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the metadata for an object, identifying the object by an index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetInfoByIdx

Retrieves the metadata for an object, identifying the object by location and relative name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetInfoByName

File or group identifier specifying location of group in which object is located Name of object, relative to Buffer in which to return object information Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the metadata for an object, identifying the object by location and relative name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetInfoByName

File or group identifier specifying location of group in which object is located Name of group, relative to Buffer in which to return object information Link access property list Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Increments an object's reference count. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-IncrRefCount

Creates a hard link to an object in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Link

Object to be linked. File or group identifier specifying location at which object is to be linked. Name of link to be created, relative to . Link creation property list identifier. Link access property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Creates a hard link to an object in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Link

Opens an object in an HDF5 file by location identifier and path name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Open

File or group identifier Path to the object, relative to . Access property list identifier for the link pointing to the object Returns an object identifier for the opened object if successful; otherwise returns a negative value.

Opens an object in an HDF5 file by location identifier and path name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Open

Opens an object using its address within an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-OpenByAddr

File or group identifier Object’s address in the file Returns an object identifier for the opened object if successful; otherwise returns a negative value. This function must be used with care! Improper use can lead to inaccessible data, wasted space in the file, or file corruption.

Open the n-th object in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-OpenByIdx

A file or group identifier. Name of group, relative to , in which object is located Type of index by which objects are ordered Order of iteration within index Object to open Link access property list Returns an object identifier for the opened object if successful; otherwise returns a negative value.

Refreshes all buffers associated with an HDF5 object. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Orefresh.htm

Identifier of the object to be refreshed. Returns a non-negative value if successful; otherwise returns a negative value.

Open the n-th object in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-OpenByIdx

Recursively visits all objects accessible from a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Visit

Identifier of the object at which the recursive iteration begins. Type of index Order in which index is traversed Callback function passing data regarding the object to the calling application User-defined pointer to data required by the application for its processing of the object On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero. On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.

Recursively visits all objects starting from a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-VisitByName

Identifier of a file or group Name of the object, generally relative to , that will serve as root of the iteration Type of index Order in which index is traversed Callback function passing data regarding the object to the calling application User-defined pointer to data required by the application for its processing of the object Link access property list identifier On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero. On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.

Recursively visits all objects starting from a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-VisitByName

Types of objects in file

Unknown object type [value = -1]

Object is a group [value = 0]

Object is a dataset [value = 1]

Object is a named data type [value = 2]

Number of different object types (must be last!) [value = 3]

Information struct for object header metadata (for H5Oget_info/H5Oget_info_by_name/H5Oget_info_by_idx)

Version number of header format in file

Number of object header messages

Number of object header chunks

Object header status flags

Total space for storing object header in file

Space within header for object header metadata information

Space within header for actual message information

Free space within object header

Flags to indicate presence of message type in header

Flags to indicate message type is shared in header

v1/v2 B-tree and local/fractal heap for groups, B-tree for chunked datasets

v2 B-tree and heap for attributes

Information struct for object (for H5Oget_info/H5Oget_info_by_name/H5Oget_info_by_idx)

File number that object is located in

Object address in file

Basic object type (group, dataset, etc.)

Reference count of object

Access time

Modification time

Change time

Birth time

# of attributes attached to object

Object header information

Extra metadata storage for object and attributes

Prototype for H5Ovisit/H5Ovisit_by_name() operator

Abort H5Ocopy [value = -1]

Continue the global search of all committed datatypes in the destination file [value = 0]

Stop the search, but continue copying. The committed datatype will be copied but not merged. [value = 1]

Callback to invoke when completing the search for a matching committed datatype from the committed dtype list

Pointer to user-defined input data. Returns one of the MCDT_SEARCH_* values.

Allocates memory that will later be freed internally by the HDF5 Library. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-AllocateMemory

Specifies the size in bytes of the buffer to be allocated. Specifies whether the new buffer is to be initialized to 0 (zero). On success, returns pointer to newly allocated buffer or returns NULL if size is 0 (zero). Returns NULL on failure.

Flushes all data to disk, closes all open identifiers, and cleans up memory. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-Close

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

Instructs library not to install atexit cleanup routine. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-DontAtExit

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

Frees memory allocated by the HDF5 Library. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-FreeMemory

Buffer to be freed. Can be NULL. Returns a non-negative value if successful; otherwise returns a negative value.

Garbage collects on all free-lists of all types. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-GarbageCollect

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

Returns the HDF library release number. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-Version

The major version of the library. The minor version of the library. The release number of the library. Returns a non-negative value if successful; otherwise returns a negative value.

Determine whether the HDF5 Library was built with the thread-safety feature enabled. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-IsLibraryThreadsafe

Boolean value indicating whether the library was built with thread-safety enabled. Returns a non-negative value if successful; otherwise returns a negative value.

Initializes the HDF5 library. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-Open

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

Resizes and possibly re-allocates memory that will later be freed internally by the HDF5 Library. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-ResizeMemory

Pointer to a buffer to be resized. May be NULL. New size of the buffer, in bytes. On success, returns pointer to resized or reallocated buffer or returns NULL if size is 0 (zero). Returns NULL on failure.

Sets free-list size limits. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-SetFreeListLimits

The cumulative limit, in bytes, on memory used for all regular free lists. (Default: 1MB) The limit, in bytes, on memory used for each regular free list. (Default: 64KB) The cumulative limit, in bytes, on memory used for all array free lists.(Default: 4MB) The limit, in bytes, on memory used for each array free list. (Default: 256KB) The cumulative limit, in bytes, on memory used for all block free lists and, separately, for all factory free lists. (Default: 16MB) The limit, in bytes, on memory used for each block or factory free list. (Default: 1MB) Returns a non-negative value if successful; otherwise returns a negative value.

Common iteration orders

Unknown order [value = -1].

Increasing order [value = 0].

Decreasing order [value = 1].

No particular order, whatever is fastest [value = 2].

Number of iteration orders [value = 3].

Iteration callback values (Actually, any postive value will cause the iterator to stop and pass back that positive value to the function that called the iterator)

Failure [value = -1].

Success and continue [value = 0].

Success and stop [value = 1].

The types of indices on links in groups/attributes on objects. Primarily used for "[do] [foo] by index" routines and for iterating over links in groups/attributes on objects.

Unknown index type [value = -1].

Index on names [value = 0].

Index on creation order [value = 1].

Number of indices defined [value = 2].

Storage info struct used by H5O_info_t and H5F_info_t

btree and/or list

Maximum length of a link's name (encoded in a 32-bit unsigned integer: 4GB - 1)

Constant to indicate operation occurs on same location

Current version of the class_t struct

Maximum value link value for "built-in" link types

Link ids at or above this value are "user-defined" link types.

Copies a link from one location to another. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Copy

Location identifier of the source link Name of the link to be copied Location identifier specifying the destination of the copy Name to be assigned to the new copy Link creation property list identifier Link access property list identifier Returns a non-negative value if successful; otherwise returns a negative value.

Copies a link from one location to another. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Copy

Creates an external link, a soft link to an object in a different file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateExternal

Name of the target file containing the target object Path within the target file to the target object File or group identifier where the new link is to be created Name of the new link, relative to Link creation property list identifier Link access property list identifier Returns a non-negative value if successful; otherwise returns a negative value. The must be an ASCII string!

Creates an external link, a soft link to an object in a different file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateExternal

Creates a hard link to an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateHard

The file or group identifier for the target object. Name of the target object, which must already exist. The file or group identifier for the new link. The name of the new link. Link creation property list identifier. Link access property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Creates a hard link to an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateHard

Creates a soft link to an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateSoft

Path to the target object, which is not required to exist. The file or group identifier for the new link. The name of the new link. Link creation property list identifier. Link access property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Creates a soft link to an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateSoft

Creates a link of a user-defined type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateUD

Link location identifier Link name User-defined link class User-supplied link information Size of udata buffer Link creation property list identifier Link access property list identifier Returns a non-negative value if successful; otherwise returns a negative value.

Creates a link of a user-defined type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateUD

Removes a link from a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Delete

Identifier of the file or group containing the object. Name of the link to delete. Link access property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Removes a link from a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Delete

Removes the n-th link in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-DeleteByIdx

File or group identifier specifying location of subject group Name of subject group Index or field which determines the order Order within field or index Link for which to retrieve information Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Removes the n-th link in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-DeleteByIdx

Determine whether a link with the specified name exists in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Exists

Identifier of the file or group to query. The name of the link to check. Link access property list identifier. Returns 1 or 0 if successful; otherwise returns a negative value.

Determine whether a link with the specified name exists in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Exists

Identifier of the file or group to query. The name of the link to check. Link access property list identifier. Returns 1 or 0 if successful; otherwise returns a negative value. ASCII strings ONLY!

Returns information about a link. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetInfo

File or group identifier. Name of the link for which information is being sought. Buffer in which link information is returned. Link access property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Returns information about a link. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetInfo

Retrieves metadata for a link in a group, according to the order within a field or index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetInfoByIdx

File or group identifier specifying location of subject group Name of subject group Index or field which determines the order Order within field or index Link for which to retrieve information Buffer in which link value is returned Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves metadata for a link in a group, according to the order within a field or index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetInfoByIdx

File or group identifier specifying location of subject group Name of subject group Index or field which determines the order Order within field or index Link for which to retrieve information Buffer in which link value is returned Link access property list Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Retrieves name of the nth link in a group, according to the order within a specified field or index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetNameByIdx

File or group identifier specifying location of subject group Name of subject group Index or field which determines the order Order within field or index Link for which to retrieve information Buffer in which link value is returned Size in bytes of Link access property list Returns the size of the link name if successful; otherwise returns a negative value.

Retrieves name of the nth link in a group, according to the order within a specified field or index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetNameByIdx

File or group identifier specifying location of subject group Name of subject group Index or field which determines the order Order within field or index Link for which to retrieve information Buffer in which link value is returned Size in bytes of Link access property list Returns the size of the link name if successful; otherwise returns a negative value. ASCII strings ONLY!

Retrieves name of the nth link in a group, according to the order within a specified field or index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetNameByIdx

File or group identifier specifying location of subject group Name of subject group Index or field which determines the order Order within field or index Link for which to retrieve information Buffer in which link value is returned Size in bytes of Link access property list Returns the size of the link name if successful; otherwise returns a negative value. ASCII strings ONLY!

Returns the value of a symbolic link. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetVal

File or group identifier. Link whose value is to be returned. The buffer to hold the returned link value. Maximum number of characters of link value to be returned. List access property list identifier. Returns a non-negative value, with the link value in , if successful. Otherwise returns a negative value.

Returns the value of a symbolic link. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetVal

Retrieves value of the nth link in a group, according to the order within an index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetValByIdx

File or group identifier specifying location of subject group Name of subject group Type of index Order within field or index Link for which to retrieve information Pointer to buffer in which link value is returned Size in bytes of Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves value of the nth link in a group, according to the order within an index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetValByIdx

Determines whether a class of user-defined links is registered. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-IsRegistered

User-defined link class identifier Returns a positive value if the link class has been registered and zero if it is unregistered. Otherwise returns a negative value; this may mean that the identifier is not a valid user-defined class identifier.

Iterates through links in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Iterate

Identifier specifying subject group Type of index which determines the order Order within index Iteration position at which to start Callback function passing data regarding the link to the calling application User-defined pointer to data required by the application for its processing of the link On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero. On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.

Iterates through links in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-IterateByName

File or group identifier specifying location of subject group Name of subject group Type of index which determines the order Order within index Iteration position at which to start Callback function passing data regarding the link to the calling application User-defined pointer to data required by the application for its processing of the link Link access property list Returns a non-negative value if successful; otherwise returns a negative value.

Iterates through links in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-IterateByName

Moves a link within an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Move

Original file or group identifier. Original link name. Destination file or group identifier. New link name. Link creation property list identifier to be associated with the new link. Link access property list identifier to be associated with the new link. Returns a non-negative value if successful; otherwise returns a negative value.

Moves a link within an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Move

Registers a user-defined link class or changes behavior of an existing class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Register

Pointer to a buffer containing the struct describing the user-defined link class Returns a non-negative value if successful; otherwise returns a negative value.

Decodes external link information. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-UnpackELinkVal

Buffer containing external link information Size, in bytes, of the buffer External link flags, packed as a bitmap Returned filename Returned object path, relative to Returns a non-negative value if successful; otherwise returns a negative value.

Unregisters a class of user-defined links. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Unregister

User-defined link class identifier Returns a non-negative value if successful; otherwise returns a negative value.

Recursively visits all links starting from a specified group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Visit

Identifier of the group at which the recursive iteration begins. Type of index Order in which index is traversed Callback function passing data regarding the link to the calling application User-defined pointer to data required by the application for its processing of the link On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero. On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.

Recursively visits all links starting from a specified group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-VisitByName

Identifier of a file or group Name of the group, generally relative to , that will serve as root of the iteration Type of index Order in which index is traversed Callback function passing data regarding the link to the calling application User-defined pointer to data required by the application for its processing of the link Link access property list identifier On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero. On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.

Recursively visits all links starting from a specified group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-VisitByName

Link class types. Values less than 64 are reserved for the HDF5 library's internal use. Values 64 to 255 are for "user-defined" link class types; these types are defined by HDF5 but their behavior can be overridden by users. Users who want to create new classes of links should contact the HDF5 development team at hdfhelp@hdfgroup.org . These values can never change because they appear in HDF5 files.

Invalid link type id [value = -1]

Hard link id [value = 0]

Soft link id [value = 1]

External link id [value = 64]

Maximum link type id [value = 255]

Information struct for link (for H5Lget_info/H5Lget_info_by_idx)

Type of link

Indicate if creation order is valid

Creation order

Character set of link name

Address to which hard link points or size of a soft link or UD link value

Link creation callback

ASCII strings ONLY!

Callback for when the link is moved

ASCII strings ONLY!

Callback for when the link is copied

ASCII strings ONLY!

Callback during link traversal

ASCII strings ONLY!

Callback for when the link is deleted

ASCII strings ONLY!

Callback for querying the link

Returns the size of the buffer needed

Callback for querying the link

Returns the size of the buffer needed ASCII strings ONLY!

User-defined link types

Version number of this struct

Link type ID

Comment for debugging

Callback during link creation

Callback after moving link

Callback after copying link

Callback during link traversal

Callback for link deletion

Callback for queries

Prototype for H5Literate/H5Literate_by_name() operator

Group that serves as root of the iteration Name of link, relative to , being examined at current step of the iteration H5L.info_t struct containing information regarding that link User-defined pointer to data required by the application in processing the link Zero causes the visit iterator to continue, returning zero when all group members have been processed. A positive value causes the visit iterator to immediately return that positive value, indicating short-circuit success. A negative value causes the visit iterator to immediately return that value, indicating failure.

Callback for external link traversal

File names MUST be ASCII strings.

Callback for external link traversal

ASCII strings ONLY!

Define enum for the source of file image callbacks

Define structure to hold file image callbacks

Number of character sets actually defined

num H5T_str_t types actually defined

Maximum length of an opaque tag

Indicate that a string is variable length (null-terminated in C, instead of fixed length)

Creates an array datatype object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-ArrayCreate2

Datatype identifier for the array base datatype. Rank of the array. Size of each array dimension. Returns a valid datatype identifier if successful; otherwise returns a negative value.

Releases a datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Close

Identifier of datatype to release. Returns a non-negative value if successful; otherwise returns a negative value.

Commits a transient datatype, linking it into the file and creating a new named datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Commit2

Location identifier Name given to committed datatype Identifier of datatype to be committed and, upon function’s return, identifier for the committed datatype Link creation property list Datatype creation property list Datatype access property list Returns a non-negative value if successful; otherwise returns a negative value.

Commits a transient datatype, linking it into the file and creating a new named datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Commit2

Commits a transient datatype to a file, creating a new named datatype, but does not link it into the file structure. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-CommitAnon

A file or group identifier specifying the file in which the new named datatype is to be created. A datatype identifier. A datatype creation property list identifier. A datatype access property list identifier.

Determines whether a datatype is a named type or a transient type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Committed

Datatype identifier. When successful, returns a positive value, for TRUE, if the datatype has been committed, or 0 (zero), for FALSE, if the datatype has not been committed. Otherwise returns a negative value.

Check whether the library’s default conversion is hard conversion. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-CompilerConv

Identifier for the source datatype. Identifier for the destination datatype. When successful, returns a positive value, for TRUE, if the datatype has been committed, or 0 (zero), for FALSE, if the datatype has not been committed. Otherwise returns a negative value.

Converts data from one specified datatype to another. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Convert

Identifier for the source datatype. Identifier for the destination datatype. Size of array . Array containing pre- and post-conversion values. Optional background buffer. Dataset transfer property list identifier. Returns a non-negative value if successful; otherwise returns a negative value.

Copies an existing datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Copy

Identifier of datatype to copy. Returns a datatype identifier if successful; otherwise returns a negative value

Creates a new datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Create

Class of datatype to create. Size, in bytes, of the datatype being created Returns datatype identifier if successful; otherwise returns a negative value.

Decode a binary object description of datatype and return a new object handle. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Decode

Buffer for the datatype object to be decoded. Returns an object identifier (non-negative) if successful; otherwise returns a negative value.

Determines whether a datatype contains any datatypes of the given datatype class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-DetectClass

Datatype identifier. Datatype class. Returns TRUE or FALSE if successful; otherwise returns a negative value.

Encode a datatype object description into a binary buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Encode

Creates a new enumeration datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-EnumCreate

Datatype identifier for the base datatype. Must be an integer datatype. Returns the datatype identifier for the new enumeration datatype if successful; otherwise returns a negative value.

Inserts a new enumeration datatype member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-EnumInsert

Datatype identifier for the enumeration datatype. Name of the new member. Pointer to the value of the new member. Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Returns the symbol name corresponding to a specified member of an enumeration datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-EnumNameOf

Enumeration datatype identifier. Value of the enumeration datatype. Buffer for output of the symbol name. The capacity of the buffer, in bytes (characters). Returns a non-negative value if successful. Otherwise returns a negative value. ASCII strings ONLY!

Returns the value corresponding to a specified member of an enumeration datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-EnumValueOf

Enumeration datatype identifier. Symbol name of the enumeration datatype. Buffer for output of the value of the enumeration datatype. Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Determines whether two datatype identifiers refer to the same datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Equal

Identifier of datatype to compare. Identifier of datatype to compare. When successful, returns a positive value, for TRUE, if the datatype has been committed, or 0 (zero), for FALSE, if the datatype has not been committed. Otherwise returns a negative value.

Finds a conversion function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Find

Identifier for the source datatype. Identifier for the destination datatype. Pointer to type conversion data. Returns a pointer to a suitable conversion function if successful. Otherwise returns NULL.

Flushes all buffers associated with a committed datatype to disk. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Tflush.htm

Identifier of the committed datatype to be flushed. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves sizes of array dimensions. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetArrayDims2

Array datatype identifier. Sizes of array dimensions. Returns the non-negative number of dimensions of the array type if successful; otherwise returns a negative value.

Returns the rank of an array datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetArrayNdims

Array datatype identifier. Returns the rank of the array if successful; otherwise returns a negative value.

Returns the datatype class identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetClass

Identifier of datatype to query. Returns datatype class identifier if successful; otherwise H5T_NO_CLASS.

Returns a copy of a datatype creation property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetCreatePlist

Datatype identifier. Returns a datatype property list identifier if successful; otherwise returns a negative value.

Retrieves the character set type of a string datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetCset

Identifier of datatype to query. Returns a valid character set type if successful; otherwise H5T.cset_t.CSET_ERROR.

Retrieves the exponent bias of a floating-point type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetEbias

Identifier of datatype to query. Returns the bias if successful; otherwise 0.

Retrieves floating point datatype bit field information. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetFields

Identifier of datatype to query. Pointer to location to return floating-point sign bit. Pointer to location to return exponent bit-position. Pointer to location to return size of exponent in bits. Pointer to location to return mantissa bit-position. Pointer to location to return size of mantissa in bits. Returns a non-negative value if successful; otherwise returns a negative value.

Retrieves the internal padding type for unused bits in floating-point datatypes. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetInpad

Identifier of datatype to query. Returns a valid padding type if successful; otherwise H5T.pad_t.ERROR.

Returns datatype class of compound datatype member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberClass

Datatype identifier of compound object. Compound type member number. Returns the datatype class, a non-negative value, if successful; otherwise returns a negative value.

Retrieves the index of a compound or enumeration datatype member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberIndex

Identifier of datatype to query. Name of the field or member whose index is to be retrieved. Returns a valid field or member index if successful; otherwise returns a negative value. ASCII strings ONLY!

Retrieves the name of a compound or enumeration datatype member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberName

Identifier of datatype to query. Zero-based index of the field or element whose name is to be retrieved. Returns a pointer to a string allocated in unmanaged memory if successful; otherwise returns NULL. The caller is responsible for freeing the allocated memory.

Retrieves the offset of a field of a compound datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberOffset

Identifier of datatype to query. Number of the field whose offset is requested.

Returns the datatype of the specified member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberType

Identifier of datatype to query. Field index (0-based) of the field type to retrieve. Returns the identifier of a copy of the datatype of the field if successful; otherwise returns a negative value.

Returns the value of an enumeration datatype member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberValue

Datatype identifier for the enumeration datatype. Number of the enumeration datatype member. Pointer to a buffer for output of the value of the enumeration datatype member. Returns a non-negative value if successful; otherwise returns a negative value.

Returns the native datatype of a specified datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetNativeType

Datatype identifier for the dataset datatype. Direction of search. Returns the native datatype identifier for the specified dataset datatype if successful; otherwise returns a negative value.

Retrieves the number of elements in a compound or enumeration datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetNmembers

Identifier of datatype to query. Returns the number of elements if successful; otherwise returns a negative value.

Retrieves mantissa normalization of a floating-point datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetNorm

Identifier of datatype to query. Returns a valid normalization type if successful; otherwise H5T.norm_t.ERROR.

Retrieves the bit offset of the first significant bit. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetOffset

Identifier of datatype to query. Returns an offset value if successful; otherwise returns a negative value.

Returns the byte order of an atomic datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetOrder

Identifier of datatype to query. Returns a byte order constant if successful; otherwise H5T.order_t.ERROR.

Retrieves the padding type of the least and most-significant bit padding. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetPad

Identifier of datatype to query. Pointer to location to return least-significant bit padding type. Pointer to location to return most-significant bit padding type. Returns a non-negative value if successful; otherwise returns a negative value.

Returns the precision of an atomic datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetPrecision

Identifier of datatype to query. Returns the number of significant bits if successful; otherwise 0.

Retrieves the sign type for an integer type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetSign

Identifier of datatype to query. Returns a valid sign type if successful; otherwise H5T.sign_t.ERROR.

Returns the size of a datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetSize

Identifier of datatype to query. Returns the size of the datatype in bytes if successful; otherwise 0.

Retrieves the type of padding used for a string datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetStrpad

Identifier of datatype to query. Returns a valid string storage mechanism if successful; otherwise H5T.str_t.ERROR.

Returns the base datatype from which a datatype is derived. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetSuper

Datatype identifier for the derived datatype. Returns the datatype identifier for the base datatype if successful; otherwise returns a negative value.

Gets the tag associated with an opaque datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetTag

Datatype identifier for the opaque datatype. Returns a pointer to a string allocated in unmanaged memory if successful; otherwise returns NULL. The caller is responsible for freeing the allocated memory.

Adds a new member to a compound datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Insert

Identifier of compound datatype to modify. Name of the field to insert. Offset in memory structure of the field to insert. Datatype identifier of the field to insert. Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Determines whether datatype is a variable-length string. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-IsVariableString

Datatype identifier. Returns TRUE or FALSE if successful; otherwise returns a negative value.

Locks a datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Lock

Identifier of datatype to lock. Returns a non-negative value if successful; otherwise returns a negative value.

Opens a committed (named) datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Open2

A file or group identifier. A datatype name, defined within the file or group identified by . Datatype access property list identifier. Returns a committed datatype identifier if successful; otherwise returns a negative value.

Opens a committed (named) datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Open2

Recursively removes padding from within a compound datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Pack

Identifier of datatype to modify. Returns a non-negative value if successful; otherwise returns a negative value.

Refreshes all buffers associated with a committed datatype. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Trefresh.htm

Identifier of the committed datatype to be refreshed. Returns a non-negative value if successful; otherwise returns a negative value.

Registers a conversion function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Register

Conversion function type Name displayed in diagnostic output Identifier of source datatype Identifier of destination datatype Function to convert between source and destination datatypes Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Sets character set to be used in a string or character datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetCset

Identifier of datatype to modify. Character set type. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the exponent bias of a floating-point type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetEbias

Identifier of datatype to set. Exponent bias value. Returns a non-negative value if successful; otherwise returns a negative value.

Sets locations and sizes of floating point bit fields. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetFields

Identifier of datatype to set. Sign position, i.e., the bit offset of the floating-point sign bit. Exponent bit position. Size of exponent in bits. Mantissa bit position. Size of mantissa in bits. Returns a non-negative value if successful; otherwise returns a negative value.

Sets interal bit padding of floating point numbers. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetInpad

Identifier of datatype to modify. Padding type. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the mantissa normalization of a floating-point datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetNorm

Identifier of datatype to set. Mantissa normalization type. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the bit offset of the first significant bit. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetOffset

Identifier of datatype to set. Offset of first significant bit. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the byte order of a datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetOrder

Identifier of datatype to set. Byte order. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the least and most-significant bits padding types. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetPad

Identifier of datatype to set. Padding type for least-significant bits. Padding type for most-significant bits. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the precision of an atomic datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetPrecision

Identifier of datatype to set. Number of bits of precision for datatype. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the sign property for an integer type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetSign

Identifier of datatype to set. Sign type. Returns a non-negative value if successful; otherwise returns a negative value.

Sets the total size for a datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetSize

Identifier of datatype for which the size is being changed New datatype size in bytes or VARIABLE Returns a non-negative value if successful; otherwise returns a negative value.

Defines the type of padding used for character strings. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetStrpad

Identifier of datatype to modify. String padding type. Returns a non-negative value if successful; otherwise returns a negative value.

Tags an opaque datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetTag

Datatype identifier for the opaque datatype to be tagged. Descriptive ASCII string with which the opaque datatype is to be tagged. Returns a non-negative value if successful; otherwise returns a negative value. is intended to provide a concise description; the maximum size is hard-coded in the HDF5 Library as 256 bytes

Removes a conversion function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Unregister

Conversion function type Name displayed in diagnostic output. Identifier of source datatype. Identifier of destination datatype. Function to convert between source and destination datatypes. Returns a non-negative value if successful; otherwise returns a negative value. ASCII strings ONLY!

Creates a new variable-length array datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-VLCreate

Base type of datatype to create. Returns datatype identifier if successful; otherwise returns a negative value.

These are the various classes of datatypes.

Byte orders

error

little endian

big endian

VAX mixed endian

Compound type with mixed member orders

no particular order (strings, bits,..)

Types of integer sign schemes

error

unsigned

two's complement

Floating-point normalization schemes

error

msb of mantissa isn't stored, always 1

msb of mantissa is always 1

not normalized

Character set to use for text strings.

error [value = -1].

US ASCII [value = 0].

UTF-8 Unicode encoding [value = 1].

Type of padding to use in character strings.

error

null terminate like in C

pad with nulls

pad with spaces like in Fortran

reserved for later use

Type of padding to use in other atomic types

error

always set to zero

always set to one

set to background value

The exception type passed into the conversion callback function

source value is greater than destination's range

source value is less than destination's range

source value loses precision in destination

source value is truncated in destination

source value is positive infinity(floating number)

source value is negative infinity(floating number)

source value is NaN(floating number)

Commands sent to conversion functions

query and/or initialize private data

convert data from source to dest datatype

function is being removed from path

How is the `bkg' buffer used by the conversion function?

background buffer is not needed, send NULL

bkg buffer used as temp storage only

init bkg buf with data before conversion

Type conversion client data

what should the conversion function do?

is the background buffer needed?

recalculate private data

private data

Conversion function persistence

wild card

hard conversion function

soft conversion function

The order to retrieve atomic native datatype

default direction is ascending

in ascending order

in descending order

The return value from conversion callback function conv_except_func_t

abort conversion [value = -1]

callback function failed to handle the exception [value = 0]

callback function handled the exception successfully [value = 1]

Variable Length Datatype struct in memory (This is only used for VL sequences, not VL strings, which are stored in byte[]'s)

Length of VL data (in base type units)

Pointer to VL data

Exception handler. If an exception like overflow happenes during conversion, this function is called if it's registered through H5P.set_type_conv_cb.

Determines whether a filter is available. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5Z.html#Compression-FilterAvail

Filter identifier. Returns a Boolean value if successful; otherwise returns a negative value.

Retrieves information about a filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5Z.html#Compression-GetFilterInfo

Identifier of the filter to query. A bit field encoding the returned filter information Returns a non-negative value on success, a negative value on failure.

Registers new filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5Z.html#Compression-Register

A pointer to a buffer for the struct containing filter-definition information. Returns a non-negative value if successful; otherwise returns a negative value.

Unregisters a filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5Z.html#Compression-Unregister

Identifier of the filter to be unregistered. Returns a non-negative value if successful; otherwise returns a negative value.

Filter IDs

no filter [value = -1]

reserved indefinitely [value = 0]

deflation like gzip ]value = 1]

shuffle the data [value = 2]

fletcher32 checksum of EDC [value = 3]

szip compression [value = 4]

nbit compression [value = 5]

scale+offset compression [value = 6]

filter ids below this value are reserved for library use [value = 256]

maximum filter id [value = 65535]

Special parameters for ScaleOffset filter

Values to decide if EDC is enabled for reading data

error value

Return values for filter callback function

I/O should fail if filter fails.

I/O continues if filter fails.

Filter callback function definition

The filter table maps filter identification numbers to structs that contain a pointers to the filter function and timing statistics.

Version number of the class_t struct

Filter ID number

Does this filter have an encoder?

Does this filter have a decoder?

Comment for debugging

The "can apply" callback for a filter

The "set local" callback for a filter

The actual filter function

Define user-level maximum number of dimensions

Releases and terminates access to a dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-Close

Identifier of dataspace to release. Returns a non-negative value if successful; otherwise returns a negative value.

Creates an exact copy of a dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-Copy

Identifier of dataspace to copy. Returns a dataspace identifier if successful; otherwise returns a negative value.

Creates a new dataspace of a specified type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-Create

Type of dataspace to be created. Returns a dataspace identifier if successful; otherwise returns a negative value.

Creates a new simple dataspace and opens it for access. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-CreateSimple

Number of dimensions of dataspace. Array specifying the size of each dimension. Array specifying the maximum size of each dimension. Returns a dataspace identifier if successful; otherwise returns a negative value.

Creates a new simple dataspace and opens it for access. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-CreateSimple

Decode a binary object description of data space and return a new object handle. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-Decode

Buffer for the data space object to be decoded. Returns an object ID(non-negative) if successful; otherwise returns a negative value.

Encode a data space object description into a binary buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-Encode

Identifier of the object to be encoded. Buffer for the object to be encoded into. If the provided buffer is NULL, only the size of buffer needed is returned through . The size of the allocated buffer or the size of the buffer needed. Returns a non-negative value if successful; otherwise returns a negative value.

Copies the extent of a dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-ExtentCopy

The identifier for the dataspace to which the extent is copied. The identifier for the dataspace from which the extent is copied. Returns a non-negative value if successful; otherwise returns a negative value.

Determines whether two dataspace extents are equal. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-ExtentEqual

First dataspace identifier. Second dataspace identifier. Returns 1 if equal, 0 if unequal, if successful; otherwise returns a negative value.

Retrieves a regular hyperslab selection. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Sget_regular_hyperslab.htm

The identifier of the dataspace. Offset of the start of the regular hyperslab. Stride of the regular hyperslab. Number of blocks in the regular hyperslab. Size of a block in the regular hyperslab. Returns a non-negative value if successful; otherwise returns a negative value. If a hyperslab selection is originally regular, then becomes irregular through selection operations, and then becomes regular again, the final regular selection may be equivalent but not identical to the original regular selection.

Gets the bounding box containing the current selection. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectBounds

Identifier of dataspace to query. Starting coordinates of the bounding box. Ending coordinates of the bounding box, i.e., the coordinates of the diagonally opposite corner. Returns a non-negative value if successful; otherwise returns a negative value. The start and end buffers must be large enough to hold the dataspace rank number of coordinates.

Gets the number of points in the current point selection. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectElemNPoints

Identifier of dataspace to query. Returns the number of points in the current dataspace point selection if successful. Otherwise returns a negative value.

Gets the list of points in a point selection. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectElemPointList

Dataspace identifier of selection to query. Element point to start with. Number of element points to get. List of element points selected. Returns a non-negative value if successful; otherwise returns a negative value.

Gets the list of hyperslab blocks in a hyperslab selection. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectHyperBlockList

Dataspace identifier of selection to query. Hyperslab block to start with. Number of hyperslab blocks to get. List of hyperslab blocks selected.

Get number of hyperslab blocks in a hyperslab selection. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectHyperNBlocks

Identifier of dataspace to query. Returns the number of hyperslab blocks in a hyperslab selection if successful. Otherwise returns a negative value.

Determines the number of elements in a dataspace selection. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectNpoints

Dataspace identifier. Returns the number of elements in the selection if successful; otherwise returns a negative value.

Determines the type of the dataspace selection. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-GetSelectType

Dataspace identifier. Returns the dataspace selection type, a value of the enumerated datatype H5S.sel_type, if successful. Otherwise returns a negative value.

Retrieves dataspace dimension size and maximum size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-ExtentDims

Identifier of the dataspace object to query Pointer to array to store the size of each dimension. Pointer to array to store the maximum size of each dimension. Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. Either or both of and may be NULL.

Retrieves dataspace dimension size and maximum size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-ExtentDims

Determines the dimensionality of a dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-ExtentNdims

Identifier of the dataspace Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value.

Determines the number of elements in a dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-ExtentNpoints

Identifier of the dataspace object to query Returns the number of elements in the dataspace if successful; otherwise returns a negative value.

Determines the current class of a dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-ExtentType

Dataspace identifier. Returns a dataspace class name if successful; otherwise H5S.class_t.NO_CLASS.

Determines whether a hyperslab selection is regular. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Sis_regular_hyperslab.htm

The identifier of the dataspace. Returns TRUE or FALSE for hyperslab selection if successful. Returns FAILon error or when querying other selection types such as point selection.

Determines whether a dataspace is a simple dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-IsSimple

Identifier of the dataspace to query When successful, returns a positive value, for TRUE, or 0 (zero), for FALSE. Otherwise returns a negative value.

Sets the offset of a simple dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-OffsetSimple

The identifier for the dataspace object to reset. The offset at which to position the selection. Returns a non-negative value if successful; otherwise returns a negative value. The offset array must be the same number of elements as the number of dimensions for the dataspace. If the offset array is set to NULL, the offset for the dataspace is reset to 0.

Selects an entire dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectAll

The identifier for the dataspace for which the selection is being made. Returns a non-negative value if successful; otherwise returns a negative value.

Selects array elements to be included in the selection for a dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectElements

Identifier of the dataspace. Operator specifying how the new selection is to be combined with the existing selection for the dataspace. Number of elements to be selected. A pointer to a buffer containing a serialized copy of a 2-dimensional array of zero-based values specifying the coordinates of the elements in the point selection. Returns a non-negative value if successful; otherwise returns a negative value.

Selects a hyperslab region to add to the current selected region. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectHyperslab

Identifier of dataspace selection to modify Operation to perform on current selection. Offset of start of hyperslab Number of blocks included in hyperslab. Hyperslab stride. Size of block in hyperslab. Returns a non-negative value if successful; otherwise returns a negative value.

Selects a hyperslab region to add to the current selected region. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectHyperslab

Resets the selection region to include no elements. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectNone

The identifier for the dataspace in which the selection is being reset. Returns a non-negative value if successful; otherwise returns a negative value.

Verifies that the selection is within the extent of the dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectValid

Identifier for the dataspace being queried. Returns a positive value, for TRUE, if the selection is contained within the extent or 0 (zero), for FALSE, if it is not. Returns a negative value on error conditions such as the selection or extent not being defined.

Removes the extent from a dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SetExtentNone

The identifier for the dataspace from which the extent is to be removed. Returns a non-negative value if successful; otherwise returns a negative value.

Sets or resets the size of an existing dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SetExtentSimple

Dataspace identifier. Rank, or dimensionality, of the dataspace. Array containing current size of dataspace. Array containing maximum size of dataspace. Returns a non-negative value if successful; otherwise returns a negative value.

Different types of dataspaces

error [value = -1].

scalar variable [value = 0].

simple data space [value = 1].

null data space [value = 2].

Different ways of combining selections

error

Select "set" operation

Binary "or" operation for hyperslabs (add new selection to existing selection) Original region: AAAAAAAAAA New region: BBBBBBBBBB A or B: CCCCCCCCCCCCCCCC

Binary "and" operation for hyperslabs (only leave overlapped regions in selection) Original region: AAAAAAAAAA New region: BBBBBBBBBB A and B: CCCC

Binary "xor" operation for hyperslabs (only leave non-overlapped regions in selection) Original region: AAAAAAAAAA New region: BBBBBBBBBB A xor B: CCCCCC CCCCCC

Binary "not" operation for hyperslabs (only leave non-overlapped regions in original selection) Original region: AAAAAAAAAA New region: BBBBBBBBBB A not B: CCCCCC

Binary "not" operation for hyperslabs (only leave non-overlapped regions in new selection) Original region: AAAAAAAAAA New region: BBBBBBBBBB B not A: CCCCCC

Append elements to end of point selection

Prepend elements to beginning of point selection

Invalid upper bound on selection operations

Enumerated type for the type of selection

Error

Nothing selected

Sequence of points selected

"New-style" hyperslab selection defined

Entire extent selected