ALIASES += THG="The HDF Group" ################################################################################ # Styling ################################################################################ ALIASES += Bold{1}="\1" ALIASES += Emph{1}="\1" ALIASES += Code{1}="\1" ################################################################################ # Return values ################################################################################ ALIASES += success{1}="\Bold{Success:} \1" ALIASES += failure{1}="\Bold{Failure:} \1" ALIASES += herr_t="Returns a non-negative value if successful; otherwise returns a negative value." ALIASES += hid_t{1}="Returns a \1 identifier if successful; otherwise returns #H5I_INVALID_HID. " ALIASES += hid_ti{1}="Returns an \1 identifier if successful; otherwise returns #H5I_INVALID_HID. " ALIASES += hid_tv{1}="Returns an \1 identifier if successful; otherwise returns a negative value. " ALIASES += htri_t="Returns zero (false), a positive (true) or a negative (failure) value." ################################################################################ # General ################################################################################ ALIASES += idx_type="\param[in] idx_type Index type" ALIASES += idx_type{1}="\param[in] \1 Index type" ALIASES += order="\param[in] order Iteration order" ALIASES += order{1}="\param[in] \1 Iteration order" ALIASES += op="\param[in] op Callback function" ALIASES += op{1}="\param[in] \1 Callback function" ALIASES += op_data="\param[in,out] op_data User-defined callback function context" ALIASES += op_data{1}="\param[in,out] \1 User-defined callback function context" ALIASES += op_data_in="\param[in] op_data User-defined callback function context" ALIASES += op_data_in{1}="\param[in] \1 User-defined callback function context" ################################################################################ # Attributes ################################################################################ ALIASES += attr_id="\param[in] attr_id Attribute identifier" ALIASES += attr_id{1}="\param[in] \1 Attribute identifier" ################################################################################ # Dataset ################################################################################ ALIASES += dset_id="\param[in] dset_id Dataset identifier" ALIASES += dset_id{1}="\param[in] \1 Dataset identifier" ################################################################################ # Dataspaces ################################################################################ ALIASES += space_id="\param[in] space_id Dataspace identifier" ALIASES += space_id{1}="\param[in] \1 Dataspace identifier" ################################################################################ # Dataypes ################################################################################ ALIASES += type_id="\param[in] type_id Datatype identifier" ALIASES += type_id{1}="\param[in] \1 Datatype identifier" ALIASES += file_type_id{1}="\param[in] \1 Datatype (in-file) identifier" ALIASES += mem_type_id{1}="\param[in] \1 Datatype (in-memory) identifier" ################################################################################ # Errors ################################################################################ ALIASES += estack_id="\param[in] estack_id Error stack identifier" ALIASES += estack_id{1}="\param[in] \1 Error stack identifier" ################################################################################ # Files ################################################################################ ALIASES += file_id="\param[in] file_id File identifier" ALIASES += file_id{1}="\param[in] \1 File identifier" ALIASES += fapl_id="\param[in] fapl_id File access property list identifier" ALIASES += fapl_id{1}="\param[in] \1 File access property list identifier" ALIASES += fcpl_id="\param[in] fcpl_id File creation property list identifier" ALIASES += fcpl_id{1}="\param[in] \1 File creation property list identifier" ################################################################################ # Groups ################################################################################ ALIASES += group_id="\param[in] group_id Group identifier" ALIASES += group_id{1}="\param[in] \1 Group identifier" ################################################################################ # Locations ################################################################################ ALIASES += loc_id="\param[in] loc_id Location identifier" ALIASES += loc_id{1}="\param[in] \1 Location identifier" ALIASES += fgdt_loc_id="\loc_id. The identifier may be that of a file, group, dataset, or named datatype." ALIASES += fgdt_loc_id{1}="\loc_id{\1}. The identifier may be that of a file, group, dataset, or named datatype." ALIASES += fgdta_loc_id="\loc_id. The identifier may be that of a file, group, dataset, named datatype, or attribute." ALIASES += fgdta_loc_id{1}="\loc_id{\1}. The identifier may be that of a file, group, dataset, named datatype, or attribute." ALIASES += fg_loc_id="\loc_id. The identifier may be that of a file or group." ALIASES += fg_loc_id{1}="\loc_id{\1}. The identifier may be that of a file or group." ################################################################################ # Property lists ################################################################################ ALIASES += aapl_id="\param[in] aapl_id Attribute access property list identifier" ALIASES += aapl_id{1}="\param[in] \1 Attribute access property list identifier" ALIASES += acpl_id="\param[in] acpl_id Attribute creation property list identifier" ALIASES += acpl_id{1}="\param[in] \1 Attribute creation property list identifier" ALIASES += dapl_id="\param[in] dapl_id Dataset access property list identifier" ALIASES += dapl_id{1}="\param[in] \1 Dataset access property list identifier" ALIASES += dcpl_id="\param[in] dcpl_id Dataset creation property list identifier" ALIASES += dcpl_id{1}="\param[in] \1 Dataset creation property list identifier" ALIASES += dxpl_id="\param[in] dxpl_id Dataset transfer property list identifier" ALIASES += dxpl_id{1}="\param[in] \1 Dataset transfer property list identifier" ALIASES += gapl_id="\param[in] gapl_id Group access property list identifier" ALIASES += gapl_id{1}="\param[in] \1 Group access property list identifier" ALIASES += gcpl_id="\param[in] gcpl_id Group creation property list identifier" ALIASES += gcpl_id{1}="\param[in] \1 Group creation property list identifier" ALIASES += lapl_id="\param[in] lapl_id Link access property list identifier" ALIASES += lapl_id{1}="\param[in] \1 Link access property list identifier" ALIASES += lcpl_id="\param[in] lcpl_id Link creation property list identifier" ALIASES += lcpl_id{1}="\param[in] \1 Link creation property list identifier" ALIASES += vipl_id="\param[in] vipl_id VOL initialization property list identifier" ALIASES += vipl_id{1}="\param[in] \1 vipl_id VOL initialization property list identifier" ALIASES += plist_id="\param[in] plist_id Property list identifier" ALIASES += plist_id{1}="\param[in] \1 Property list identifier" ALIASES += plistcls_id="\param[in] plistcls_id Property list class identifier" ALIASES += plistcls_id{1}="\param[in] \1 Property list class identifier" ################################################################################ # Objects ################################################################################ ALIASES += obj_id="\param[in] obj_id Object identifier" ALIASES += obj_id{1}="\param[in] \1 Object identifier" ALIASES += loc_obj_id{1}="\param[in] \1 Location identifier of object" ALIASES += fgdta_obj_id="\obj_id. The identifier may be that of a file, group, dataset, named datatype, or attribute." ALIASES += fgdta_obj_id{1}="\obj_id{\1}. The identifier may be that of a file, group, dataset, named datatype, or attribute." ALIASES += fgdta_loc_obj_id{1}="\loc_obj_id{\1}. The identifier may be that of a file, group, dataset, named datatype, or attribute." ################################################################################ # Others ################################################################################ ALIASES += estack_id="\param[in] estack_id Error stack identifier" ALIASES += estack_id{1}="\param[in] \1 Error stack identifier" ALIASES += cpp_c_api_note="\attention \Bold{C++ Developers using HDF5 C-API functions beware:}\n Several functions in this C-API take function pointers or callbacks as arguments. Examples include H5Pset_elink_cb(), H5Pset_type_conv_cb(), H5Tconvert(), and H5Ewalk2(). Application code must ensure that those callback functions return normally such to allow the HDF5 to manage its resources and maintain a consistent state. For instance, those functions must not use the C \c setjmp / \c longjmp mechanism to leave those callback functions. Within the context of C++, any exceptions thrown within the callback function must be caught, such as with a \Code{catch(…)} statement. Any exception state can be placed within the provided user data function call arguments, and may be thrown again once the calling function has returned. Exceptions raised and not handled inside the callback are not supported as it might leave the HDF5 library in an inconsistent state. Similarly, using C++20 coroutines cannot be used as callbacks, since they do not support plain return statements. If a callback function yields execution to another C++20 coroutine calling HDF5 functions as well, this may lead to undefined behavior." ALIASES += sa_metadata_ops="\sa \li H5Pget_all_coll_metadata_ops() \li H5Pget_coll_metadata_write() \li H5Pset_all_coll_metadata_ops() \li H5Pset_coll_metadata_write() \li \ref maybe_metadata_reads" ################################################################################ # References ################################################################################ ALIASES += ref_cons_semantics="Enabling a Strict Consistency Semantics Model in Parallel HDF5" ALIASES += ref_dld_filters="HDF5 Dynamically Loaded Filters" ALIASES += ref_file_image_ops="HDF5 File Image Operations" ALIASES += ref_filter_pipe="Data Flow Pipeline for H5Dread()" ALIASES += ref_group_impls="Group implementations in HDF5" ALIASES += ref_h5lib_relver="HDF5 Library Release Version Numbers" ALIASES += ref_mdc_in_hdf5="Metadata Caching in HDF5" ALIASES += ref_mdc_logging="Metadata Cache Logging" ALIASES += ref_news_110="New Features in HDF5 Release 1.10" ALIASES += ref_h5ocopy="Copying Committed Datatypes with H5Ocopy()" ALIASES += ref_sencode_fmt_change="RFC H5Secnode() / H5Sdecode() Format Change" ALIASES += ref_vlen_strings="\Emph{Creating variable-length string datatypes}" ALIASES += ref_vol_doc="VOL documentation" ################################################################################ # The Usual Suspects ################################################################################ ALIASES += click4more="(Click on a enumerator, field, or type for more information.)" ALIASES += csets="
#H5T_CSET_ASCIIUS ASCII
#H5T_CSET_UTF8UTF-8 Unicode encoding
" ALIASES += datatype_class=" \li #H5T_INTEGER \li #H5T_FLOAT \li #H5T_STRING \li #H5T_BITFIELD \li #H5T_OPAQUE \li #H5T_COMPOUND \li #H5T_REFERENCE \li #H5T_ENUM \li #H5T_VLEN \li #H5T_ARRAY" ALIASES += file_access="
#H5F_ACC_RDWRFile was opened with read/write access.
#H5F_ACC_RDONLYFile was opened with read-only access.
#H5F_ACC_SWMR_WRITEFile was opened with read/write access for a single-writer/multiple-reader (SWMR) scenario. Note that the writer process must also open the file with the #H5F_ACC_RDWR flag.
#H5F_ACC_SWMR_READFile was opened with read-only access for a single-writer/multiple-reader (SWMR) scenario. Note that the reader process must also open the file with the #H5F_ACC_RDONLY flag.
" ALIASES += id_types="
#H5I_FILEFile
#H5I_GROUPGroup
#H5I_DATATYPEDatatype
#H5I_DATASPACEDataspace
#H5I_DATASETDataset
#H5I_ATTRAttribute
" ALIASES += indexes="
#H5_INDEX_NAMELexicographic order on name
#H5_INDEX_CRT_ORDERIndex on creation order
" ALIASES += link_types="
#H5L_TYPE_HARDHard link
#H5L_TYPE_SOFTSoft link
#H5L_TYPE_EXTERNALExternal link
#H5L_TYPE_ERRORError
" ALIASES += mem_types="
#H5FD_MEM_DEFAULTThe default file memory allocation type
#H5FD_MEM_SUPERFile memory allocated for Superblock
#H5FD_MEM_BTREEFile memory allocated for B-tree
#H5FD_MEM_DRAWFile memory allocated for raw data
#H5FD_MEM_GHEAPFile memory allocated for Global Heap
#H5FD_MEM_LHEAPFile memory allocated for Local Heap
#H5FD_MEM_OHDRFile memory allocated for Object Header
" ALIASES += norm_type="
#H5T_NORM_IMPLIED0MSB of mantissa is not stored, always 1
#H5T_NORM_MSBSET1MSB of mantissa is always 1
#H5T_NORM_NONE2Mantissa is not normalized
" ALIASES += obj_types="
#H5F_OBJ_FILEFiles only
#H5F_OBJ_DATASETDatasets only
#H5F_OBJ_GROUPGroups only
#H5F_OBJ_DATATYPENamed datatypes only
#H5F_OBJ_ATTRAttributes only
#H5F_OBJ_ALLAll of the above
#H5F_OBJ_LOCALRestrict search to objects opened through current file identifier.
\attention #H5F_OBJ_LOCAL does not stand alone; it is effective only when used in combination with one or more of the preceding types. For example, #H5F_OBJ_DATASET | #H5F_OBJ_GROUP | #H5F_OBJ_LOCAL would count all datasets and groups opened through the current file identifier." ALIASES += orders="
#H5_ITER_INCIncreasing order
#H5_ITER_DECDecreasing order
#H5_ITER_NATIVEFastest available order
" ALIASES += padding_type="
#H5T_PAD_ZERO0Set background to zeros
#H5T_PAD_ONE1Set background to ones
#H5T_PAD_BACKGROUND2Leave background alone
" ALIASES += scopes="
#H5F_SCOPE_GLOBALFlushes the entire virtual file
#H5F_SCOPE_LOCALFlushes only the specified file
" ALIASES += sign_prop="
#H5T_SGN_NONE0Unsigned integer type
#H5T_SGN_21Two's complement signed integer type
" ALIASES += storage_type="
#H5G_STORAGE_TYPE_COMPACTCompact storage
#H5G_STORAGE_TYPE_DENSEIndexed storage
#H5G_STORAGE_TYPE_SYMBOL_TABLESymbol tables, the original HDF5 structure
" ALIASES += str_pad_type="
#H5T_STR_NULLTERM0Null terminate (as C does)
#H5T_STR_NULLPAD1Pad with zeros
#H5T_STR_SPACEPAD2Pad with spaces (as FORTRAN does)
" ALIASES += see_virtual=" \see Supporting Functions: H5Pget_layout(), H5Pset_layout(), H5Sget_regular_hyperslab(), H5Sis_regular_hyperslab(), H5Sselect_hyperslab() \see VDS Functions: H5Pget_virtual_count(), H5Pget_virtual_dsetname(), H5Pget_virtual_filename(), H5Pget_virtual_prefix(), H5Pget_virtual_printf_gap(), H5Pget_virtual_srcspace(), H5Pget_virtual_view(), H5Pget_virtual_vspace(), H5Pset_virtual(), H5Pset_virtual_prefix(), H5Pset_virtual_printf_gap(), H5Pset_virtual_view()" ALIASES += obj_info_fields="
FlagPurpose
#H5O_INFO_BASICFill in the fileno, addr, type, and rc fields
#H5O_INFO_TIMEFill in the atime, mtime, ctime, and btime fields
#H5O_INFO_NUM_ATTRS Fill in the num_attrs field
#H5O_INFO_HDRFill in the num_attrs field
#H5O_INFO_META_SIZEFill in the meta_size field
#H5O_INFO_ALL#H5O_INFO_BASIC | #H5O_INFO_TIME | #H5O_INFO_NUM_ATTRS | #H5O_INFO_HDR | #H5O_INFO_META_SIZE
"