From 03ad911d3df0d611877e07a1d0d6d52758c26bbb Mon Sep 17 00:00:00 2001 From: Scot Breitenfeld Date: Tue, 14 Jul 2015 16:26:27 -0500 Subject: [svn-r27388] Removed robodoc documenation. --- MANIFEST | 83 - fortran/doc/DevelGuide/masterindex.html | 589 --- fortran/doc/DevelGuide/robo_functions.html | 39 - fortran/doc/DevelGuide/robo_modules.html | 117 - fortran/doc/DevelGuide/robo_programs.html | 39 - fortran/doc/DevelGuide/robo_sourcefiles.html | 309 -- fortran/doc/DevelGuide/robo_subroutines.html | 421 -- fortran/doc/DevelGuide/robodoc.css | 302 -- fortran/doc/DevelGuide/src/H5Af_c.html | 41 - fortran/doc/DevelGuide/src/H5Aff_F03_f90.html | 130 - fortran/doc/DevelGuide/src/H5Aff_F90_f90.html | 56 - fortran/doc/DevelGuide/src/H5Aff_f90.html | 1102 ----- fortran/doc/DevelGuide/src/H5Df_c.html | 41 - fortran/doc/DevelGuide/src/H5Dff_F03_f90.html | 138 - fortran/doc/DevelGuide/src/H5Dff_F90_f90.html | 116 - fortran/doc/DevelGuide/src/H5Dff_f90.html | 506 --- fortran/doc/DevelGuide/src/H5Ef_c.html | 41 - fortran/doc/DevelGuide/src/H5Eff_f90.html | 197 - fortran/doc/DevelGuide/src/H5FDmpiof_c.html | 41 - fortran/doc/DevelGuide/src/H5FDmpioff_f90.html | 253 -- fortran/doc/DevelGuide/src/H5Ff_c.html | 41 - fortran/doc/DevelGuide/src/H5Fff_f90.html | 653 --- fortran/doc/DevelGuide/src/H5Gf_c.html | 41 - fortran/doc/DevelGuide/src/H5Gff_f90.html | 840 ---- fortran/doc/DevelGuide/src/H5If_c.html | 41 - fortran/doc/DevelGuide/src/H5Iff_f90.html | 304 -- fortran/doc/DevelGuide/src/H5Lf_c.html | 41 - fortran/doc/DevelGuide/src/H5Lff_F03_f90.html | 181 - fortran/doc/DevelGuide/src/H5Lff_F90_f90.html | 50 - fortran/doc/DevelGuide/src/H5Lff_f90.html | 637 --- fortran/doc/DevelGuide/src/H5Of_c.html | 41 - fortran/doc/DevelGuide/src/H5Off_f90.html | 198 - fortran/doc/DevelGuide/src/H5Pf_c.html | 41 - fortran/doc/DevelGuide/src/H5Pff_F03_f90.html | 832 ---- fortran/doc/DevelGuide/src/H5Pff_F90_f90.html | 715 --- fortran/doc/DevelGuide/src/H5Pff_f90.html | 4752 -------------------- fortran/doc/DevelGuide/src/H5Rf_c.html | 41 - fortran/doc/DevelGuide/src/H5Rff_F03_f90.html | 492 -- fortran/doc/DevelGuide/src/H5Rff_F90_f90.html | 305 -- fortran/doc/DevelGuide/src/H5Rff_f90.html | 148 - fortran/doc/DevelGuide/src/H5Sf_c.html | 41 - fortran/doc/DevelGuide/src/H5Sff_f90.html | 1165 ----- fortran/doc/DevelGuide/src/H5Tf_c.html | 41 - fortran/doc/DevelGuide/src/H5Tff_f90.html | 2378 ---------- fortran/doc/DevelGuide/src/H5Zf_c.html | 41 - fortran/doc/DevelGuide/src/H5Zff_f90.html | 173 - .../src/H5_DBLE_InterfaceExclude_f90.html | 53 - .../src/H5_DBLE_InterfaceInclude_f90.html | 54 - fortran/doc/DevelGuide/src/H5_f_c.html | 41 - fortran/doc/DevelGuide/src/H5_ff_F03_f90.html | 83 - fortran/doc/DevelGuide/src/H5_ff_F90_f90.html | 48 - fortran/doc/DevelGuide/src/H5_ff_f90.html | 269 -- fortran/doc/DevelGuide/src/H5f90global_f90.html | 61 - fortran/doc/DevelGuide/src/H5f90kit_c.html | 44 - fortran/doc/DevelGuide/src/H5match_types_c.html | 49 - .../doc/DevelGuide/src/H5test_kind_SIZEOF_f90.html | 61 - fortran/doc/DevelGuide/src/H5test_kind_f90.html | 62 - fortran/doc/DevelGuide/src/HDF5_f90.html | 47 - fortran/doc/DevelGuide/src/HDF5mpio_f90.html | 45 - fortran/doc/DevelGuide/test/fflush1_f90.html | 47 - fortran/doc/DevelGuide/test/fflush2_f90.html | 47 - .../DevelGuide/test/fortranlib_test_1_8_f90.html | 44 - .../DevelGuide/test/fortranlib_test_F03_f90.html | 45 - .../doc/DevelGuide/test/fortranlib_test_f90.html | 44 - fortran/doc/DevelGuide/test/tF2003_f90.html | 53 - fortran/doc/DevelGuide/test/tH5A_1_8_f90.html | 51 - fortran/doc/DevelGuide/test/tH5A_f90.html | 47 - fortran/doc/DevelGuide/test/tH5D_f90.html | 52 - fortran/doc/DevelGuide/test/tH5E_f90.html | 51 - fortran/doc/DevelGuide/test/tH5F_f90.html | 47 - fortran/doc/DevelGuide/test/tH5G_1_8_f90.html | 49 - fortran/doc/DevelGuide/test/tH5G_f90.html | 47 - fortran/doc/DevelGuide/test/tH5I_f90.html | 47 - fortran/doc/DevelGuide/test/tH5O_f90.html | 47 - fortran/doc/DevelGuide/test/tH5P_f90.html | 47 - fortran/doc/DevelGuide/test/tH5R_f90.html | 51 - fortran/doc/DevelGuide/test/tH5S_f90.html | 54 - fortran/doc/DevelGuide/test/tH5Sselect_f90.html | 56 - fortran/doc/DevelGuide/test/tH5T_f90.html | 47 - fortran/doc/DevelGuide/test/tH5VL_f90.html | 47 - fortran/doc/DevelGuide/test/tH5Z_f90.html | 47 - fortran/doc/DevelGuide/test/t_c.html | 44 - fortran/doc/DevelGuide/test/tf_f90.html | 48 - fortran/doc/DevelGuide/toc_index.html | 552 --- 84 files changed, 21422 deletions(-) delete mode 100644 fortran/doc/DevelGuide/masterindex.html delete mode 100644 fortran/doc/DevelGuide/robo_functions.html delete mode 100644 fortran/doc/DevelGuide/robo_modules.html delete mode 100644 fortran/doc/DevelGuide/robo_programs.html delete mode 100644 fortran/doc/DevelGuide/robo_sourcefiles.html delete mode 100644 fortran/doc/DevelGuide/robo_subroutines.html delete mode 100644 fortran/doc/DevelGuide/robodoc.css delete mode 100644 fortran/doc/DevelGuide/src/H5Af_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Aff_F03_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Aff_F90_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Aff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Df_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Dff_F03_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Dff_F90_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Dff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Ef_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Eff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5FDmpiof_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5FDmpioff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Ff_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Fff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Gf_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Gff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5If_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Iff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Lf_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Lff_F03_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Lff_F90_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Lff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Of_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Off_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Pf_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Pff_F03_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Pff_F90_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Pff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Rf_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Rff_F03_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Rff_F90_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Rff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Sf_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Sff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Tf_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Tff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5Zf_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5Zff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5_DBLE_InterfaceExclude_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5_DBLE_InterfaceInclude_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5_f_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5_ff_F03_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5_ff_F90_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5_ff_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5f90global_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5f90kit_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5match_types_c.html delete mode 100644 fortran/doc/DevelGuide/src/H5test_kind_SIZEOF_f90.html delete mode 100644 fortran/doc/DevelGuide/src/H5test_kind_f90.html delete mode 100644 fortran/doc/DevelGuide/src/HDF5_f90.html delete mode 100644 fortran/doc/DevelGuide/src/HDF5mpio_f90.html delete mode 100644 fortran/doc/DevelGuide/test/fflush1_f90.html delete mode 100644 fortran/doc/DevelGuide/test/fflush2_f90.html delete mode 100644 fortran/doc/DevelGuide/test/fortranlib_test_1_8_f90.html delete mode 100644 fortran/doc/DevelGuide/test/fortranlib_test_F03_f90.html delete mode 100644 fortran/doc/DevelGuide/test/fortranlib_test_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tF2003_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5A_1_8_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5A_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5D_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5E_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5F_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5G_1_8_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5G_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5I_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5O_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5P_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5R_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5S_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5Sselect_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5T_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5VL_f90.html delete mode 100644 fortran/doc/DevelGuide/test/tH5Z_f90.html delete mode 100644 fortran/doc/DevelGuide/test/t_c.html delete mode 100644 fortran/doc/DevelGuide/test/tf_f90.html delete mode 100644 fortran/doc/DevelGuide/toc_index.html diff --git a/MANIFEST b/MANIFEST index 0bd9aef..58a9137 100644 --- a/MANIFEST +++ b/MANIFEST @@ -162,89 +162,6 @@ ./fortran/Makefile.in ./fortran/robodoc.rc -./fortran/doc/DevelGuide/toc_index.html -./fortran/doc/DevelGuide/masterindex.html -./fortran/doc/DevelGuide/robo_subroutines.html -./fortran/doc/DevelGuide/robo_sourcefiles.html -./fortran/doc/DevelGuide/robo_functions.html -./fortran/doc/DevelGuide/robo_modules.html -./fortran/doc/DevelGuide/robo_programs.html -./fortran/doc/DevelGuide/robodoc.css -./fortran/doc/DevelGuide/test/fortranlib_test_f90.html -./fortran/doc/DevelGuide/test/tH5A_f90.html -./fortran/doc/DevelGuide/test/tH5VL_f90.html -./fortran/doc/DevelGuide/test/tH5D_f90.html -./fortran/doc/DevelGuide/test/tH5E_f90.html -./fortran/doc/DevelGuide/test/tH5F_f90.html -./fortran/doc/DevelGuide/test/tH5G_f90.html -./fortran/doc/DevelGuide/test/fflush1_f90.html -./fortran/doc/DevelGuide/test/fortranlib_test_1_8_f90.html -./fortran/doc/DevelGuide/test/tH5A_1_8_f90.html -./fortran/doc/DevelGuide/test/tf_f90.html -./fortran/doc/DevelGuide/test/fflush2_f90.html -./fortran/doc/DevelGuide/test/fortranlib_test_F03_f90.html -./fortran/doc/DevelGuide/test/tH5I_f90.html -./fortran/doc/DevelGuide/test/tH5G_1_8_f90.html -./fortran/doc/DevelGuide/test/tF2003_f90.html -./fortran/doc/DevelGuide/test/tH5O_f90.html -./fortran/doc/DevelGuide/test/tH5P_f90.html -./fortran/doc/DevelGuide/test/tH5R_f90.html -./fortran/doc/DevelGuide/test/tH5S_f90.html -./fortran/doc/DevelGuide/test/tH5Sselect_f90.html -./fortran/doc/DevelGuide/test/tH5T_f90.html -./fortran/doc/DevelGuide/test/t_c.html -./fortran/doc/DevelGuide/test/tH5Z_f90.html -./fortran/doc/DevelGuide/src/H5Fff_f90.html -./fortran/doc/DevelGuide/src/H5Zf_c.html -./fortran/doc/DevelGuide/src/H5Pff_F90_f90.html -./fortran/doc/DevelGuide/src/H5Aff_F03_f90.html -./fortran/doc/DevelGuide/src/H5match_types_c.html -./fortran/doc/DevelGuide/src/H5Rff_F90_f90.html -./fortran/doc/DevelGuide/src/H5Lff_f90.html -./fortran/doc/DevelGuide/src/H5FDmpiof_c.html -./fortran/doc/DevelGuide/src/H5_f_c.html -./fortran/doc/DevelGuide/src/H5Pff_f90.html -./fortran/doc/DevelGuide/src/H5Rff_f90.html -./fortran/doc/DevelGuide/src/H5Tff_f90.html -./fortran/doc/DevelGuide/src/H5test_kind_f90.html -./fortran/doc/DevelGuide/src/H5Aff_F90_f90.html -./fortran/doc/DevelGuide/src/H5Zff_f90.html -./fortran/doc/DevelGuide/src/HDF5_f90.html -./fortran/doc/DevelGuide/src/H5_DBLE_InterfaceInclude_f90.html -./fortran/doc/DevelGuide/src/H5f90kit_c.html -./fortran/doc/DevelGuide/src/H5Aff_f90.html -./fortran/doc/DevelGuide/src/H5_DBLE_InterfaceExclude_f90.html -./fortran/doc/DevelGuide/src/H5Eff_f90.html -./fortran/doc/DevelGuide/src/H5_ff_F03_f90.html -./fortran/doc/DevelGuide/src/H5Gff_f90.html -./fortran/doc/DevelGuide/src/H5test_kind_SIZEOF_f90.html -./fortran/doc/DevelGuide/src/H5Iff_f90.html -./fortran/doc/DevelGuide/src/H5Dff_F03_f90.html -./fortran/doc/DevelGuide/src/H5Af_c.html -./fortran/doc/DevelGuide/src/H5Off_f90.html -./fortran/doc/DevelGuide/src/H5Df_c.html -./fortran/doc/DevelGuide/src/H5Sff_f90.html -./fortran/doc/DevelGuide/src/H5Ef_c.html -./fortran/doc/DevelGuide/src/HDF5mpio_f90.html -./fortran/doc/DevelGuide/src/H5Lff_F03_f90.html -./fortran/doc/DevelGuide/src/H5Ff_c.html -./fortran/doc/DevelGuide/src/H5f90global_f90.html -./fortran/doc/DevelGuide/src/H5Gf_c.html -./fortran/doc/DevelGuide/src/H5If_c.html -./fortran/doc/DevelGuide/src/H5Pff_F03_f90.html -./fortran/doc/DevelGuide/src/H5_ff_F90_f90.html -./fortran/doc/DevelGuide/src/H5Rff_F03_f90.html -./fortran/doc/DevelGuide/src/H5Lf_c.html -./fortran/doc/DevelGuide/src/H5Of_c.html -./fortran/doc/DevelGuide/src/H5Dff_F90_f90.html -./fortran/doc/DevelGuide/src/H5Pf_c.html -./fortran/doc/DevelGuide/src/H5FDmpioff_f90.html -./fortran/doc/DevelGuide/src/H5_ff_f90.html -./fortran/doc/DevelGuide/src/H5Rf_c.html -./fortran/doc/DevelGuide/src/H5Sf_c.html -./fortran/doc/DevelGuide/src/H5Tf_c.html -./fortran/doc/DevelGuide/src/H5Dff_f90.html -./fortran/doc/DevelGuide/src/H5Lff_F90_f90.html ./fortran/examples/Makefile.am ./fortran/examples/Makefile.in diff --git a/fortran/doc/DevelGuide/masterindex.html b/fortran/doc/DevelGuide/masterindex.html deleted file mode 100644 index 9765ea0..0000000 --- a/fortran/doc/DevelGuide/masterindex.html +++ /dev/null @@ -1,589 +0,0 @@ - - - - - - - -Index - - - - -
-
- -
-

Index

-

A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9

- h5pget_double - h5pget_hyper_vector_size_f - h5pset_family_offset_f - h5pset_fapl_family_f - h5pset_meta_block_size_f -

F

fflush1.f90 -fflush2.f90 -fortran/test/fflush1.f90 -fortran/test/fflush2.f90 -fortran/test/fortranlib_test.f90 -fortran/test/fortranlib_test_1_8.f90 -fortran/test/fortranlib_test_F03.f90 -fortran/test/tc.c -fortran/test/tf.f90 -fortran/test/tH5A.f90 -fortran/test/tH5A_1_8.f90 -fortran/test/tH5D.f90 -fortran/test/tH5E.f90 -fortran/test/tH5E_F03.f90 -fortran/test/tH5F.f90 -fortran/test/tH5G.f90 -fortran/test/tH5G_1_8.f90 -fortran/test/tH5I.f90 -fortran/test/tH5L_F03.f90 -fortran/test/tH5O.f90 -fortran/test/tH5P.f90 -fortran/test/tH5P_F03.f90 -fortran/test/tH5R.f90 -fortran/test/tH5S.f90 -fortran/test/tH5Sselect.f90 -fortran/test/tH5T.f90 -fortran/test/tH5T_F03.f90 -fortran/test/tH5VL.f90 -fortran/test/tH5Z.f90 -fortranlib_test.f90 -fortranlib_test_1_8.f90 -fortranlib_test_F03.f90 -

H

H5_DBLE_InterfaceExclude.f90 -H5_DBLE_InterfaceInclude.f90 -H5_ff.f90 -H5_ff_F03.f90 -H5_ff_F90.f90 -H5A -H5A (F03) -H5A (F90) -h5aclose_f -h5acreate_by_name_f -h5acreate_f -h5adelete_by_idx_f -h5adelete_by_name_f -h5adelete_f -H5Aexists_by_name_f -H5Aexists_f -H5Af -H5Af.c -H5Aff.f90 -H5Aff_F03.f90 -H5Aff_F90.f90 -h5aget_create_plist_f -h5aget_info_by_idx_f -h5aget_info_by_name_f -h5aget_info_f -h5aget_name_by_idx_f -h5aget_name_f -h5aget_num_attrs_f -h5aget_space_f -h5aget_storage_size_f -h5aget_type_f -h5aopen_by_idx_f -H5Aopen_by_name_f -h5aopen_f -h5aopen_idx_f -h5aopen_name_f -h5aread_f -h5arename_by_name_f -h5arename_f -h5check_version_f -h5close_f -H5D -H5D (F03) -H5D (F90) -h5dclose_f -h5dcreate_anon_f -h5dcreate_f -H5Df -H5Df.c -H5Dff.f90 -H5Dff_F03.f90 -H5Dff_F90.f90 -h5dget_access_plist_f -h5dget_create_plist_f -h5dget_space_f -h5dget_space_status_f -h5dget_storage_size_f -h5dget_type_f -h5dont_atexit_f -h5dopen_f -h5dread_f -h5dset_extent -h5dvlen_get_max_len_f -h5dvlen_reclaim -H5E -H5E (F03) -H5E (F90) -h5eclear_f -H5Ef -H5Ef.c -H5Eff.f90 -H5Eff_F03.f90 -H5Eff_F90.f90 -h5eget_auto_f -h5eget_major_f -h5eget_minor_f -h5eprint_f -h5eset_auto2_f -h5eset_auto_f -H5F -H5f90global.f90 -H5f90kit -H5f90kit.c -h5fclose_f -h5fcreate_f -H5FDMPIO -H5FDmpiof -H5FDmpiof.c -H5FDmpioff.f90 -H5Ff -H5Ff.c -H5Fff.f90 -h5fflush_f -h5fget_access_plist_f -h5fget_create_plist_f -h5fget_filesize_f -h5fget_freespace_f -h5fget_name_f -h5fget_obj_count_f -h5fget_obj_ids_f -h5fis_hdf5_f -h5fmount_f -h5fopen_f -h5freopen_f -h5funmount_f -H5G -h5garbage_collect_f -h5gclose_f -H5Gcreate_anon_f -h5gcreate_f -h5get_libversion_f -H5Gf -H5Gf.c -H5Gff.f90 -h5gget_comment_f -H5Gget_create_plist_f -h5gget_info_by_idx_f -h5gget_info_by_name_f -h5gget_info_f -h5gget_linkval_f -h5gget_obj_info_idx_f -h5glink2_f -h5glink_f -H5GLOBAL -h5gmove2_f -h5gmove_f -h5gn_members_f -h5gopen_f -h5gset_comment_f -h5gunlink_f -H5I -h5idec_ref_f -H5If -H5If.c -H5Iff.f90 -h5iget_file_id_f -h5iget_name_f -h5iget_ref_f -h5iget_type_f -h5iinc_ref_f -h5iis_valid_f -h5kind_to_type -H5L -H5L (F03) -H5L (F90) -h5lcopy_f -H5Lcreate_external_f -H5Lcreate_hard_f -H5Lcreate_soft_f -h5ldelete_by_idx_f -h5ldelete_f -H5Lexists_f -H5Lf -H5Lf.c -H5Lff.f90 -H5Lff_F03.f90 -H5Lff_F90.f90 -h5lget_info_by_idx_f -h5lget_info_f -h5lget_name_by_idx_f -H5LIB -H5LIB_PROVISIONAL -H5LIB_PROVISIONAL (F90) -h5lis_registered_f -h5literate_by_name_f -h5literate_f -h5lmove_f -H5match_types -H5match_types.c -H5O -H5O (F03) -H5O (F90) -h5oclose_f -H5Of -H5Of.c -H5Off.f90 -H5Off_F03.f90 -H5Off_F90.f90 -h5offsetof -h5olink_f -h5oopen_f -h5open_by_addr_f -h5open_f -h5ovisit_f -H5P (_F90) -H5P (F03) -H5P (F90) -h5pall_filters_avail_f -h5pclose_class_f -h5pclose_f -h5pcopy_f -h5pcopy_prop_f -h5pcreate_class_f -h5pcreate_class_f -h5pcreate_f -h5pequal_f -h5pexist_f -H5Pf -H5Pf.c -H5Pff.f90 -H5Pff_F03.f90 -H5Pff_F90.f90 -h5pfill_value_defined_f -h5pget_alignment_f -h5pget_alloc_time_f -H5Pget_attr_creation_order_f -H5Pget_attr_phase_change_f -h5pget_btree_ratios_f -h5pget_buffer_f -h5pget_cache_f -h5pget_char -h5pget_char -H5Pget_char_encoding_f -H5Pget_chunk_cache_f -h5pget_chunk_f -h5pget_class_f -h5pget_class_name_f -h5pget_class_parent_f -h5pget_copy_object_f -H5Pget_create_inter_group_f -h5pget_data_transform_f -h5pget_double -h5pget_driver_f -h5pget_dxpl_mpio_f -h5pget_edc_check_f -H5Pget_est_link_info_f -h5pget_external_count_f -h5pget_external_f -h5pget_fapl_core_f -h5pget_fapl_direct_f -h5pget_fapl_family_f -h5pget_fapl_mpio_f -h5pget_fapl_mpiposix_f -h5pget_fapl_multi_f -h5pget_fclose_degree_f -h5pget_fill_time_f -h5pget_filter_by_id_f -h5pget_filter_f -h5pget_gc_references_f -h5pget_integer -h5pget_integer -h5pget_istore_k_f -h5pget_layout_f -H5Pget_link_creation_order_f -H5Pget_link_phase_change_f -H5Pget_local_heap_size_hint_f -h5pget_meta_block_size_f -h5pget_nfilters_f -h5pget_nlinks_f -h5pget_npros_f -H5Pget_obj_track_times_f -h5pget_preserve_f -h5pget_real -h5pget_real -h5pget_sec2_f -h5pget_sieve_buf_size_f -h5pget_size_f -h5pget_sizes_f -h5pget_small_data_block_size_f -h5pget_split_f -h5pget_stdio_f -h5pget_sym_k_f -h5pget_userblock_f -h5pget_version_f -h5pinsert_char -h5pinsert_char -h5pinsert_double -h5pinsert_double -h5pinsert_integer -h5pinsert_integer -h5pinsert_ptr -h5pinsert_real -h5pinsert_real -h5pisa_class_f -h5pmodify_filter_f -h5pregister_char -h5pregister_char -h5pregister_double -h5pregister_double -h5pregister_integer -h5pregister_integer -h5pregister_ptr -h5pregister_real -h5pregister_real -h5premove_f -h5premove_filter_f -h5pset(get)fill_value_f -h5pset(get)fill_value_f -h5pset_alignment_f -h5pset_alloc_time_f -H5Pset_attr_creation_order_f -H5Pset_attr_phase_change_f -h5pset_btree_ratios_f -h5pset_buffer_f -h5pset_cache_f -h5pset_char -h5pset_char -H5Pset_char_encoding_f -H5Pset_chunk_cache_f -h5pset_chunk_f -h5pset_copy_object_f -H5Pset_create_inter_group_f -h5pset_data_transform_f -h5pset_deflate_f -h5pset_double -h5pset_double -h5pset_dxpl_mpio_f -h5pset_edc_check_f -h5pset_est_link_info_f -h5pset_external_f -h5pset_fapl_core_f -h5pset_fapl_direct_f -h5pset_fapl_mpio_f -h5pset_fapl_mpiposix_f -h5pset_fapl_multi_l -h5pset_fapl_multi_s -h5pset_fapl_sec2_f -h5pset_fapl_split_f -h5pset_fapl_stdio_f -h5pset_fclose_degree_f -h5pset_fill_time_f -h5pset_filter_f -h5pset_fletcher32_f -h5pset_gc_references_f -h5pset_hyper_vector_size_f -h5pset_integer -h5pset_integer -h5pset_istore_k_f -h5pset_layout_f -H5Pset_libver_bounds_f -H5Pset_link_creation_order_f -h5pset_link_phase_change_f -H5Pset_local_heap_size_hint_f -H5Pset_nbit_f -h5pset_nlinks_f -H5Pset_obj_track_times_f -h5pset_preserve_f -h5pset_real -h5pset_real -h5pset_scaleoffset_f -H5Pset_shared_mesg_index_f -H5Pset_shared_mesg_nindexes_f -h5pset_shuffle_f -h5pset_sieve_buf_size_f -h5pset_sizes_f -h5pset_small_data_block_size_f -h5pset_sym_k_f -h5pset_szip_f -h5pset_userblock_f -h5punregister_f -H5R -H5R (F03) -H5R (F90) -h5rcreate_object_f -h5rcreate_object_f -h5rcreate_ptr_f -h5rcreate_region_f -h5rcreate_region_f -h5rdereference_object_f -h5rdereference_object_f -h5rdereference_ptr_f -h5rdereference_region_f -h5rdereference_region_f -H5Rf -H5Rf.c -H5Rff.f90 -H5Rff_F03.f90 -H5Rff_F90.f90 -h5rget_name_object_f -h5rget_name_object_f -h5rget_name_ptr_f -h5rget_name_region_f -h5rget_name_region_f -h5rget_obj_type_f -h5rget_object_type_obj_f -h5rget_region_region_f -H5S -h5sclose_f -h5scopy_f -h5screate_f -h5screate_simple_f -H5Sdecode_f -H5Sencode_f -h5sextent_copy_f -h5sextent_equal_f -H5Sf -H5Sf.c -H5Sff.f90 -h5sget_select_bounds_f -h5sget_select_elem_npoints_f -h5sget_select_elem_pointlist_f -h5sget_select_hyper_blocklist_f -h5sget_select_hyper_nblocks_f -h5sget_select_npoints_f -h5sget_select_type_f -h5sget_simple_extent_dims_f -h5sget_simple_extent_ndims_f -h5sget_simple_extent_npoints_f -h5sget_simple_extent_type_f -h5sis_simple_f -h5soffset_simple_f -h5sselect_all_f -h5sselect_elements_f -h5sselect_hyperslab_f -h5sselect_none_f -h5sselect_valid_f -h5sset_extent_none_f -h5sset_extent_simple_f -H5T -H5T (F03) -H5T (F90) -h5tarray_create_f -h5tclose_f -h5tcommit_anon_f -h5tcommit_f -h5tcommitted_f -h5tcompiler_conv_f -H5Tconvert_f -h5tcopy_f -h5tcreate_f -H5Tdecode_f -h5tenaum_insert_f -H5Tencode_f -h5tenum_create_f -h5tenum_nameof_f -h5tenum_valuof_f -h5tequal_f -H5test_kind -H5test_kind.f90 -H5test_kind_SIZEOF -H5test_kind_SIZEOF.f90 -H5Tf -H5Tf.c -H5Tff.f90 -H5Tff_F03.f90 -H5Tff_F90.f90 -h5tget_array_dims_f -h5tget_array_ndims_f -h5tget_class_f -h5tget_create_plist_f -h5tget_cset_f -h5tget_ebias_f -h5tget_fields_f -h5tget_inpad_f -h5tget_member_class_f -h5tget_member_index_f -h5tget_member_name_f -h5tget_member_offset_f -h5tget_member_type_f -h5tget_member_value_f -h5tget_native_type_f -h5tget_nmembers_f -h5tget_norm_f -h5tget_offset_f -h5tget_order_f -h5tget_pad_f -h5tget_precision_f -h5tget_sign_f -h5tget_size_f -h5tget_strpad_f -h5tget_super_f -h5tget_tag_f -h5tinsert_f -h5tis_variable_str_f -h5topen_f -h5tpack_f -h5tset_cset_f -h5tset_ebias_f -h5tset_fields_f -h5tset_inpad_f -h5tset_norm_f -h5tset_offset_f -h5tset_order_f -h5tset_pad_f -h5tset_precision_f -h5tset_sign_f -h5tset_size_f -h5tset_strpad_f -h5tset_tag_f -h5tvlen_create_f -H5Z -H5Zf -H5Zf.c -H5Zff.f90 -h5zfilter_avail_f -h5zget_filter_info_f -h5zunregister_f -HDF5 -HDF5 (mpio) -HDF5.f90 -HDF5mpio.f90 -

S

src/H5_DBLE_InterfaceExclude.f90 -src/H5_DBLE_InterfaceInclude.f90 -

T

t.c -tf.f90 -tH5A.f90 -tH5A_1_8.f90 -tH5D.f90 -tH5E.f90 -tH5E_F03.f90 -tH5F.f90 -tH5G.f90 -tH5G_1_8.f90 -tH5I.f90 -tH5L_F03.f90 -tH5O.f90 -tH5P.f90 -tH5P_F03.f90 -tH5R.f90 -tH5S.f90 -tH5Sselect.f90 -tH5T.f90 -tH5T_F03.f90 -tH5VL.f90 -tH5Z.f90 -

A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9

-
- - - diff --git a/fortran/doc/DevelGuide/robo_functions.html b/fortran/doc/DevelGuide/robo_functions.html deleted file mode 100644 index e4f253a..0000000 --- a/fortran/doc/DevelGuide/robo_functions.html +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - -Functions - - - - -
-
- -
-

Functions

-

A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9

-

H

h5kind_to_type -h5offsetof -

A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9

-
- - - diff --git a/fortran/doc/DevelGuide/robo_modules.html b/fortran/doc/DevelGuide/robo_modules.html deleted file mode 100644 index 8e57f38..0000000 --- a/fortran/doc/DevelGuide/robo_modules.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - -Modules - - - - -
-
- -
-

Modules

-

A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9

-

F

fortran/test/fflush1.f90 -fortran/test/fflush2.f90 -fortran/test/fortranlib_test.f90 -fortran/test/fortranlib_test_1_8.f90 -fortran/test/fortranlib_test_F03.f90 -fortran/test/tc.c -fortran/test/tf.f90 -fortran/test/tH5A.f90 -fortran/test/tH5A_1_8.f90 -fortran/test/tH5D.f90 -fortran/test/tH5E.f90 -fortran/test/tH5E_F03.f90 -fortran/test/tH5F.f90 -fortran/test/tH5G.f90 -fortran/test/tH5G_1_8.f90 -fortran/test/tH5I.f90 -fortran/test/tH5L_F03.f90 -fortran/test/tH5O.f90 -fortran/test/tH5P.f90 -fortran/test/tH5P_F03.f90 -fortran/test/tH5R.f90 -fortran/test/tH5S.f90 -fortran/test/tH5Sselect.f90 -fortran/test/tH5T.f90 -fortran/test/tH5T_F03.f90 -fortran/test/tH5VL.f90 -fortran/test/tH5Z.f90 -

H

H5A -H5A (F03) -H5A (F90) -H5Af -H5D -H5D (F03) -H5D (F90) -H5Df -H5E -H5E (F03) -H5E (F90) -H5Ef -H5F -H5f90kit -H5FDMPIO -H5FDmpiof -H5Ff -H5G -H5Gf -H5GLOBAL -H5I -H5If -H5L -H5L (F03) -H5L (F90) -H5Lf -H5LIB -H5LIB_PROVISIONAL -H5LIB_PROVISIONAL (F90) -H5O -H5O (F03) -H5O (F90) -H5Of -H5P (_F90) -H5P (F03) -H5P (F90) -H5Pf -H5R -H5R (F03) -H5R (F90) -H5Rf -H5S -H5Sf -H5T -H5T (F03) -H5T (F90) -H5Tf -H5Z -H5Zf -HDF5 -HDF5 (mpio) -

S

src/H5_DBLE_InterfaceExclude.f90 -src/H5_DBLE_InterfaceInclude.f90 -

A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9

-
- - - diff --git a/fortran/doc/DevelGuide/robo_programs.html b/fortran/doc/DevelGuide/robo_programs.html deleted file mode 100644 index 8c35230..0000000 --- a/fortran/doc/DevelGuide/robo_programs.html +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - -Programs - - - - -
-
- -
-

Programs

-

A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9

-

H

H5test_kind -H5test_kind_SIZEOF -

A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9

-
- - - diff --git a/fortran/doc/DevelGuide/robo_sourcefiles.html b/fortran/doc/DevelGuide/robo_sourcefiles.html deleted file mode 100644 index 63a8637..0000000 --- a/fortran/doc/DevelGuide/robo_sourcefiles.html +++ /dev/null @@ -1,309 +0,0 @@ - - - - - - - -Sourcefiles - - - - -
-
- -
- -
- - - diff --git a/fortran/doc/DevelGuide/robo_subroutines.html b/fortran/doc/DevelGuide/robo_subroutines.html deleted file mode 100644 index 0846c77..0000000 --- a/fortran/doc/DevelGuide/robo_subroutines.html +++ /dev/null @@ -1,421 +0,0 @@ - - - - - - - -Subroutines - - - - -
-
- -
-

Subroutines

-

A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9

- h5pget_double - h5pget_hyper_vector_size_f - h5pset_family_offset_f - h5pset_fapl_family_f - h5pset_meta_block_size_f -

H

h5aclose_f -h5acreate_by_name_f -h5acreate_f -h5adelete_by_idx_f -h5adelete_by_name_f -h5adelete_f -H5Aexists_by_name_f -H5Aexists_f -h5aget_create_plist_f -h5aget_info_by_idx_f -h5aget_info_by_name_f -h5aget_info_f -h5aget_name_by_idx_f -h5aget_name_f -h5aget_num_attrs_f -h5aget_space_f -h5aget_storage_size_f -h5aget_type_f -h5aopen_by_idx_f -H5Aopen_by_name_f -h5aopen_f -h5aopen_idx_f -h5aopen_name_f -h5aread_f -h5arename_by_name_f -h5arename_f -h5check_version_f -h5close_f -h5dclose_f -h5dcreate_anon_f -h5dcreate_f -h5dget_access_plist_f -h5dget_create_plist_f -h5dget_space_f -h5dget_space_status_f -h5dget_storage_size_f -h5dget_type_f -h5dont_atexit_f -h5dopen_f -h5dread_f -h5dset_extent -h5dvlen_get_max_len_f -h5dvlen_reclaim -h5eclear_f -h5eget_auto_f -h5eget_major_f -h5eget_minor_f -h5eprint_f -h5eset_auto2_f -h5eset_auto_f -h5fclose_f -h5fcreate_f -h5fflush_f -h5fget_access_plist_f -h5fget_create_plist_f -h5fget_filesize_f -h5fget_freespace_f -h5fget_name_f -h5fget_obj_count_f -h5fget_obj_ids_f -h5fis_hdf5_f -h5fmount_f -h5fopen_f -h5freopen_f -h5funmount_f -h5garbage_collect_f -h5gclose_f -H5Gcreate_anon_f -h5gcreate_f -h5get_libversion_f -h5gget_comment_f -H5Gget_create_plist_f -h5gget_info_by_idx_f -h5gget_info_by_name_f -h5gget_info_f -h5gget_linkval_f -h5gget_obj_info_idx_f -h5glink2_f -h5glink_f -h5gmove2_f -h5gmove_f -h5gn_members_f -h5gopen_f -h5gset_comment_f -h5gunlink_f -h5idec_ref_f -h5iget_file_id_f -h5iget_name_f -h5iget_ref_f -h5iget_type_f -h5iinc_ref_f -h5iis_valid_f -h5lcopy_f -H5Lcreate_external_f -H5Lcreate_hard_f -H5Lcreate_soft_f -h5ldelete_by_idx_f -h5ldelete_f -H5Lexists_f -h5lget_info_by_idx_f -h5lget_info_f -h5lget_name_by_idx_f -h5lis_registered_f -h5literate_by_name_f -h5literate_f -h5lmove_f -h5oclose_f -h5olink_f -h5oopen_f -h5open_by_addr_f -h5open_f -h5ovisit_f -h5pall_filters_avail_f -h5pclose_class_f -h5pclose_f -h5pcopy_f -h5pcopy_prop_f -h5pcreate_class_f -h5pcreate_class_f -h5pcreate_f -h5pequal_f -h5pexist_f -h5pfill_value_defined_f -h5pget_alignment_f -h5pget_alloc_time_f -H5Pget_attr_creation_order_f -H5Pget_attr_phase_change_f -h5pget_btree_ratios_f -h5pget_buffer_f -h5pget_cache_f -h5pget_char -h5pget_char -H5Pget_char_encoding_f -H5Pget_chunk_cache_f -h5pget_chunk_f -h5pget_class_f -h5pget_class_name_f -h5pget_class_parent_f -h5pget_copy_object_f -H5Pget_create_inter_group_f -h5pget_data_transform_f -h5pget_double -h5pget_driver_f -h5pget_dxpl_mpio_f -h5pget_edc_check_f -H5Pget_est_link_info_f -h5pget_external_count_f -h5pget_external_f -h5pget_fapl_core_f -h5pget_fapl_direct_f -h5pget_fapl_family_f -h5pget_fapl_mpio_f -h5pget_fapl_mpiposix_f -h5pget_fapl_multi_f -h5pget_fclose_degree_f -h5pget_fill_time_f -h5pget_filter_by_id_f -h5pget_filter_f -h5pget_gc_references_f -h5pget_integer -h5pget_integer -h5pget_istore_k_f -h5pget_layout_f -H5Pget_link_creation_order_f -H5Pget_link_phase_change_f -H5Pget_local_heap_size_hint_f -h5pget_meta_block_size_f -h5pget_nfilters_f -h5pget_nlinks_f -h5pget_npros_f -H5Pget_obj_track_times_f -h5pget_preserve_f -h5pget_real -h5pget_real -h5pget_sec2_f -h5pget_sieve_buf_size_f -h5pget_size_f -h5pget_sizes_f -h5pget_small_data_block_size_f -h5pget_split_f -h5pget_stdio_f -h5pget_sym_k_f -h5pget_userblock_f -h5pget_version_f -h5pinsert_char -h5pinsert_char -h5pinsert_double -h5pinsert_double -h5pinsert_integer -h5pinsert_integer -h5pinsert_ptr -h5pinsert_real -h5pinsert_real -h5pisa_class_f -h5pmodify_filter_f -h5pregister_char -h5pregister_char -h5pregister_double -h5pregister_double -h5pregister_integer -h5pregister_integer -h5pregister_ptr -h5pregister_real -h5pregister_real -h5premove_f -h5premove_filter_f -h5pset(get)fill_value_f -h5pset(get)fill_value_f -h5pset_alignment_f -h5pset_alloc_time_f -H5Pset_attr_creation_order_f -H5Pset_attr_phase_change_f -h5pset_btree_ratios_f -h5pset_buffer_f -h5pset_cache_f -h5pset_char -h5pset_char -H5Pset_char_encoding_f -H5Pset_chunk_cache_f -h5pset_chunk_f -h5pset_copy_object_f -H5Pset_create_inter_group_f -h5pset_data_transform_f -h5pset_deflate_f -h5pset_double -h5pset_double -h5pset_dxpl_mpio_f -h5pset_edc_check_f -h5pset_est_link_info_f -h5pset_external_f -h5pset_fapl_core_f -h5pset_fapl_direct_f -h5pset_fapl_mpio_f -h5pset_fapl_mpiposix_f -h5pset_fapl_multi_l -h5pset_fapl_multi_s -h5pset_fapl_sec2_f -h5pset_fapl_split_f -h5pset_fapl_stdio_f -h5pset_fclose_degree_f -h5pset_fill_time_f -h5pset_filter_f -h5pset_fletcher32_f -h5pset_gc_references_f -h5pset_hyper_vector_size_f -h5pset_integer -h5pset_integer -h5pset_istore_k_f -h5pset_layout_f -H5Pset_libver_bounds_f -H5Pset_link_creation_order_f -h5pset_link_phase_change_f -H5Pset_local_heap_size_hint_f -H5Pset_nbit_f -h5pset_nlinks_f -H5Pset_obj_track_times_f -h5pset_preserve_f -h5pset_real -h5pset_real -h5pset_scaleoffset_f -H5Pset_shared_mesg_index_f -H5Pset_shared_mesg_nindexes_f -h5pset_shuffle_f -h5pset_sieve_buf_size_f -h5pset_sizes_f -h5pset_small_data_block_size_f -h5pset_sym_k_f -h5pset_szip_f -h5pset_userblock_f -h5punregister_f -h5rcreate_object_f -h5rcreate_object_f -h5rcreate_ptr_f -h5rcreate_region_f -h5rcreate_region_f -h5rdereference_object_f -h5rdereference_object_f -h5rdereference_ptr_f -h5rdereference_region_f -h5rdereference_region_f -h5rget_name_object_f -h5rget_name_object_f -h5rget_name_ptr_f -h5rget_name_region_f -h5rget_name_region_f -h5rget_obj_type_f -h5rget_object_type_obj_f -h5rget_region_region_f -h5sclose_f -h5scopy_f -h5screate_f -h5screate_simple_f -H5Sdecode_f -H5Sencode_f -h5sextent_copy_f -h5sextent_equal_f -h5sget_select_bounds_f -h5sget_select_elem_npoints_f -h5sget_select_elem_pointlist_f -h5sget_select_hyper_blocklist_f -h5sget_select_hyper_nblocks_f -h5sget_select_npoints_f -h5sget_select_type_f -h5sget_simple_extent_dims_f -h5sget_simple_extent_ndims_f -h5sget_simple_extent_npoints_f -h5sget_simple_extent_type_f -h5sis_simple_f -h5soffset_simple_f -h5sselect_all_f -h5sselect_elements_f -h5sselect_hyperslab_f -h5sselect_none_f -h5sselect_valid_f -h5sset_extent_none_f -h5sset_extent_simple_f -h5tarray_create_f -h5tclose_f -h5tcommit_anon_f -h5tcommit_f -h5tcommitted_f -h5tcompiler_conv_f -H5Tconvert_f -h5tcopy_f -h5tcreate_f -H5Tdecode_f -h5tenaum_insert_f -H5Tencode_f -h5tenum_create_f -h5tenum_nameof_f -h5tenum_valuof_f -h5tequal_f -h5tget_array_dims_f -h5tget_array_ndims_f -h5tget_class_f -h5tget_create_plist_f -h5tget_cset_f -h5tget_ebias_f -h5tget_fields_f -h5tget_inpad_f -h5tget_member_class_f -h5tget_member_index_f -h5tget_member_name_f -h5tget_member_offset_f -h5tget_member_type_f -h5tget_member_value_f -h5tget_native_type_f -h5tget_nmembers_f -h5tget_norm_f -h5tget_offset_f -h5tget_order_f -h5tget_pad_f -h5tget_precision_f -h5tget_sign_f -h5tget_size_f -h5tget_strpad_f -h5tget_super_f -h5tget_tag_f -h5tinsert_f -h5tis_variable_str_f -h5topen_f -h5tpack_f -h5tset_cset_f -h5tset_ebias_f -h5tset_fields_f -h5tset_inpad_f -h5tset_norm_f -h5tset_offset_f -h5tset_order_f -h5tset_pad_f -h5tset_precision_f -h5tset_sign_f -h5tset_size_f -h5tset_strpad_f -h5tset_tag_f -h5tvlen_create_f -h5zfilter_avail_f -h5zget_filter_info_f -h5zunregister_f -

A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9

-
- - - diff --git a/fortran/doc/DevelGuide/robodoc.css b/fortran/doc/DevelGuide/robodoc.css deleted file mode 100644 index 207a172..0000000 --- a/fortran/doc/DevelGuide/robodoc.css +++ /dev/null @@ -1,302 +0,0 @@ -/****h* ROBODoc/ROBODoc Cascading Style Sheet - * FUNCTION - * This is the default cascading style sheet for documentation - * generated with ROBODoc. - * You can edit this file to your own liking and then use - * it with the option - * --css - * - * This style-sheet defines the following layout - * +----------------------------------------+ - * | logo | - * +----------------------------------------+ - * | extra | - * +----------------------------------------+ - * | | navi- | - * | | gation | - * | content | | - * | | | - * +----------------------------------------+ - * | footer | - * +----------------------------------------+ - * - * This style-sheet is based on a style-sheet that was automatically - * generated with the Strange Banana stylesheet generator. - * See http://www.strangebanana.com/generator.aspx - * - ****** - * $Id: html_generator.c,v 1.94 2008/06/17 11:49:27 gumpu Exp $ - */ - -body -{ - background-color: rgb(255,255,255); - color: rgb(98,84,55); - font-family: Arial, serif; - border-color: rgb(226,199,143); -} - -pre -{ - font-family: monospace; - margin: 15px; - padding: 5px; - white-space: pre; - color: #000; -} - -pre.source -{ - background-color: #ffe; - border: dashed #aa9 1px; -} - -p -{ - margin:15px; -} - -p.item_name -{ - font-weight: bolder; - margin:5px; - font-size: 120%; -} - -#content -{ - font-size: 100%; - color: rgb(0,0,0); - background-color: rgb(255,255,255); - border-left-width: 0px; - border-right-width: 0px; - border-top-width: 0px; - border-bottom-width: 0px; - border-left-style: none; - border-right-style: none; - border-top-style: none; - border-bottom-style: none; - padding: 40px 31px 14px 17px; - border-color: rgb(0,0,0); - text-align: justify; -} - -#navigation -{ - background-color: rgb(98,84,55); - color: rgb(230,221,202); - font-family: "Times New Roman", serif; - font-style: normal; - border-color: rgb(0,0,0); -} - -a.menuitem -{ - font-size: 120%; - background-color: rgb(0,0,0); - color: rgb(195,165,100); - font-variant: normal; - text-transform: none; - font-weight: normal; - padding: 1px 8px 3px 1px; - margin-left: 5px; - margin-right: 5px; - margin-top: 5px; - margin-bottom: 5px; - border-color: rgb(159,126,57); - text-align: right; -} - -#logo, #logo a -{ - font-size: 130%; - background-color: rgb(198,178,135); - color: rgb(98,84,55); - font-family: Georgia, serif; - font-style: normal; - font-variant: normal; - text-transform: none; - font-weight: bold; - padding: 20px 18px 20px 18px; - border-color: rgb(255,255,255); - text-align: right; -} - -#extra, #extra a -{ - font-size: 128%; - background-color: rgb(0,0,0); - color: rgb(230,221,202); - font-style: normal; - font-variant: normal; - text-transform: none; - font-weight: normal; - border-left-width: 0px; - border-right-width: 0px; - border-top-width: 0px; - border-bottom-width: 0px; - border-left-style: none; - border-right-style: none; - border-top-style: none; - border-bottom-style: none; - padding: 12px 12px 12px 12px; - border-color: rgb(195,165,100); - text-align: center; -} - -#content a -{ - color: rgb(159,126,57); - text-decoration: none; -} - -#content a:hover, #content a:active -{ - color: rgb(255,255,255); - background-color: rgb(159,126,57); -} - -a.indexitem -{ - display: block; -} - -h1, h2, h3, h4, h5, h6 -{ - background-color: rgb(221,221,221); - font-family: Arial, serif; - font-style: normal; - font-variant: normal; - text-transform: none; - font-weight: normal; -} - -h1 -{ - font-size: 151%; -} - -h2 -{ - font-size: 142%; -} - -h3 -{ - font-size: 133%; -} - -h4 -{ - font-size: 124%; -} - -h5 -{ - font-size: 115%; -} - -h6 -{ - font-size: 106%; -} - -#navigation a -{ - text-decoration: none; -} - -.menuitem:hover -{ - background-color: rgb(195,165,100); - color: rgb(0,0,0); -} - -#extra a -{ - text-decoration: none; -} - -#logo a -{ - text-decoration: none; -} - -#extra a:hover -{ -} - -/* layout */ -#navigation -{ - width: 22%; - position: relative; - top: 0; - right: 0; - float: right; - text-align: center; - margin-left: 10px; -} - -.menuitem {width: auto;} -#content {width: auto;} -.menuitem {display: block;} - - -div#footer -{ - background-color: rgb(198,178,135); - color: rgb(98,84,55); - clear: left; - width: 100%; - font-size: 71%; -} - -div#footer a -{ - background-color: rgb(198,178,135); - color: rgb(98,84,55); -} - -div#footer p -{ - margin:0; - padding:5px 10px -} - -span.keyword -{ - color: #00F; -} - -span.comment -{ - color: #080; -} - -span.quote -{ - color: #F00; -} - -span.squote -{ - color: #F0F; -} - -span.sign -{ - color: #008B8B; -} - -span.line_number -{ - color: #808080; -} - -@media print -{ - #navigation {display: none;} - #content {padding: 0px;} - #content a {text-decoration: underline;} -} diff --git a/fortran/doc/DevelGuide/src/H5Af_c.html b/fortran/doc/DevelGuide/src/H5Af_c.html deleted file mode 100644 index 7fcecc1..0000000 --- a/fortran/doc/DevelGuide/src/H5Af_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Af.c - - - - - -
-
- -

H5Af

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5A Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Aff_F03_f90.html b/fortran/doc/DevelGuide/src/H5Aff_F03_f90.html deleted file mode 100644 index 9e503f4..0000000 --- a/fortran/doc/DevelGuide/src/H5Aff_F03_f90.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - -./src/H5Aff_F03.f90 - - - - - -
-
- -

H5A (F03)

- -

[ Top ] [ Modules ]

-

NAME

-
  H5A_PROVISIONAL
-
-

FILE

-
  src/fortran/src/H5Aff_F03.f90
-
-

PURPOSE

-
  This file contains Fortran 90 and Fortran 2003 interfaces for H5A functions.
-  It contains the same functions as H5Aff_F90.f90 but includes the
-  Fortran 2003 functions and the interface listings. This file will be compiled
-  instead of H5Aff_F90.f90 if Fortran 2003 functions are enabled.
-
-

NOTES

-
  (A) C_LOC and character strings according to the Fortran 2003 standard:
-
-  15.1.2.5 C_LOC(X)
-
-  Argument. X shall either
-
-  (1) have interoperable type and type parameters and be
-    (a) a variable that has the TARGET attribute and is interoperable,
-    (b) an allocated allocatable variable that has the TARGET attribute
-        and is not an array of zero size, or
-    (c) an associated scalar pointer, or
-  (2) be a nonpolymorphic scalar, have no length type parameters, and be
-    (a) a nonallocatable, nonpointer variable that has the TARGET attribute,
-    (b) an allocated allocatable variable that has the TARGET attribute, or
-    (c) an associated pointer.
-
-  - When X is a character, for interoperability the standard is:
-
-  15.2.1 Interoperability of intrinsic types
-
-  ...if the type is character, interoperability also requires that the length type parameter
-  be omitted or be specified by an initialization expression whose value is one.
-
-  THEREFORE compilers that have not extended the standard  require
-
-  CHARACTER(LEN=1), TARGET :: chr
-  or
-  CHARACTER, TARGET :: chr
-
-  (B)
-                         *** IMPORTANT ***
-  If you add a new H5A function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5aread_f

- -

[ Top ] [ H5A (F03) ] [ Subroutines ]

-

NAME

-
  h5aread_f
-
-

PURPOSE

-
  Reads an attribute.
-
-

INPUTS

-
  attr_id       - attribute identifier
-  memtype_id    - attribute memory type identifier
-  dims          - 1D array of size 7, stores sizes of the
-                - buf array dimensions.
-
-

OUTPUTS

-
  buf           - buffer to read attribute data in
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces are added for
-  called C functions (it is needed for Windows
-  port).  February 27, 2001
-
-  dims parameter was added to make code portable;
-  Aprile 4, 2001
-
-  Changed buf intent to INOUT to be consistant
-  with how the C functions handles it. The pg
-  compiler will return 0 if a buf value is not set.
-  February, 2008
-
-

NOTES

-
  This function is overloaded to write INTEGER,
-  REAL, DOUBLE PRECISION and CHARACTER buffers
-  up to 7 dimensions.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Aff_F90_f90.html b/fortran/doc/DevelGuide/src/H5Aff_F90_f90.html deleted file mode 100644 index aa01b49..0000000 --- a/fortran/doc/DevelGuide/src/H5Aff_F90_f90.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - -./src/H5Aff_F90.f90 - - - - - -
-
- -

H5A (F90)

- -

[ Top ] [ Modules ]

-

NAME

-
  H5A_PROVISIONAL
-
-

FILE

-
  fortran/src/H5Aff_F90.f90
-
-

PURPOSE

-
  This file contains Fortran 90 interfaces for H5A functions. It contains
-  the same functions as H5Aff_F03.f90 but excludes the Fortran 2003 functions
-  and the interface listings. This file will be compiled instead of H5Aff_F03.f90
-  if Fortran 2003 functions are not enabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5A function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Aff_f90.html b/fortran/doc/DevelGuide/src/H5Aff_f90.html deleted file mode 100644 index 268c1db..0000000 --- a/fortran/doc/DevelGuide/src/H5Aff_f90.html +++ /dev/null @@ -1,1102 +0,0 @@ - - - - - - - -./src/H5Aff.f90 - - - - - -
-
- -

H5A

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5A
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5A functions. It includes
-  all the functions that are independent on whether the Fortran 2003 functions
-  are enabled or disabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5A function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5aclose_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aclose_f
-
-

PURPOSE

-
  Closes the specified attribute.
-
-

INPUTS

-
  attr_id  - attribute identifier
-
-

OUTPUTS

-
  hdferr   - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces are added for
-  called C functions (it is needed for Windows
-  port).  February 27, 2001
-
-

SOURCE

-
  SUBROUTINE h5aclose_f(attr_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: attr_id  ! Attribute identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5acreate_by_name_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5acreate_by_name_f
-
-

PURPOSE

-
  Creates an attribute attached to a specified object
-
-

INPUTS

-
  loc_id        - Location or object identifier; may be dataset or group
-  obj_name      - Name, relative to loc_id, of object that attribute is to be attached to
-  attr_name     - Attribute name
-  type_id       - Attribute datatype identifier
-  space_id      - Attribute dataspace identifier
-
-

OUTPUTS

-
  attr          - an attribute identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  acpl_id       - Attribute creation property list identifier (Currently not used.)
-  aapl_id       - Attribute access property list identifier (Currently not used.)
-  lapl_id       - Link access property list
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February, 2008
-
-

SOURCE

-
  SUBROUTINE h5acreate_by_name_f(loc_id, obj_name, attr_name, type_id, space_id, attr, hdferr, &
-       acpl_id, aapl_id, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T),   INTENT(IN)  :: loc_id
-    CHARACTER(LEN=*), INTENT(IN)  :: obj_name
-    CHARACTER(LEN=*), INTENT(IN)  :: attr_name
-    INTEGER(HID_T),   INTENT(IN)  :: type_id
-    INTEGER(HID_T),   INTENT(IN)  :: space_id
-    INTEGER(HID_T),   INTENT(OUT) :: attr
-    INTEGER,          INTENT(OUT) :: hdferr
-
-    INTEGER(HID_T),   INTENT(IN), OPTIONAL :: acpl_id
-    INTEGER(HID_T),   INTENT(IN), OPTIONAL :: aapl_id
-    INTEGER(HID_T),   INTENT(IN), OPTIONAL :: lapl_id
-
- -
- -

h5acreate_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5acreate_f
-
-

PURPOSE

-
  Creates a dataset as an attribute of a group, dataset, or named datatype
-
-

INPUTS

-
  loc_id        - identifier of an object (group, dataset,
-                  or named datatype) attribute is attached to
-  name          - attribute name
-  type_id       - attribute datatype identifier
-  space_id      - attribute dataspace identifier
-
-

OUTPUTS

-
  attr_id       - attribute identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  acpl_id       - Attribute creation property list identifier
-  appl_id       - Attribute access property list identifier
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces are added for
-  called C functions (it is needed for Windows
-  port).  February 27, 2001
-
-

SOURCE

-
  SUBROUTINE h5acreate_f(loc_id, name, type_id, space_id, attr_id, &
-                                 hdferr, acpl_id, aapl_id )
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! Object identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Attribute name
-    INTEGER(HID_T), INTENT(IN) :: type_id  ! Attribute datatype identifier
-    INTEGER(HID_T), INTENT(IN) :: space_id ! Attribute dataspace identifier
-    INTEGER(HID_T), INTENT(OUT) :: attr_id ! Attribute identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code:
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5adelete_by_idx_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5adelete_by_idx_f
-
-

PURPOSE

-
  Deletes an attribute from an object according to index order
-
-

INPUTS

-
  loc_id        - Location or object identifier; may be dataset or group
-  obj_name      - Name of object, relative to location, from which attribute is to be removed
-  idx_type      - Type of index; Possible values are:
-                   H5_INDEX_UNKNOWN_F = -1  - Unknown index type
-                   H5_INDEX_NAME_F          - Index on names
-                   H5_INDEX_CRT_ORDER_F     - Index on creation order
-                   H5_INDEX_N_F             - Number of indices defined
-
-  order         - Order in which to iterate over index; Possible values are:
-                   H5_ITER_UNKNOWN_F    - Unknown order
-                   H5_ITER_INC_F        - Increasing order
-                   H5_ITER_DEC_F        - Decreasing order
-                   H5_ITER_NATIVE_F     - No particular order, whatever is fastest
-                   H5_ITER_N_F          - Number of iteration orders
-
-  n             - Offset within index
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5adelete_by_idx_f(loc_id, obj_name, idx_type, order, n, hdferr, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id      ! Identifer for object to which attribute is attached
-    CHARACTER(LEN=*), INTENT(IN) :: obj_name  ! Name of object, relative to location,
-                                              !  from which attribute is to be removed
-    INTEGER, INTENT(IN) :: idx_type           ! Type of index; Possible values are:
-                                              !    H5_INDEX_UNKNOWN_F   - Unknown index type
-                                              !    H5_INDEX_NAME_F      - Index on names
-                                              !    H5_INDEX_CRT_ORDER_F - Index on creation order
-                                              !    H5_INDEX_N_F       - Number of indices defined
-
-    INTEGER, INTENT(IN) :: order              ! Order in which to iterate over index; Possible values are:
-                                              !    H5_ITER_UNKNOWN_F  - Unknown order
-                                              !    H5_ITER_INC_F      - Increasing order
-                                              !    H5_ITER_DEC_F      - Decreasing order
-                                              !    H5_ITER_NATIVE_F   - No particular order, whatever is fastest
-                                              !    H5_ITER_N_F      - Number of iteration orders
-    INTEGER(HSIZE_T), INTENT(IN) :: n         ! Offset within index
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code:
-                                           ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list
-
- -
- -

h5adelete_by_name_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5adelete_by_name_f
-
-

PURPOSE

-
  Removes an attribute from a specified location
-
-

INPUTS

-
  loc_id        - Identifer for object to which attribute is attached
-  obj_name      - Name of attribute to open
-  attr_name     - Attribute access property list
-  lapl_id       - Link access property list
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5adelete_by_name_f(loc_id, obj_name, attr_name, hdferr, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id      ! Identifer for object to which attribute is attached
-    CHARACTER(LEN=*), INTENT(IN) :: obj_name  ! Name of object, relative to location,
-                                              !  from which attribute is to be removed
-    CHARACTER(LEN=*), INTENT(IN) :: attr_name ! Name of attribute to delete
-    INTEGER, INTENT(OUT) :: hdferr            ! Error code:
-                                              ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list
-
- -
- -

h5adelete_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5adelete_f
-
-

PURPOSE

-
  Deletes an attribute of an object (group, dataset or
-  named datatype)
-
-

INPUTS

-
  obj_id        - object identifier
-  name          - attribute name
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces are added for
-  called C functions (it is needed for Windows
-  port).  February 27, 2001
-
-

SOURCE

-
  SUBROUTINE h5adelete_f(obj_id, name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id  ! Object identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Attribute name
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

H5Aexists_by_name_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  H5Aexists_by_name_f
-
-

PURPOSE

-
  Determines whether an attribute with a given name exists on an object
-
-

INPUTS

-
  loc_id        - Location identifier
-  obj_name      - Object name either relative to loc_id, absolute from the file’s root group, or '.' (a dot)
-  attr_name     - Attribute name
-
-

OUTPUTS

-
  attr_exists   - attribute exists status
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list identifier
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February, 2008
-
-

SOURCE

-
  SUBROUTINE h5aexists_by_name_f(loc_id, obj_name, attr_name, attr_exists, hdferr, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id     ! Location identifier
-    CHARACTER(LEN=*), INTENT(IN) :: obj_name ! Object name either relative to loc_id,
-                                             ! absolute from the file’s root group, or '.'
-    CHARACTER(LEN=*), INTENT(IN) :: attr_name ! Attribute name
-    LOGICAL, INTENT(OUT) :: attr_exists ! .TRUE. if exists, .FALSE. otherwise
-    INTEGER, INTENT(OUT) :: hdferr      ! Error code:
-                                        ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list identifier
-
- -
- -

H5Aexists_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  H5Aexists_f
-
-

PURPOSE

-
  Determines whether an attribute with a given name exists on an object
-
-

INPUTS

-
  obj_id        - Object identifier
-  attr_name     - Attribute name
-
-

OUTPUTS

-
  attr_exists   - attribute exists status
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February, 2008
-
-

SOURCE

-
  SUBROUTINE h5aexists_f(obj_id, attr_name, attr_exists, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id      ! Object identifier
-    CHARACTER(LEN=*), INTENT(IN) :: attr_name ! Attribute name
-    LOGICAL, INTENT(OUT) :: attr_exists  ! .TRUE. if exists, .FALSE. otherwise
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code:
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5aget_create_plist_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aget_create_plist_f
-
-

PURPOSE

-
  Gets an attribute creation property list identifier
-
-

INPUTS

-
  attr_id          - Identifier of the attribute
-
-

OUTPUTS

-
  creation_prop_id - Identifier for the attribute’s creation property
-  hdferr           - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5aget_create_plist_f(attr_id, creation_prop_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: attr_id  ! Identifier of the attribute
-    INTEGER(HID_T), INTENT(OUT) :: creation_prop_id   ! Identifier for the attribute’s creation property
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5aget_info_by_idx_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aget_info_by_idx_f
-
-

PURPOSE

-
  Retrieves attribute information, by attribute index position
-
-

INPUTS

-
  loc_id        - Location of object to which attribute is attached
-  obj_name      - Name of object to which attribute is attached, relative to location
-  idx_type      - Type of index
-  order         - Index traversal order
-  n             - Attribute’s position in index
-
- OUTPUTS  NOTE: In C it is defined as a structure: H5A_info_t
-  corder_valid  - indicates whether the creation order data is valid for this attribute
-  corder        - is a positive integer containing the creation order of the attribute
-  cset          - indicates the character set used for the attribute’s name
-  data_size     - indicates the size, in the number of characters, of the attribute
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5aget_info_by_idx_f(loc_id, obj_name, idx_type, order, n, &
-       f_corder_valid, corder, cset, data_size, hdferr, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id      ! Object identifier
-    CHARACTER(LEN=*), INTENT(IN) :: obj_name  ! Name of object to which attribute is attached
-    INTEGER, INTENT(IN) :: idx_type           ! Type of index; Possible values are:
-                                              !    H5_INDEX_UNKNOWN_F   - Unknown index type
-                                              !    H5_INDEX_NAME_F      - Index on names
-                                              !    H5_INDEX_CRT_ORDER_F - Index on creation order
-                                              !    H5_INDEX_N_F       - Number of indices defined
-    INTEGER, INTENT(IN) :: order              ! Order in which to iterate over index; Possible values are:
-                                              !    H5_ITER_UNKNOWN_F  - Unknown order
-                                              !    H5_ITER_INC_F      - Increasing order
-                                              !    H5_ITER_DEC_F      - Decreasing order
-                                              !    H5_ITER_NATIVE_F   - No particular order, whatever is fastest
-
-    INTEGER(HSIZE_T), INTENT(IN) :: n         ! Attribute’s position in index
-
-
-    LOGICAL, INTENT(OUT) :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute
-    INTEGER, INTENT(OUT) :: corder ! Is a positive integer containing the creation order of the attribute
-    INTEGER, INTENT(OUT) :: cset   ! Indicates the character set used for the attribute’s name
-    INTEGER(HSIZE_T), INTENT(OUT) :: data_size ! Indicates the size, in the number of characters, of the attribute
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code:
-                                         ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id  ! Link access property list
-
- -
- -

h5aget_info_by_name_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aget_info_by_name_f
-
-

PURPOSE

-
  Retrieves attribute information, by attribute name
-
-

INPUTS

-
  loc_id        - Location of object to which attribute is attached
-  obj_name      - Name of object to which attribute is attached, relative to location
-  attr_name     - Attribute name
-
- OUTPUTS  NOTE: In C it is defined as a structure: H5A_info_t
-  corder_valid  - indicates whether the creation order data is valid for this attribute
-  corder        - is a positive integer containing the creation order of the attribute
-  cset          - indicates the character set used for the attribute’s name
-  data_size     - indicates the size, in the number of characters, of the attribute
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5aget_info_by_name_f(loc_id, obj_name, attr_name, &
-       f_corder_valid, corder, cset, data_size, hdferr, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id    ! Object identifier
-    CHARACTER(LEN=*), INTENT(IN) :: obj_name ! Name of object to which attribute is attached
-    CHARACTER(LEN=*), INTENT(IN) :: attr_name ! Attribute name
-
-
-    LOGICAL, INTENT(OUT) :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute
-    INTEGER, INTENT(OUT) :: corder ! Is a positive integer containing the creation order of the attribute
-    INTEGER, INTENT(OUT) :: cset ! Indicates the character set used for the attribute’s name
-    INTEGER(HSIZE_T), INTENT(OUT) :: data_size   ! Indicates the size, in the number of characters, of the attribute
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code:
-                                           ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id  ! Link access property list
-
- -
- -

h5aget_info_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aget_info_f
-
-

PURPOSE

-
  Retrieves attribute information, by attribute identifier
-
-

INPUTS

-
  attr_id       - attribute identifier
-
-

OUTPUTS

-
  NOTE: In C it is defined as a structure: H5A_info_t
-
-  corder_valid  - indicates whether the creation order data is valid for this attribute
-  corder        - is a positive integer containing the creation order of the attribute
-  cset          - indicates the character set used for the attribute’s name
-  data_size     - indicates the size, in the number of characters, of the attribute
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5aget_info_f(attr_id, f_corder_valid, corder, cset, data_size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: attr_id  ! Attribute identifier
-
-    LOGICAL, INTENT(OUT) :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute
-    INTEGER, INTENT(OUT) :: corder ! Is a positive integer containing the creation order of the attribute
-    INTEGER, INTENT(OUT) :: cset   ! Indicates the character set used for the attribute’s name
-    INTEGER(HSIZE_T), INTENT(OUT) :: data_size ! Indicates the size, in the number of characters, of the attribute
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code:
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5aget_name_by_idx_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aget_name_by_idx_f
-
-

PURPOSE

-
  Gets an attribute name, by attribute index position.
-
-

INPUTS

-
  loc_id        - Location of object to which attribute is attached
-  obj_name      - Name of object to which attribute is attached, relative to location
-  idx_type      - Type of index; Possible values are:
-                   H5_INDEX_UNKNOWN_F = -1  - Unknown index type
-                   H5_INDEX_NAME_F          - Index on names
-                   H5_INDEX_CRT_ORDER_F     - Index on creation order
-                   H5_INDEX_N_F             - Number of indices defined
-
-  order         - Order in which to iterate over index; Possible values are:
-                   H5_ITER_UNKNOWN_F    - Unknown order
-                   H5_ITER_INC_F        - Increasing order
-                   H5_ITER_DEC_F        - Decreasing order
-                   H5_ITER_NATIVE_F     - No particular order, whatever is fastest
-                   H5_ITER_N_F          - Number of iteration orders
-  order         - Index traversal order
-  n             - Attribute’s position in index
-
-

OUTPUTS

-
  name          - Attribute name
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list
-  size          - Size, in bytes, of attribute name
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5aget_name_by_idx_f(loc_id, obj_name, idx_type, order, &
-       n, name, hdferr, size, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id      ! Identifer for object to which attribute is attached
-    CHARACTER(LEN=*), INTENT(IN) :: obj_name  ! Name of object, relative to location,
-                                              !  from which attribute is to be removed *TEST* check NULL
-    INTEGER, INTENT(IN) :: idx_type ! Type of index; Possible values are:
-                                    !    H5_INDEX_UNKNOWN_F   - Unknown index type
-                                    !    H5_INDEX_NAME_F       - Index on names
-                                    !    H5_INDEX_CRT_ORDER_F  - Index on creation order
-                                    !    H5_INDEX_N_F         - Number of indices defined
-
-    INTEGER, INTENT(IN) :: order    ! Order in which to iterate over index; Possible values are:
-                                    !    H5_ITER_UNKNOWN_F   - Unknown order
-                                    !    H5_ITER_INC_F      - Increasing order
-                                    !    H5_ITER_DEC_F       - Decreasing order
-                                    !    H5_ITER_NATIVE_F    - No particular order, whatever is fastest
-                                    !    H5_ITER_N_F        - Number of iteration orders
-    INTEGER(HSIZE_T), INTENT(IN) :: n !  Attribute’s position in index
-    CHARACTER(LEN=*), INTENT(OUT) :: name ! Attribute name
-    INTEGER, INTENT(OUT) :: hdferr    ! Error code:
-                                      ! Returns attribute name size,
-                                      ! -1 if fail
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list
-    INTEGER(SIZE_T), OPTIONAL, INTENT(OUT) :: size  ! Indicates the size, in the number of characters, 
-                                                    ! of the attribute
-
- -
- -

h5aget_name_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aget_name_f
-
-

PURPOSE

-
  Gets an attribute name.
-
-

INPUTS

-
  attr_id       - attribute identifier
-  size          - size of a buffer to read name in
-
-

OUTPUTS

-
  buf           - buffer to read name in
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces are added for
-  called C functions (it is needed for Windows
-  port).  February 27, 2001
-
-

SOURCE

-
  SUBROUTINE h5aget_name_f(attr_id, size, buf, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: attr_id  ! Attribute identifier
-    INTEGER(SIZE_T), INTENT(IN) :: size    ! Buffer size
-    CHARACTER(LEN=*), INTENT(INOUT) :: buf ! Buffer to hold attribute name
-    INTEGER, INTENT(OUT) :: hdferr ! Error code:
-                                   ! name length is successful, -1 if fail
-
- -
- -

h5aget_num_attrs_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aget_num_attrs_f
-
-

PURPOSE

-
  Determines the number of attributes attached to an object.
-
-

INPUTS

-
  obj_id        - object (group, dataset, or named datatype)
-  identifier
-
-

OUTPUTS

-
  attr_num      - number of attributes attached to the object
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces are added for
-  called C functions (it is needed for Windows
-  port).  February 27, 2001
-
-

SOURCE

-
  SUBROUTINE h5aget_num_attrs_f(obj_id, attr_num, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id  ! Object identifier
-    INTEGER, INTENT(OUT) :: attr_num      ! Number of attributes of the object
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5aget_space_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aget_space_f
-
-

PURPOSE

-
  Gets a copy of the dataspace for an attribute.
-
-

INPUTS

-
  attr_id       - attribute identifier
-
-

OUTPUTS

-
  space_id      - attribite dataspace identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces are added for
-  called C functions (it is needed for Windows
-  port).  February 27, 2001
-
-

SOURCE

-
  SUBROUTINE h5aget_space_f(attr_id, space_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: attr_id   ! Attribute identifier
-    INTEGER(HID_T), INTENT(OUT) :: space_id ! Attribute dataspace identifier
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5aget_storage_size_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aget_storage_size_f
-
-

PURPOSE

-
  Returns the amount of storage required for an attribute.
-
-

INPUTS

-
  attr_id       - attribute identifier
-
-

OUTPUTS

-
  size          - attribute storage size
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5aget_storage_size_f(attr_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: attr_id  ! Attribute identifier
-    INTEGER(HSIZE_T), INTENT(OUT) :: size  ! Attribute storage requirement
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5aget_type_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aget_type_f
-
-

PURPOSE

-
  Gets an attribute datatype.
-
-

INPUTS

-
  attr_id       - attribute identifier
-
-

OUTPUTS

-
  type_id       - attribute datatype identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces are added for
-  called C functions (it is needed for Windows
-  port).  February 27, 2001
-
-

SOURCE

-
  SUBROUTINE h5aget_type_f(attr_id, type_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: attr_id  ! Attribute identifier
-    INTEGER(HID_T), INTENT(OUT) :: type_id ! Attribute datatype identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5aopen_by_idx_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aopen_by_idx_f
-
-

PURPOSE

-
  Opens an existing attribute that is attached to an object specified by location and name
-
-

INPUTS

-
  loc_id        - Location of object to which attribute is attached
-  obj_name      - Name of object to which attribute is attached, relative to location
-  idx_type      - Type of index
-  order         - Index traversal order
-  n             - Attribute’s position in index
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  aapl_id       - Attribute access property list
-  lapl_id       - Link access property list
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5aopen_by_idx_f(loc_id, obj_name, idx_type, order, n, attr_id, hdferr, aapl_id, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id      ! Object identifier
-    CHARACTER(LEN=*), INTENT(IN) :: obj_name  ! Name of object to which attribute is attached
-    INTEGER, INTENT(IN) :: idx_type           ! Type of index; Possible values are:
-                                              !    H5_INDEX_UNKNOWN_F   - Unknown index type
-                                              !    H5_INDEX_NAME_F      - Index on names
-                                              !    H5_INDEX_CRT_ORDER_F - Index on creation order
-                                              !    H5_INDEX_N_F       - Number of indices defined
-    INTEGER, INTENT(IN) :: order              ! Order in which to iterate over index; Possible values are:
-                                              !    H5_ITER_UNKNOWN_F  - Unknown order
-                                              !    H5_ITER_INC_F      - Increasing order
-                                              !    H5_ITER_DEC_F      - Decreasing order
-                                              !    H5_ITER_NATIVE_F   - No particular order, whatever is fastest
-
-    INTEGER(HSIZE_T), INTENT(IN) :: n       ! Attribute’s position in index
-
-    INTEGER(HID_T), INTENT(OUT) :: attr_id  ! Attribute identifier
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code:
-                                            ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: aapl_id  ! Attribute access property list
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id  ! Link access property list
-
- -
- -

H5Aopen_by_name_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  H5Aopen_by_name_f
-
-

PURPOSE

-
  Opens an attribute for an object by object name and attribute name.
-
-

INPUTS

-
  loc_id        - Location from which to find object to which attribute is attached
-  obj_name      - Object name either relative to loc_id, absolute from the file’s root group, or '.' (a dot)
-  attr_name     - Attribute name
-
-

OUTPUTS

-
  attr_id       - attribute identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  aapl_id       - Attribute access property list (Currently unused; should be passed in as H5P_DEFAULT.)
-  lapl_id       - Link access property list identifier
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February, 2008
-
-

SOURCE

-
  SUBROUTINE h5aopen_by_name_f(loc_id, obj_name, attr_name, attr_id, hdferr, aapl_id, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id    ! Location identifier
-    CHARACTER(LEN=*), INTENT(IN) :: obj_name ! Object name either relative to loc_id,
-                                             ! absolute from the file’s root group, or '.'
-    CHARACTER(LEN=*), INTENT(IN) :: attr_name ! Attribute name
-    INTEGER(HID_T), INTENT(OUT) :: attr_id ! Attribute identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code:
-                                           ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: aapl_id ! Attribute access property list
-                                                    ! (Currently unused; should be passed in as H5P_DEFAULT_F)
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list identifier
-
- -
- -

h5aopen_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aopen_f
-
-

PURPOSE

-
  Opens an attribute for an object specified by object
-  identifier and attribute name
-
-

INPUTS

-
  obj_id        - Identifer for object to which attribute is attached
-  attr_name     - Name of attribute to open
-
-

OUTPUTS

-
  attr_id       - attribute identifier
-
-

OPTIONAL PARAMETERS

-
  aapl_id       - Attribute access property list
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5aopen_f(obj_id, attr_name, attr_id, hdferr, aapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id      ! Object identifier
-    CHARACTER(LEN=*), INTENT(IN) :: attr_name ! Attribute name
-    INTEGER(HID_T), INTENT(OUT) :: attr_id    ! Attribute identifier
-    INTEGER, INTENT(OUT) :: hdferr            ! Error code
-                                              !   Success:  0
-                                              !   Failure: -1
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: aapl_id     ! Attribute access property list
-
- -
- -

h5aopen_idx_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aopen_idx_f
-
-

PURPOSE

-
  Opens the attribute specified by its index.
-
-

INPUTS

-
  obj_id        - identifier of a group, dataset, or named
-                  datatype an attribute to be attached to
-  index         - index of the attribute to open (zero-based)
-
-

OUTPUTS

-
  attr_id       - attribute identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces are added for
-  called C functions (it is needed for Windows
-  port).  February 27, 2001
-
-

SOURCE

-
  SUBROUTINE h5aopen_idx_f(obj_id, index, attr_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id    ! Object identifier
-    INTEGER, INTENT(IN) :: index            ! Attribute index
-    INTEGER(HID_T), INTENT(OUT) :: attr_id  ! Attribute identifier
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5aopen_name_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5aopen_name_f
-
-

PURPOSE

-
  Opens an attribute specified by name.
-
-

INPUTS

-
  obj_id        - identifier of a group, dataset, or named
-                  datatype atttribute to be attached to
-  name          - attribute name
-
-

OUTPUTS

-
  attr_id       - attribute identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces are added for
-  called C functions (it is needed for Windows
-  port).  February 27, 2001
-
-

SOURCE

-
  SUBROUTINE h5aopen_name_f(obj_id, name, attr_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id    ! Object identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name    ! Attribute name
-    INTEGER(HID_T), INTENT(OUT) :: attr_id  ! Attribute identifier
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5arename_by_name_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5arename_by_name_f
-
-

PURPOSE

-
  Renames an attribute
-
-

INPUTS

-
  loc_id        - Location or object identifier; may be dataset or group
-  obj_name      - Name of object, relative to location,
-                  whose attribute is to be renamed
-  old_attr_name - Prior attribute name
-  new_attr_name - New attribute name
-  lapl_id       - Link access property list identifier
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5arename_by_name_f(loc_id, obj_name, old_attr_name, new_attr_name, &
-        hdferr, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id    ! Object identifier
-    CHARACTER(LEN=*), INTENT(IN) :: obj_name  ! Name of object, relative to location,
-                                              !  whose attribute is to be renamed
-    CHARACTER(LEN=*), INTENT(IN) :: old_attr_name ! Prior attribute name
-    CHARACTER(LEN=*), INTENT(IN) :: new_attr_name ! New attribute name
-
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code:
-                                         ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list identifier
-
- -
- -

h5arename_f

- -

[ Top ] [ H5A ] [ Subroutines ]

-

NAME

-
  h5arename_f
-
-

PURPOSE

-
  Renames an attribute
-
-

INPUTS

-
  loc_id        - Location or object identifier; may be dataset or group
-  old_attr_name - Prior attribute name
-  new_attr_name - New attribute name
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

HISTORY

-
  N/A
-
-

SOURCE

-
  SUBROUTINE h5arename_f(loc_id, old_attr_name, new_attr_name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id    ! Object identifier
-    CHARACTER(LEN=*), INTENT(IN) :: old_attr_name ! Prior attribute name
-    CHARACTER(LEN=*), INTENT(IN) :: new_attr_name ! New attribute name
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code:
-                                         ! 0 on success and -1 on failure
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Df_c.html b/fortran/doc/DevelGuide/src/H5Df_c.html deleted file mode 100644 index 1e163f2..0000000 --- a/fortran/doc/DevelGuide/src/H5Df_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Df.c - - - - - -
-
- -

H5Df

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5D Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Dff_F03_f90.html b/fortran/doc/DevelGuide/src/H5Dff_F03_f90.html deleted file mode 100644 index 0bb4173..0000000 --- a/fortran/doc/DevelGuide/src/H5Dff_F03_f90.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - -./src/H5Dff_F03.f90 - - - - - -
-
- -

H5D (F03)

- -

[ Top ] [ Modules ]

-

NAME

-
  H5D_PROVISIONAL
-
-

PURPOSE

-
  This file contains Fortran 90 and Fortran 2003 interfaces for H5D functions.
-  It contains the same functions as H5Dff_DEPRECIATE.f90 but includes the
-  Fortran 2003 functions and the interface listings. This file will be compiled
-  instead of H5Dff_DEPRECIATE.f90 if Fortran 2003 functions are enabled.
-
-

NOTES

-
  (1) The maximum rank of an array allowed in Fortran is 7, therefore
-  we only provide an interface for arrays up to and including rank 7.
-
-  (2) Unfortunately we are using a generic interface and one of the factors
-  used in determining the proper routine to select is that of the array
-  rank being passed. Therefore, we can not create just one subroutine for
-  each array type (integer, real, etc...) and use a
-  rank 1 array of assumed size to handle multiple ranks, i.e.
-  (i.e. integer, dimension(*) :: ... )
-  (i.e. real   , dimension(*) :: ... ) etc...
-
-  (3) Could not place the USE ISO_C_BINDING in the module header because it may
-  conflict with the USE ISO_C_BINDING included in the user's program. Moved
-  the statement instead to each subroutine.
-
-
-  (4) C_LOC and character strings according to the Fortran 2003 standard:
-
-  15.1.2.5 C_LOC(X)
-
-  Argument. X shall either
-
-  (A) have interoperable type and type parameters and be
-  (a) a variable that has the TARGET attribute and is interoperable,
-  (b) an allocated allocatable variable that has the TARGET attribute
-  and is not an array of zero size, or
-  (c) an associated scalar pointer, or
-  (B) be a nonpolymorphic scalar, have no length type parameters, and be
-  (a) a nonallocatable, nonpointer variable that has the TARGET attribute,
-  (b) an allocated allocatable variable that has the TARGET attribute, or
-  (c) an associated pointer.
-
-        - When X is a character, for interoperability the standard is:
-
-  15.2.1 Interoperability of intrinsic types
-
-  ...if the type is character, interoperability also requires that the length type parameter
-  be omitted or be specified by an initialization expression whose value is one.
-
-  THEREFORE compilers that have not extended the standard require the
-  argument in C_LOC to be of the variant:
-
-  CHARACTER(LEN=1), TARGET :: chr
-  or
-  CHARACTER, TARGET :: chr
-  (B)
-                         *** IMPORTANT ***
-  If you add a new H5D function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5dvlen_reclaim

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dvlen_reclaim
-
-

PURPOSE

-
  Reclaims VL datatype memory buffers. 
-
-

INPUTS

-
  type_id  - Identifier of the datatype. 
-  space_id - Identifier of the dataspace. 
-  plist_id - Identifier of the property list used to create the buffer. 
-       buf - Pointer to the buffer to be reclaimed. 
-
-

OUTPUTS

-
  hdferr   - error code
-               Success:  0
-               Failure: -1
-
-

AUTHOR

-
 M. Scot Breitenfeld
- January 11, 2011
-
-

SOURCE

-
  SUBROUTINE H5Dvlen_reclaim_f(type_id, space_id, plist_id, buf, hdferr)
-
-    USE ISO_C_BINDING
-    IMPLICIT NONE
-
-    INTEGER(HID_T), INTENT(IN) :: type_id   ! Identifier of the datatype. 
-    INTEGER(HID_T), INTENT(IN) :: space_id  ! Identifier of the dataspace. 
-    INTEGER(HID_T), INTENT(IN) :: plist_id  ! Identifier of the property list used to create the buffer. 
-    TYPE(C_PTR), INTENT(INOUT) :: buf       ! Pointer to the buffer to be reclaimed. 
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Dff_F90_f90.html b/fortran/doc/DevelGuide/src/H5Dff_F90_f90.html deleted file mode 100644 index afebdd8..0000000 --- a/fortran/doc/DevelGuide/src/H5Dff_F90_f90.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - -./src/H5Dff_F90.f90 - - - - - -
-
- -

H5D (F90)

- -

[ Top ] [ Modules ]

-

NAME

-
  H5D_PROVISIONAL
-
-

PURPOSE

-
  This file contains Fortran 90 interfaces for H5D functions. It contains
-  the same functions as H5Dff_F03.f90 but excludes the Fortran 2003 functions
-  and the interface listings. This file will be compiled instead of H5Dff_F03.f90
-  if Fortran 2003 functions are not enabled.
-
-

NOTES

-
  (1) The maximum rank of an array allowed in Fortran is 7, therefore
-  we only provide an interface for arrays up to and including rank 7.
-
-  (2) Unfortunately we are using a generic interface and one of the factors
-  used in determining the proper routine to select is that of the array
-  rank being passed, therefore we can not create just one subroutine for
-  each array type (integer, real, etc...) of various ranks and then use a
-  rank 1 array of assumed size in the just one subroutine,
-  (i.e. integer, dimension(*) :: ... )
-  (i.e. real   , dimension(*) :: ... ) etc...
-
-  (3)
-                         *** IMPORTANT ***
-  If you add a new H5D function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5dread_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dread_f
-
-

PURPOSE

-
  Reads raw data from the specified dataset into buf,
-  converting from file datatype and dataspace to memory
-  datatype and dataspace.
-
-

INPUTS

-
  dset_id       - dataset identifier
-  mem_type_id   - memory type identifier
-  dims          - 1-dim array of size 7; dims(k) has the size
-                  of k-th dimension of the buf array
-
-

OUTPUTS

-
  buf     - buffer to read data in
-  hdferr: - error code
-             Success:  0
-             Failure: -1
-
-

OPTIONAL PARAMETERS

-
  mem_space_id  - memory dataspace identifier
-  file_space_id - file dataspace identifier
-  xfer_prp      - trasfer property list identifier
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-  dims parameter was added to make code portable;
-  n parameter was replaced with dims parameter in
-  the h5dwrite_reference_obj and h5dwrite_reference_dsetreg
-  functions.  April 2, 2001
-
-

NOTES

-
  This function is overloaded to read INTEGER,
-  REAL, DOUBLE PRECISION and CHARACTER buffers
-  up to 7 dimensions, and one dimensional buffers
-  of the TYPE(hobj_ref_t_f) and TYPE(hdset_reg_ref_t_f) types.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Dff_f90.html b/fortran/doc/DevelGuide/src/H5Dff_f90.html deleted file mode 100644 index 5444a93..0000000 --- a/fortran/doc/DevelGuide/src/H5Dff_f90.html +++ /dev/null @@ -1,506 +0,0 @@ - - - - - - - -./src/H5Dff.f90 - - - - - -
-
- -

H5D

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5D
-
-

FILE

-
  fortran/src/H5Dff.f90
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5D functions. It includes
-  all the functions that are independent on whether the Fortran 2003 functions
-  are enabled or disabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5D function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5dclose_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dclose_f
-
-

PURPOSE

-
  Closes a dataset.
-
-

INPUTS

-
  dset_id       - dataset identifier
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5dclose_f(dset_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5dcreate_anon_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dcreate_anon_f
-
-

PURPOSE

-
  Creates a dataset in a file without linking it into the file structure
-
-

INPUTS

-
  loc_id        - Identifier of the file or group within which to create the dataset.
-  type_id       - Identifier of the datatype to use when creating the dataset.
-  space_id      - Identifier of the dataspace to use when creating the dataset.
-
-

OUTPUTS

-
  dset_id       - dataset identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  dcpl_id       - Dataset creation property list identifier.
-  dapl_id       - Dataset access property list identifier.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 11, 2008
-
-

SOURCE

-
  SUBROUTINE h5dcreate_anon_f(loc_id, type_id, space_id, dset_id, hdferr, dcpl_id, dapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier.
-    INTEGER(HID_T), INTENT(IN) :: type_id  ! Datatype identifier.
-    INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier.
-    INTEGER(HID_T), INTENT(OUT) :: dset_id ! Dataset identifier.
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code.
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: dcpl_id  ! Dataset creation property list identifier.
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: dapl_id  ! Dataset access property list identifier.
-
- -
- -

h5dcreate_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dcreate_f
-
-

PURPOSE

-
  Creates a dataset at the specified location
-
-

INPUTS

-
  loc_id        - file or group identifier
-  name          - dataset name
-  type_id       - dataset datatype identifier
-  space_id      - dataset dataspace identifier
-
-

OUTPUTS

-
  dset_id       - dataset identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  creation_prp  - Dataset creation property list
-  lcpl_id       - Link creation property list
-  dapl_id       - Dataset access property list
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  - Explicit Fortran interfaces were added for
-    called C functions (it is needed for Windows
-    port).  February 28, 2001
-
-  - Added version's 1.8 new optional parameters
-    February, 2008
-
-

SOURCE

-
  SUBROUTINE h5dcreate_f(loc_id, name, type_id, space_id, dset_id, &
-       hdferr, dcpl_id, lcpl_id, dapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the dataset
-    INTEGER(HID_T), INTENT(IN) :: type_id  ! Datatype identifier
-    INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-    INTEGER(HID_T), INTENT(OUT) :: dset_id ! Dataset identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5dget_access_plist_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dget_access_plist_f
-
-

PURPOSE

-
  Returns a copy of the dataset creation property list.
-
-

INPUTS

-
  dset_id       - Dataset identifier
-
-

OUTPUTS

-
  plist_id      - Dataset access property list identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 13, 2009
-
-

SOURCE

-
SUBROUTINE h5dget_access_plist_f(dset_id, plist_id, hdferr)
-  IMPLICIT NONE
-  INTEGER(HID_T), INTENT(IN)  :: dset_id
-  INTEGER(HID_T), INTENT(OUT) :: plist_id 
-  INTEGER       , INTENT(OUT) :: hdferr  
-
- -
- -

h5dget_create_plist_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dget_create_plist_f
-
-

PURPOSE

-
  Returns an identifier for a copy of the dataset creation
-  property list for a dataset.
-
-

INPUTS

-
  dataset_id    - dataset identifier
-
-

OUTPUTS

-
  plist_id      - creation property list identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5dget_create_plist_f(dataset_id, plist_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dataset_id   ! Dataset identifier
-    INTEGER(HID_T), INTENT(OUT) :: plist_id    ! Dataset creation
-                                               ! property list identifier
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-
- -
- -

h5dget_space_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dget_space_f
-
-

PURPOSE

-
  Returns an identifier for a copy of the dataspace for a
-  dataset.
-
-

INPUTS

-
  dataset_id    - dataset identifier
-
-

OUTPUTS

-
  dataspace_id  - dataspace identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5dget_space_f(dataset_id, dataspace_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dataset_id      ! Dataset identifier
-    INTEGER(HID_T), INTENT(OUT) :: dataspace_id   ! Dataspace identifier
-    INTEGER, INTENT(OUT) :: hdferr                ! Error code
-
- -
- -

h5dget_space_status_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dget_space_status_f
-
-

PURPOSE

-
  Returns the status of data space allocation.
-
-

INPUTS

-
  dset_id       - dataset identifier
-
-

OUTPUTS

-
  flag          - status; may have one of the following values:
-                   H5D_SPACE_STS_ERROR_F
-                   H5D_SPACE_STS_NOT_ALLOCATED_F
-                   H5D_SPACE_STS_PART_ALLOCATED_F
-                   H5D_SPACE_STS_ALLOCATED_F
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  March 12, 2003
-
-

SOURCE

-
  SUBROUTINE h5dget_space_status_f(dset_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dset_id  ! Dataspace identifier
-    INTEGER, INTENT(IN)        :: flag     ! Memory buffer to fill in
-    INTEGER, INTENT(OUT)       :: hdferr   ! Error code
-
- -
- -

h5dget_storage_size_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dget_storage_size_f
-
-

PURPOSE

-
  Returns the amount of storage requires by a dataset
-
-

INPUTS

-
  dataset_id    - dataset identifier
-
-

OUTPUTS

-
  size          - datastorage size
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  October 15, 2002
-
-

SOURCE

-
  SUBROUTINE h5dget_storage_size_f(dataset_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dataset_id ! Dataset identifier
-    INTEGER(HSIZE_T),  INTENT(OUT)  :: size  ! Amount of storage
-                                             ! allocated for dataset
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-
- -
- -

h5dget_type_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dget_type_f
-
-

PURPOSE

-
  Returns an identifier for a copy of the datatype for a
-  dataset.
-
-

INPUTS

-
  dataset_id    - dataset identifier
-
-

OUTPUTS

-
  datatype_id   - dataspace identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

NOTES

-

SOURCE

-
  SUBROUTINE h5dget_type_f(dataset_id, datatype_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dataset_id      ! Dataset identifier
-    INTEGER(HID_T), INTENT(OUT) :: datatype_id    ! Datatype identifier
-    INTEGER, INTENT(OUT) :: hdferr                ! Error code
-
- -
- -

h5dopen_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dopen_f
-
-

PURPOSE

-
  Opens an existing dataset.
-
-

INPUTS

-
  loc_id        - file or group identifier
-  name          - dataset name
-
-

OUTPUTS

-
  dset_id       - dataset identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  dapl_id       - Dataset access property list
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  -Explicit Fortran interfaces were added for
-   called C functions (it is needed for Windows
-   port).  February 28, 2001
-
-  -Added 1.8 (optional) parameter dapl_id
-   February, 2008, M. Scot Breitenfeld
-
-

SOURCE

-
  SUBROUTINE h5dopen_f(loc_id, name, dset_id, hdferr, dapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the dataset
-    INTEGER(HID_T), INTENT(OUT) :: dset_id ! Dataset identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: dapl_id ! Dataset access property list
-
- -
- -

h5dset_extent

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dset_extent (instead of obsolete name: h5dextend_f)
-
-

PURPOSE

-
  Extends a dataset with unlimited dimension.
-
-

INPUTS

-
  dataset_id    - dataset identifier
-  size          - array containing the new magnitude of
-                  each dimension
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-  Changed name from the now obsolete h5dextend_f
-  to h5dset_extent_f. Provided interface to old name
-  for backward compatability. -MSB- March 14, 2008
-
-

SOURCE

-
  SUBROUTINE h5dset_extent_f(dataset_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dataset_id      ! Dataset identifier
-    INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN)  :: size
-    ! Array containing
-    ! dimensions' sizes
-    INTEGER, INTENT(OUT) :: hdferr                ! Error code
-
- -
- -

h5dvlen_get_max_len_f

- -

[ Top ] [ H5D ] [ Subroutines ]

-

NAME

-
  h5dvlen_get_max_len_f
-
-

PURPOSE

-
  Returns maximum length of the VL array elements
-
-

INPUTS

-
  dataset_id    - dataset identifier
-  type_id       - datatype identifier
-  space_id      - dataspace identifier
-
-

OUTPUTS

-
  size          - buffer size
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  NONE
-
-

AUTHOR

-
  Elena Pourmal
-  October 15, 2002
-
-

SOURCE

-
  SUBROUTINE h5dvlen_get_max_len_f(dataset_id, type_id, space_id, len,  hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dataset_id      ! Dataset identifier
-    INTEGER(HID_T), INTENT(IN) :: type_id         ! Datatype identifier
-    INTEGER(HID_T), INTENT(IN) :: space_id        ! Dataspace identifier
-    INTEGER(SIZE_T),  INTENT(OUT)  :: len         ! Maximum length of the element
-    INTEGER, INTENT(OUT) :: hdferr                ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Ef_c.html b/fortran/doc/DevelGuide/src/H5Ef_c.html deleted file mode 100644 index 79b7914..0000000 --- a/fortran/doc/DevelGuide/src/H5Ef_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Ef.c - - - - - -
-
- -

H5Ef

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5E Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Eff_f90.html b/fortran/doc/DevelGuide/src/H5Eff_f90.html deleted file mode 100644 index 7eb95e6..0000000 --- a/fortran/doc/DevelGuide/src/H5Eff_f90.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - - -./src/H5Eff.f90 - - - - - -
-
- -

H5E

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5E
-
-

FILE

-
  fortran/src/H5Eff.f90
-
-

PURPOSE

-
  This Module contains Fortran interfaces for H5E functions.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5E function to the module you must add the function name
-  to the Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5eclear_f

- -

[ Top ] [ H5E ] [ Subroutines ]

-

NAME

-
  h5eclear_f
-
-

PURPOSE

-
  Clears the error stack for the current thread.
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  estack_id     - Error Stack id
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  April 6, 2001
-
-  Added optional error stack identifier in order to bring
-  the function in line with the h5eclear2 routine.
-  MSB, July 9, 2009
-
-

SOURCE

-
  SUBROUTINE h5eclear_f(hdferr, estack_id)
-    IMPLICIT NONE
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: estack_id
-
- -
- -

h5eget_major_f

- -

[ Top ] [ H5E ] [ Subroutines ]

-

NAME

-
  h5eget_major_f
-
-

PURPOSE

-
  Returns a character string describing an error specified
-  by a major error number.
-
-

INPUTS

-
  error_no      - major error number
-
-

OUTPUTS

-
  name          - character string describing the error
-  namelen       - number of characters in the name buffer
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  April 6, 2001
-
-

SOURCE

-
  SUBROUTINE h5eget_major_f(error_no, name, namelen, hdferr)
-    INTEGER, INTENT(IN) :: error_no        ! Major error number
-    CHARACTER(LEN=*), INTENT(OUT) :: name  ! Character string describing
-                                           ! the error.
-    INTEGER(SIZE_T), INTENT(IN) :: namelen ! Anticipated number of characters
-                                           ! in name.
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5eget_minor_f

- -

[ Top ] [ H5E ] [ Subroutines ]

-

NAME

-
  h5eget_minor_f
-
-

PURPOSE

-
  Returns a character string describing an error specified
-  by a minor error number.
-
-

INPUTS

-
  error_no      - minor error number
-
-

OUTPUTS

-
  name          - character string describing the error
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  April 6, 2001
-
-

SOURCE

-
  SUBROUTINE h5eget_minor_f(error_no, name, hdferr)
-    INTEGER, INTENT(IN) :: error_no       ! Major error number
-    CHARACTER(LEN=*), INTENT(OUT) :: name ! Character string describing
-                                          ! the error
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5eprint_f

- -

[ Top ] [ H5E ] [ Subroutines ]

-

NAME

-
  h5eprint_f
-
-

PURPOSE

-
  Prints the error stack in a default manner.
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  name          - name of the file that contains print output
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  April 6, 2001
-
-

SOURCE

-
  SUBROUTINE h5eprint_f(hdferr, name)
-    CHARACTER(LEN=*), OPTIONAL, INTENT(IN) :: name ! File name
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5FDmpiof_c.html b/fortran/doc/DevelGuide/src/H5FDmpiof_c.html deleted file mode 100644 index 74143d2..0000000 --- a/fortran/doc/DevelGuide/src/H5FDmpiof_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5FDmpiof.c - - - - - -
-
- -

H5FDmpiof

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for Parallel Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5FDmpioff_f90.html b/fortran/doc/DevelGuide/src/H5FDmpioff_f90.html deleted file mode 100644 index 473b5db..0000000 --- a/fortran/doc/DevelGuide/src/H5FDmpioff_f90.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - - - -./src/H5FDmpioff.f90 - - - - - -
-
- -

H5FDMPIO

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5FDMPIO
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5P functions needed by
-  parallel MPI programs.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5P function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5pget_dxpl_mpio_f

- -

[ Top ] [ H5FDMPIO ] [ Subroutines ]

-

NAME

-
  h5pget_dxpl_mpio_f
-
-

PURPOSE

-
  Returns the data transfer mode.
-
-

INPUTS

-
  prp_id        - data transfer property list identifier
-
-

OUTPUTS

-
  data_xfer_mode- transfer mode; possible values are:
-                     H5FD_MPIO_INDEPENDENT_F
-                     H5FD_MPIO_COLLECTIVE_F
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  November, 2000
-
-

SOURCE

-
  SUBROUTINE h5pget_dxpl_mpio_f(prp_id, data_xfer_mode, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id   ! Property list identifier
-    INTEGER, INTENT(OUT) :: data_xfer_mode ! Data transfer mode. Possible values are:
-                                           ! H5FD_MPIO_INDEPENDENT_F
-                                           ! H5FD_MPIO_COLLECTIVE_F
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5pget_fapl_mpio_f

- -

[ Top ] [ H5FDMPIO ] [ Subroutines ]

-

NAME

-
  h5pget_fapl_mpio_f
-
-

PURPOSE

-
  Returns MPI communicator information.
-
-

INPUTS

-
  prp_id        - file access property list identifier
-
-

OUTPUTS

-
  comm          - MPI-2 communicator
-  info          - MPI-2 info object
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  November, 2000
-
-

SOURCE

-
  SUBROUTINE h5pget_fapl_mpio_f(prp_id, comm, info, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-    INTEGER, INTENT(OUT) :: comm ! buffer to return communicator
-    INTEGER, INTENT(OUT) :: info ! buffer to return info object
-                                 ! as defined in MPI_FILE_OPEN of MPI-2
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-
- -
- -

h5pget_fapl_mpiposix_f

- -

[ Top ] [ H5FDMPIO ] [ Subroutines ]

-

NAME

-
  h5pget_fapl_mpiposix_f
-
-

PURPOSE

-
  Returns MPI communicator information.
-
-

INPUTS

-
  prp_id        - file access property list identifier
-
-

OUTPUTS

-
  comm          - MPI-2 communicator
-  use_gpfs      - flag to use GPFS hints
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  May 6, 2003
-
-

SOURCE

-
  SUBROUTINE h5pget_fapl_mpiposix_f(prp_id, comm, use_gpfs, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-    INTEGER, INTENT(OUT) :: comm         ! Buffer to return communicator
-    LOGICAL, INTENT(OUT) :: use_gpfs
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-
- -
- -

h5pset_dxpl_mpio_f

- -

[ Top ] [ H5FDMPIO ] [ Subroutines ]

-

NAME

-
  h5pset_dxpl_mpio_f
-
-

PURPOSE

-
  Sets data transfer mode.
-
-

INPUTS

-
  prp_id         - data transfer property list identifier
-  data_xfer_mode - transfer mode; possible values are:
-                     H5FD_MPIO_INDEPENDENT_F
-                     H5FD_MPIO_COLLECTIVE_F
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  November, 2000
-
-

SOURCE

-
  SUBROUTINE h5pset_dxpl_mpio_f(prp_id, data_xfer_mode, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
-    INTEGER, INTENT(IN) :: data_xfer_mode ! Data transfer mode. Possible values are:
-                                          ! H5FD_MPIO_INDEPENDENT_F
-                                          ! H5FD_MPIO_COLLECTIVE_F
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pset_fapl_mpio_f

- -

[ Top ] [ H5FDMPIO ] [ Subroutines ]

-

NAME

-
  h5pset_fapl_mpio_f
-
-

PURPOSE

-
  Stores MPI IO communicator information to the file
-  access property list.
-
-

INPUTS

-
  prp_id        - file access property list identifier
-  comm          - MPI-2 communicator
-  info          - MPI-2 info object
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  November, 2000
-
-

SOURCE

-
  SUBROUTINE h5pset_fapl_mpio_f(prp_id, comm, info, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-    INTEGER, INTENT(IN) :: comm ! MPI communicator to be used for file open
-                                ! as defined in MPI_FILE_OPEN of MPI-2
-    INTEGER, INTENT(IN) :: info ! MPI info object to be used for file open
-                                ! as defined in MPI_FILE_OPEN of MPI-2
-    INTEGER, INTENT(OUT) :: hdferr ! Error code
-
- -
- -

h5pset_fapl_mpiposix_f

- -

[ Top ] [ H5FDMPIO ] [ Subroutines ]

-

NAME

-
  h5pset_fapl_mpiposix_f
-
-

PURPOSE

-
  Stores MPI IO communicator information to the file
-  access property list.
-
-

INPUTS

-
  prp_id        - file access property list identifier
-  comm          - MPI-2 communicator
-  use_gpfs      - logical flag to use the GPFS hints
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  May 6, 2003
-
-

SOURCE

-
  SUBROUTINE h5pset_fapl_mpiposix_f(prp_id, comm, use_gpfs, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-    INTEGER, INTENT(IN) :: comm ! MPI communicator to be used for file open
-                                ! as defined in MPI_FILE_OPEN of MPI-2
-    LOGICAL, INTENT(IN) :: use_gpfs
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Ff_c.html b/fortran/doc/DevelGuide/src/H5Ff_c.html deleted file mode 100644 index c91a62d..0000000 --- a/fortran/doc/DevelGuide/src/H5Ff_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Ff.c - - - - - -
-
- -

H5Ff

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5F Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Fff_f90.html b/fortran/doc/DevelGuide/src/H5Fff_f90.html deleted file mode 100644 index b0164c9..0000000 --- a/fortran/doc/DevelGuide/src/H5Fff_f90.html +++ /dev/null @@ -1,653 +0,0 @@ - - - - - - - -./src/H5Fff.f90 - - - - - -
-
- -

H5F

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5F
-
-

FILE

-
  H5Fff.f90
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5F functions.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5F function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5fclose_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fclose_f
-
-

PURPOSE

-
  Closes HDF5 file.
-
-

INPUTS

-
  file_id       - file identifier
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5fclose_f(file_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5fcreate_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fcreate_f
-
-

PURPOSE

-
  Creates HDF5 files.
-
-

INPUTS

-
  name          - name of the file to create
-  access_flags  - File access flags. Allowable values are:
-                   H5F_ACC_TRUNC_F
-                   H5F_ACC_EXCL_F
-
-

OUTPUTS

-
  file_id       - file identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  creation_prp  - file creation property list identifier
-  access_prp    - file access property list identifier
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5fcreate_f(name, access_flags, file_id, hdferr, &
-       creation_prp, access_prp)
-    IMPLICIT NONE
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the file
-    INTEGER, INTENT(IN) :: access_flags    ! File access flags
-    INTEGER(HID_T), INTENT(OUT) :: file_id ! File identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: creation_prp
-                                           ! File creation propertly
-                                           ! list identifier
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: access_prp
-                                           ! File access property list
-                                           ! identifier
-
- -
- -

h5fflush_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fflush_f
-
-

PURPOSE

-
  Flushes all buffers associated WITH a file to disk
-
-

INPUTS

-
  object_id     - identifier of object used to identify the file.
-  scope         - specifies the scope of the flushing action.
-                  Possible values are:
-                    H5F_SCOPE_GLOBAL_F
-                    H5F_SCOPE_LOCAL_F
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  creation_prp  - file creation property list identifier
-  access_prp    - file access property list identifier
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5fflush_f(object_id, scope, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: object_id !identifier for any object
-                                            !associate with a file,
-                                            !including the file itself,
-                                            !a dataset, a group, an
-                                            !attribute, or a named
-                                            !data type
-
-    INTEGER, INTENT(IN) :: scope            !scope of the flushing
-                                            !action, possible values
-                                            !are: H5F_SCOPE_GLOBAL_F
-                                            ! which flushes the entire
-                                            !virtual file,
-                                            !and H5F_SCOPE_LOCAL_F
-                                            !which flushes only the
-                                            !specified file.
-
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5fget_access_plist_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fget_access_plist_f
-
-

PURPOSE

-
  Returns a file access property list identifier.
-
-

INPUTS

-
  file_id       - identifier of a file to creation property list of
-
-

OUTPUTS

-
  access_id     - access property list identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5fget_access_plist_f(file_id, access_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: file_id      ! File identifier
-    INTEGER(HID_T), INTENT(OUT) :: access_id   ! File access property
-                                               ! list identifier
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-
- -
- -

h5fget_create_plist_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fget_create_plist_f
-
-

PURPOSE

-
  Returns a file creation property list identifier.
-
-

INPUTS

-
  file_id       - identifier of a file to creation property list of
-
-

OUTPUTS

-
  prop_id       - creation property list identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5fget_create_plist_f(file_id, prop_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: file_id    ! File identifier
-    INTEGER(HID_T), INTENT(OUT) :: prop_id   ! File creation property
-                                             ! list identifier
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-
- -
- -

h5fget_filesize_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fget_filesize_f
-
-

PURPOSE

-
  Retrieves the file size of the HDF5 file.
-
-

INPUTS

-
  file_id       - file identifier
-
-

OUTPUTS

-
  size          - file size
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  July 7, 2004
-
-

SOURCE

-
  SUBROUTINE h5fget_filesize_f(file_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: file_id  ! file identifier
-    INTEGER(HSIZE_T), INTENT(OUT) :: size  ! Size of the file
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code: 0 on success,
-                                           !     -1 if fail
-
- -
- -

h5fget_freespace_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fget_freespace_f
-
-

PURPOSE

-
  Get amount of free space within a file
-
-

INPUTS

-
  file_id       - file identifier
-
-

OUTPUTS

-
  free_space    - amount of free space in file
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Quincey Koziol
-  October 7, 2003
-
-

SOURCE

-
  SUBROUTINE h5fget_freespace_f(file_id, free_space, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
-    INTEGER(HSSIZE_T), INTENT(OUT) :: free_space
-                                          ! amount of free space in file
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5fget_name_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fget_name_f
-
-

PURPOSE

-
  Gets the name of the file from the object identifier
-
-

INPUTS

-
  obj_id        - object identifier
-
-

OUTPUTS

-
  buf           - buffer to store the read name
-  size          - actual size of the name
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  July 6, 2004
-
-

SOURCE

-
  SUBROUTINE h5fget_name_f(obj_id, buf, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id   ! Object identifier
-    CHARACTER(LEN=*), INTENT(INOUT) :: buf
-                                           ! Buffer to hold file name
-    INTEGER(SIZE_T), INTENT(OUT) :: size   ! Size of the file name
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code: 0 on success,
-                                           !     -1 if fail
-
- -
- -

h5fget_obj_count_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fget_obj_count_f
-
-

PURPOSE

-
  Gets number of the objects open within a file
-
-

INPUTS

-
  file_id       - file identifier
-  obj_type      - type of the object; possible values are:
-                    H5F_OBJ_FILE_F
-                    H5F_OBJ_DATASET_F
-                    H5F_OBJ_GROUP_F
-                    H5F_OBJ_DATATYPE_F
-                    H5F_OBJ_ALL_F
-
-

OUTPUTS

-
  obj_count     - number of open objects
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  September 30, 2002
-
-

HISTORY

-
  Changed the type of obj_count to INTEGER(SIZE_T)
-  September 25, 2008 EIP
-
-

SOURCE

-
  SUBROUTINE h5fget_obj_count_f(file_id, obj_type, obj_count, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
-    INTEGER, INTENT(IN)  :: obj_type      ! Object type
-    INTEGER(SIZE_T), INTENT(OUT) :: obj_count
-                                          ! Number of open objects
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5fget_obj_ids_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fget_obj_ids_f
-
-

PURPOSE

-
  Get list of open objects identifiers within a file
-
-

INPUTS

-
  file_id       - file identifier
-  obj_type      - type of the object; possible values are:
-                    H5F_OBJ_FILE_F
-                    H5F_OBJ_DATASET_F
-                    H5F_OBJ_GROUP_F
-                    H5F_OBJ_DATATYPE_F
-                    H5F_OBJ_ALL_F
-
-

OUTPUTS

-
  obj_ids       - array of open object identifiers
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  num_objs      - number of open objects
-
-

AUTHOR

-
  Elena Pourmal
-  September 30, 2002
-
-

HISTORY

-
  Added optional parameter num_objs for number of open objects
-  of the specified type and changed type of max_obj to
-  INTEGER(SIZE_T)
-  September 25, 2008 EIP
-
-

SOURCE

-
  SUBROUTINE h5fget_obj_ids_f(file_id, obj_type, max_objs, obj_ids, hdferr, num_objs)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: file_id      ! File identifier
-    INTEGER, INTENT(IN)  :: obj_type           ! Object type
-    INTEGER(SIZE_T), INTENT(IN)  :: max_objs   ! Maximum # of objects to retrieve
-    INTEGER(HID_T), DIMENSION(*), INTENT(INOUT) :: obj_ids
-                                               ! Array of open objects iidentifiers
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-    INTEGER(SIZE_T), INTENT(OUT), OPTIONAL :: num_objs ! number of open objects
-
- -
- -

h5fis_hdf5_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fis_hdf5_f
-
-

PURPOSE

-
  Determines whether a file is in the HDF5 format.
-
-

INPUTS

-
  name          - name of the file to check
-
-

OUTPUTS

-
  status        - indicates if file is and HDF5 file
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5fis_hdf5_f(name, status, hdferr)
-    IMPLICIT NONE
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the file
-    LOGICAL, INTENT(OUT) :: status         ! Indicates if file
-                                           ! is an HDF5 file
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5fmount_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fmount_f
-
-

PURPOSE

-
  Mounts a file.
-
-

INPUTS

-
  loc_id        - the identifier for of file or group in
-                  which name is defined
-  name          - the name of the group onto which the file
-                  specified by child_id is to be mounted.
-  child_id      - the identifier of the file to be mounted.
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  access_prp    - the identifier of the property list to be used
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5fmount_f(loc_id, name, child_id, hdferr, access_prp)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! Identifier for file or group
-                                           ! in which dsetname is defined
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group
-    INTEGER(HID_T), INTENT(IN) :: child_id ! File identifier for the
-                                           ! file to be mounted
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: access_prp
-                                           ! File access property list
-                                           ! identifier
-
- -
- -

h5fopen_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5fopen_f
-
-

PURPOSE

-
  Opens HDF5 file.
-
-

INPUTS

-
  name          - name of the file to acecss
-  access_flags  - File access flags. Allowable values are:
-                   H5F_ACC_RDWR_F
-                   H5F_ACC_RDONLY_F
-
-

OUTPUTS

-
  file_id       - file identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  access_prp    - file access property list identifier
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5fopen_f(name, access_flags, file_id, hdferr, access_prp)
-    IMPLICIT NONE
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the file
-    INTEGER, INTENT(IN) :: access_flags    ! File access flags
-    INTEGER(HID_T), INTENT(OUT) :: file_id ! File identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: access_prp
-                                           ! File access property list
-                                           ! identifier
-
- -
- -

h5freopen_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5freopen_f
-
-

PURPOSE

-
  Reopens HDF5 file.
-
-

INPUTS

-
  file_id       - identifier of a file for which an
-                  additional identifier is required
-
-

OUTPUTS

-
  ret_file_id   - new file identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5freopen_f(file_id, ret_file_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: file_id      ! File identifier
-    INTEGER(HID_T), INTENT(OUT) :: ret_file_id ! New File identifier
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-
- -
- -

h5funmount_f

- -

[ Top ] [ H5F ] [ Subroutines ]

-

NAME

-
  h5funmount_f
-
-

PURPOSE

-
  Unmounts a file.
-
-

INPUTS

-
  loc_id        - the identifier for of file or group in
-                  which name is defined
-  name          - the name of the mount point
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5funmount_f(loc_id, name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! Identifier for file or group
-                                           ! at which the specified file
-                                           ! is to be unmounted
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the mount point
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Gf_c.html b/fortran/doc/DevelGuide/src/H5Gf_c.html deleted file mode 100644 index a71f0e8..0000000 --- a/fortran/doc/DevelGuide/src/H5Gf_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Gf.c - - - - - -
-
- -

H5Gf

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5G Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Gff_f90.html b/fortran/doc/DevelGuide/src/H5Gff_f90.html deleted file mode 100644 index 74ec2f4..0000000 --- a/fortran/doc/DevelGuide/src/H5Gff_f90.html +++ /dev/null @@ -1,840 +0,0 @@ - - - - - - - -./src/H5Gff.f90 - - - - - -
-
- -

H5G

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5G
-
-

FILE

-
  fortran/src/H5Gff.f90
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5G functions.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5G function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5gclose_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gclose_f
-
-

PURPOSE

-
  Closes the specified group.
-
-

INPUTS

-
  grp_id        - group identifier
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-

SOURCE

-
  SUBROUTINE h5gclose_f(grp_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: grp_id  ! Group identifier
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

H5Gcreate_anon_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  H5Gcreate_anon_f
-
-

PURPOSE

-
  Creates a new empty group without linking it into the file structure.
-
-

INPUTS

-
  loc_id        - Location identifier
-
-

OUTPUTS

-
  grp_id        - group identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  gcpl_id       - Group creation property list identifier
-  gapl_id       - Group access property list identifier
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 15, 2008
-
-

SOURCE

-
  SUBROUTINE h5Gcreate_anon_f(loc_id, grp_id, hdferr, gcpl_id, gapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-    INTEGER(HID_T), INTENT(OUT) :: grp_id  ! Group identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gcpl_id  ! Property list for group creation
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gapl_id  ! Property list for group access
-
- -
- -

h5gcreate_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gcreate_f
-
-

PURPOSE

-
  Creates a new group.
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - group name at the specified location
-
-

OUTPUTS

-
  grp_id        - group identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  size_hint     - a parameter indicating the number of bytes to
-                  reserve for the names that will appear in the group
-  lcpl_id       - Property list for link creation
-  gcpl_id       - Property list for group creation
-  gapl_id       - Property list for group access
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-  Added additional optional paramaters in 1.8
-  MSB - February 27, 2008
-
-

SOURCE

-
  SUBROUTINE h5gcreate_f(loc_id, name, grp_id, hdferr, size_hint, lcpl_id, gcpl_id, gapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group
-    INTEGER(HID_T), INTENT(OUT) :: grp_id  ! Group identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-    INTEGER(SIZE_T), OPTIONAL, INTENT(IN) :: size_hint
-                                           ! Parameter indicating
-                                           ! the number of bytes
-                                           ! to reserve for the
-                                           ! names that will appear
-                                           ! in the group. Set to OBJECT_NAMELEN_DEFAULT_F
-                                           ! if using any of the optional
-                                           ! parameters lcpl_id, gcpl_id, and/or gapl_id when not
-                                           ! using keywords in specifying the optional parameters
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id  ! Property list for link creation
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gcpl_id  ! Property list for group creation
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gapl_id  ! Property list for group access
-
- -
- -

h5gget_comment_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gget_comment_f
-
-

PURPOSE

-
  Retrieves comment for specified object.
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - name of the object at specified location
-  size          - size of the buffer required to hold comment
-
-

OUTPUTS

-
  buffer        - buffer to hold object's comment
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-

SOURCE

-
  SUBROUTINE h5gget_comment_f(loc_id, name, size, buffer, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Current name of an object
-    INTEGER(SIZE_T), INTENT(IN) :: size    ! Maximum number of buffer
-    CHARACTER(LEN=size), INTENT(OUT) :: buffer
-                                           ! Buffer to hold a comment
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

H5Gget_create_plist_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  H5Gget_create_plist_f
-
-

PURPOSE

-
  Gets a group creation property list identifier.
-
-

INPUTS

-
  grp_id        - group identifier
-
-

OUTPUTS

-
  gcpl_id       - Group creation property list identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 15, 2008
-
-

SOURCE

-
  SUBROUTINE h5gget_create_plist_f(grp_id, gcpl_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN)  :: grp_id  ! Group identifier
-    INTEGER(HID_T), INTENT(OUT) :: gcpl_id ! Property list for group creation
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5gget_info_by_idx_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gget_info_by_idx_f
-
-

PURPOSE

-
  Retrieves information about a group, according to the group’s position within an index.
-
-

INPUTS

-
  loc_id        - File or group identifier
-  group_name    - Name of group containing group for which information is to be retrieved
-  index_type    - Index type
-  order         - Order of the count in the index
-  n             - Position in the index of the group for which information is retrieved
-
-

OUTPUTS

-
  storage_type  - Type of storage for links in group
-                    H5G_STORAGE_TYPE_COMPACT: Compact storage
-                    H5G_STORAGE_TYPE_DENSE: Indexed storage
-                    H5G_STORAGE_TYPE_SYMBOL_TABLE: Symbol tables, the original HDF5 structure
-  nlinks        - Number of links in group
-  max_corder    - Current maximum creation order value for group
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list
-  mounted       - Whether group has a file mounted on it
-
-

NOTES

-
  In C the output is defined as a structure: H5G_info_t
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 18, 2008
-
-

HISTORY

-
  Added 'mounted' paramater
-  M. Scot Breitenfeld
-  July 16, 2008
-
-

SOURCE

-
  SUBROUTINE h5gget_info_by_idx_f(loc_id, group_name, index_type, order, n, &
-       storage_type, nlinks, max_corder, hdferr, lapl_id, mounted)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id       ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: group_name ! Name of group containing group for which information is to be retrieved
-    INTEGER, INTENT(IN) :: index_type ! Index type
-    INTEGER, INTENT(IN) :: order      ! Order of the count in the index
-    INTEGER(HSIZE_T), INTENT(IN) :: n ! Position in the index of the group for which information is retrieved
-
-    INTEGER, INTENT(OUT) :: storage_type ! Type of storage for links in group:
-                                         !   H5G_STORAGE_TYPE_COMPACT_F: Compact storage
-                                         !   H5G_STORAGE_TYPE_DENSE_F: Indexed storage
-                                         !   H5G_STORAGE_TYPE_SYMBOL_TABLE_F: Symbol tables, the original HDF5 structure
-    INTEGER, INTENT(OUT) :: nlinks      ! Number of links in group
-    INTEGER, INTENT(OUT) :: max_corder  ! Current maximum creation order value for group
-    INTEGER, INTENT(OUT) :: hdferr      ! Error code:
-                                        ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list
-    LOGICAL, INTENT(OUT), OPTIONAL :: mounted       ! Whether group has a file mounted on it
-
- -
- -

h5gget_info_by_name_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gget_info_by_name_f
-
-

PURPOSE

-
  Retrieves information about a group.
-
-

INPUTS

-
  loc_id        - File or group identifier
-  group_name    - Name of group containing group for which information is to be retrieved
-
-

OUTPUTS

-
  storage_type  - Type of storage for links in group
-                    H5G_STORAGE_TYPE_COMPACT: Compact storage
-                    H5G_STORAGE_TYPE_DENSE: Indexed storage
-                    H5G_STORAGE_TYPE_SYMBOL_TABLE: Symbol tables, the original HDF5 structure
-  nlinks        - Number of links in group
-  max_corder    - Current maximum creation order value for group
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list
-  mounted       - Whether group has a file mounted on it
-
-

NOTES

-
  In C the output is defined as a structure: H5G_info_t
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 18, 2008
-
-

HISTORY

-
  Added 'mounted' paramater
-  M. Scot Breitenfeld
-  July 16, 2008
-
-

SOURCE

-
  SUBROUTINE h5gget_info_by_name_f(loc_id, group_name, &
-       storage_type, nlinks, max_corder, hdferr, lapl_id, mounted)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id       ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: group_name ! Name of group containing group for which information is to be retrieved
-
-    INTEGER, INTENT(OUT) :: storage_type  ! Type of storage for links in group:
-                                          ! H5G_STORAGE_TYPE_COMPACT_F: Compact storage
-                                          ! H5G_STORAGE_TYPE_DENSE_F: Indexed storage
-                                          ! H5G_STORAGE_TYPE_SYMBOL_TABLE_F: Symbol tables, the original HDF5 structure
-    INTEGER, INTENT(OUT) :: nlinks        ! Number of links in group
-    INTEGER, INTENT(OUT) :: max_corder    ! Current maximum creation order value for group
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code:
-                                          !   0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list
-    LOGICAL, INTENT(OUT), OPTIONAL :: mounted       ! Whether group has a file mounted on it
-
- -
- -

h5gget_info_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gget_info_f
-
-

PURPOSE

-
  Retrieves information about a group
-
-

INPUTS

-
  group_id      - Group identifier
-
-

OUTPUTS

-
  storage_type  - Type of storage for links in group
-                    H5G_STORAGE_TYPE_COMPACT: Compact storage
-                    H5G_STORAGE_TYPE_DENSE: Indexed storage
-                    H5G_STORAGE_TYPE_SYMBOL_TABLE: Symbol tables, the original HDF5 structure
-  nlinks        - Number of links in group
-  max_corder    - Current maximum creation order value for group
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  mounted       - Whether group has a file mounted on it
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 15, 2008
-
-

NOTES

-
  In C the output is defined as a structure: H5G_info_t
-
-

HISTORY

-
  - Added 'mounted' paramater
-    M. Scot Breitenfeld
-    July 16, 2008
-
-

SOURCE

-
  SUBROUTINE h5gget_info_f(group_id, storage_type, nlinks, max_corder, hdferr, mounted)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: group_id ! Group identifier
-
-    INTEGER, INTENT(OUT) :: storage_type  ! Type of storage for links in group:
-                                          ! H5G_STORAGE_TYPE_COMPACT_F: Compact storage
-                                          ! H5G_STORAGE_TYPE_DENSE_F: Indexed storage
-                                          ! H5G_STORAGE_TYPE_SYMBOL_TABLE_F: Symbol tables, the original HDF5 structure
-    INTEGER, INTENT(OUT) :: nlinks        ! Number of links in group
-    INTEGER, INTENT(OUT) :: max_corder    ! Current maximum creation order value for group
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code:
-                                          ! 0 on success and -1 on failure
-    LOGICAL, INTENT(OUT), OPTIONAL :: mounted  ! Whether group has a file mounted on it
-
- -
- -

h5gget_linkval_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gget_linkval_f
-
-

PURPOSE

-
  Returns the name of the object that the symbolic link
-  points to.
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - symbolic link to the object whose name
-                  is to be returned.
-  size          - maximum number of characters to be returned
-
-

OUTPUTS

-
  buffer        - a buffer to hold the name of the object
-  being sought
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-

SOURCE

-
  SUBROUTINE h5gget_linkval_f(loc_id, name, size, buffer, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Current name of an object
-    INTEGER(SIZE_T), INTENT(IN) :: size    ! Maximum number of buffer
-    CHARACTER(LEN=size), INTENT(OUT) :: buffer
-                                           ! Buffer to hold a name of
-                                           ! the object symbolic link
-                                           ! points to
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5gget_obj_info_idx_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gget_obj_info_idx_f
-
-

PURPOSE

-
  Returns name and type of the group member identified by
-  its index.
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - name of the group at the specified location
-  idx           - object index (zero-based)
-
-

OUTPUTS

-
  obj_name      - object name
-  obj_type      - object type
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-

SOURCE

-
  SUBROUTINE h5gget_obj_info_idx_f(loc_id, name, idx, &
-       obj_name, obj_type, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group
-    INTEGER, INTENT(IN) :: idx             ! Index of member object
-    CHARACTER(LEN=*), INTENT(OUT) :: obj_name   ! Name of the object
-    INTEGER, INTENT(OUT) :: obj_type       ! Object type
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5glink2_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5glink2_f
-
-

PURPOSE

-
  Creates a link of the specified type from new_name
-  to current_name. current_name and new_name are interpreted
-  releative to current and new location identifiers.
-
-

INPUTS

-
  cur_loc_id    - location identifier
-  cur_name      - name of the existing object if link is a
-                  hard link. Can be anything for the soft link.
-  link_type     - link type; possible values are:
-                    H5G_LINK_HARD_F (0)
-                    H5G_LINK_SOFT_F (1)
-  new_loc_id    - new location identifier
-  new_name      - new name for the object
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  September 25, 2002
-
-

SOURCE

-
  SUBROUTINE h5glink2_f(cur_loc_id, cur_name, link_type, new_loc_id, &
-       new_name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: cur_loc_id ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: cur_name
-                                             ! Current name of an object
-    INTEGER, INTENT(IN) :: link_type         ! link type
-                                                 ! Possible values are:
-                                                 ! H5G_LINK_HARD_F (0) or
-                                                 ! H5G_LINK_SOFT_F (1)
-
-    INTEGER(HID_T), INTENT(IN) :: new_loc_id ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: new_name ! New name of an object
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-
- -
- -

h5glink_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5glink_f
-
-

PURPOSE

-
  Creates a link of the specified type from new_name
-  to current_name.
-
-

INPUTS

-
  loc_id        - location identifier
-  link_type     - link type; possible values are:
-                    H5G_LINK_HARD_F (0)
-                    H5G_LINK_SOFT_F (1)
-  current_name  - name of the existing object if link is a
-                  hard link. Can be anything for the soft link
-  new_name      - new name for the object
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-

SOURCE

-
  SUBROUTINE h5glink_f(loc_id, link_type, current_name, &
-       new_name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-    INTEGER, INTENT(IN) :: link_type       ! link type
-                                                   ! Possible values are:
-                                                   ! H5G_LINK_HARD_F (0) or
-                                                   ! H5G_LINK_SOFT_F (1)
-
-    CHARACTER(LEN=*), INTENT(IN) :: current_name
-                                                   ! Current name of an object
-    CHARACTER(LEN=*), INTENT(IN) :: new_name ! New name of an object
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5gmove2_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gmove2_f
-
-

PURPOSE

-
  Renames an object within an HDF5 file.
-
-

INPUTS

-
  src_loc_id    - original location identifier
-  src_name      - object's name at specified original location
-  dst_loc_id    - original location identifier
-  dst_name      - object's new name
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  September 25, 2002
-
-

SOURCE

-
  SUBROUTINE h5gmove2_f(src_loc_id, src_name, dst_loc_id, dst_name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN)   :: src_loc_id  ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: src_name    ! Original name of an object
-    INTEGER(HID_T), INTENT(IN)   :: dst_loc_id  ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: dst_name    ! New name of an object
-    INTEGER, INTENT(OUT)         :: hdferr      ! Error code
-
- -
- -

h5gmove_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gmove_f
-
-

PURPOSE

-
  Renames an object within an HDF5 file.
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - object's name at specified location
-  new_name      - object's new name
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-

SOURCE

-
  SUBROUTINE h5gmove_f(loc_id, name, new_name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id     ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name     ! Current name of an object
-    CHARACTER(LEN=*), INTENT(IN) :: new_name ! New name of an object
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-
- -
- -

h5gn_members_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gn_members_f
-
-

PURPOSE

-
  Returns the number of group members.
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - name of the group at the specified location
-
-

OUTPUTS

-
  nmembers      - number of group members
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-

SOURCE

-
  SUBROUTINE h5gn_members_f(loc_id, name, nmembers, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-            CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group
-            INTEGER, INTENT(OUT) :: nmembers       ! Number of members in the
-                                                   ! group
-            INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5gopen_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gopen_f
-
-

PURPOSE

-
  Opens an existing group.
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - name of the group to open
-
-

OUTPUTS

-
  grp_id        - group identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  gapl_id       - Group access property list identifier
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-  Added 1.8 (optional) parameter gapl_id
-  February, 2008 M. Scot Breitenfeld
-
-

SOURCE

-
  SUBROUTINE h5gopen_f(loc_id, name, grp_id, hdferr, gapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the group
-    INTEGER(HID_T), INTENT(OUT) :: grp_id  ! File identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gapl_id  ! Group access property list identifier
-
- -
- -

h5gset_comment_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gset_comment_f
-
-

PURPOSE

-
  Sets comment for specified object.
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - name of the object
-  comment       - comment to set for the object
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-

SOURCE

-
  SUBROUTINE h5gset_comment_f(loc_id, name, comment, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Current name of an object
-    CHARACTER(LEN=*), INTENT(IN) :: comment ! New name of an object
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5gunlink_f

- -

[ Top ] [ H5G ] [ Subroutines ]

-

NAME

-
  h5gunlink_f
-
-

PURPOSE

-
  Removes the specified name from the group graph and
-  decrements the link count for the object to which name
-  points
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - name of the object to unlink
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-

SOURCE

-
  SUBROUTINE h5gunlink_f(loc_id, name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of an object
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5If_c.html b/fortran/doc/DevelGuide/src/H5If_c.html deleted file mode 100644 index 8dccce7..0000000 --- a/fortran/doc/DevelGuide/src/H5If_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5If.c - - - - - -
-
- -

H5If

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5I Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Iff_f90.html b/fortran/doc/DevelGuide/src/H5Iff_f90.html deleted file mode 100644 index 5987581..0000000 --- a/fortran/doc/DevelGuide/src/H5Iff_f90.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - -./src/H5Iff.f90 - - - - - -
-
- -

H5I

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5I
-
-

FILE

-
  fortran/src/H5Iff.f90
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5I functions.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5I function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5idec_ref_f

- -

[ Top ] [ H5I ] [ Subroutines ]

-

NAME

-
  h5idec_ref_f
-
-

PURPOSE

-
  Decrements the reference count of an ID
-
-

INPUTS

-
  obj_id        - Object identifier
-
-

OUTPUTS

-
  ref_count     - Current reference count of the ID
-  hdferr:       - Error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Quincey Koziol
-  December  9, 2003
-
-

SOURCE

-
  SUBROUTINE h5idec_ref_f(obj_id, ref_count, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
-    INTEGER, INTENT(OUT) :: ref_count    ! Current reference count of ID
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-
- -
- -

h5iget_file_id_f

- -

[ Top ] [ H5I ] [ Subroutines ]

-

NAME

-
  h5iget_file_id_f
-
-

PURPOSE

-
  Obtains file identifier from the object identifier
-
-

INPUTS

-
  obj_id        - object identifier
-
-

OUTPUTS

-
  file_id       - file identifier
-  hdferr:       - error code
-                    Success:  0
-                    Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 23, 2004
-
-

SOURCE

-
  SUBROUTINE h5iget_file_id_f(obj_id, file_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN)  :: obj_id   ! Object identifier
-    INTEGER(HID_T), INTENT(OUT) :: file_id  ! File identifier
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5iget_name_f

- -

[ Top ] [ H5I ] [ Subroutines ]

-

NAME

-
  h5iget_name_f
-
-

PURPOSE

-
  Gets a name of an object specified by its idetifier.
-
-

INPUTS

-
  obj_id    - attribute identifier
-  buf_size  - size of a buffer to read name in
-
-

OUTPUTS

-
  buf       - buffer to read name in, name will be truncated if
-              buffer is not big enough
-  name_size - name size
-  hdferr:   - error code
-               Success:  0
-               Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  March 12, 2003
-
-

SOURCE

-
  SUBROUTINE h5iget_name_f(obj_id, buf, buf_size, name_size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id      ! Object identifier
-    INTEGER(SIZE_T), INTENT(IN) :: buf_size   ! Buffer size
-    CHARACTER(LEN=*), INTENT(OUT) :: buf      ! Buffer to hold object name
-    INTEGER(SIZE_T), INTENT(OUT) :: name_size ! Actual name size
-    INTEGER, INTENT(OUT) :: hdferr            ! Error code:
-                                              !   0 if successful,
-                                              !   -1 if fail
-
- -
- -

h5iget_ref_f

- -

[ Top ] [ H5I ] [ Subroutines ]

-

NAME

-
  h5iget_ref_f
-
-

PURPOSE

-
  Retrieves the reference count of an ID
-
-

INPUTS

-
  obj_id        - object identifier
-
-

OUTPUTS

-
  ref_count     - Current reference count of the ID
-  hdferr:         - error code
-  Success:  0
-  Failure: -1
-
-

AUTHOR

-
  Quincey Koziol
-  December  9, 2003
-
-

SOURCE

-
  SUBROUTINE h5iget_ref_f(obj_id, ref_count, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
-    INTEGER, INTENT(OUT) :: ref_count    ! Current reference count of ID
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-
- -
- -

h5iget_type_f

- -

[ Top ] [ H5I ] [ Subroutines ]

-

NAME

-
  h5iget_type_f
-
-

PURPOSE

-
  Retrieves the type of an object.
-
-

INPUTS

-
  obj_id   - object identifier
-
-

OUTPUTS

-
  type     - type of the object, possible values:
-              H5I_FILE_F
-              H5I_GROUP_F
-              H5I_DATATYPE_F
-              H5I_DATASPACE_F
-              H5I_DATASET_F
-              H5I_ATTR_F
-              H5I_BADID_F
-  hdferr:  - error code
-              Success:  0
-              Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 5, 2001
-
-

SOURCE

-
  SUBROUTINE h5iget_type_f(obj_id, TYPE, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id  ! Object identifier
-    INTEGER, INTENT(OUT) :: TYPE ! type of an object.
-                                 ! possible values are:
-                                 !   H5I_FILE_F
-                                 !   H5I_GROUP_F
-                                 !   H5I_DATATYPE_F
-                                 !   H5I_DATASPACE_F
-                                 !   H5I_DATASET_F
-                                 !   H5I_ATTR_F
-                                 !   H5I_BADID_F
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-
- -
- -

h5iinc_ref_f

- -

[ Top ] [ H5I ] [ Subroutines ]

-

NAME

-
  h5iinc_ref_f
-
-

PURPOSE

-
  Increments the reference count of an ID
-
-

INPUTS

-
  obj_id        - object identifier
-
-

OUTPUTS

-
  ref_count     - Current reference count of the ID
-  hdferr:              - error code
-  Success:  0
-  Failure: -1
-
-

AUTHOR

-
  Quincey Koziol
-  December  9, 2003
-
-

SOURCE

-
  SUBROUTINE h5iinc_ref_f(obj_id, ref_count, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
-    INTEGER, INTENT(OUT) :: ref_count    ! Current reference count of ID
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-
- -
- -

h5iis_valid_f

- -

[ Top ] [ H5I ] [ Subroutines ]

-

NAME

-
  h5iget_file_id_f
-
-

PURPOSE

-
  Check if an ID is valid without producing an error message
-
-

INPUTS

-
  id           - identifier 
-
-

OUTPUTS

-
  valid        - status of id as a valid identifier
-  hdferr:      - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 13, 2009
-
-

SOURCE

-
  SUBROUTINE h5iis_valid_f(id, valid, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN)  :: id ! Identifier 
-    LOGICAL, INTENT(OUT) :: valid     ! Status of id as a valid identifier
-    INTEGER, INTENT(OUT) :: hdferr    ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Lf_c.html b/fortran/doc/DevelGuide/src/H5Lf_c.html deleted file mode 100644 index 9adb759..0000000 --- a/fortran/doc/DevelGuide/src/H5Lf_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Lf.c - - - - - -
-
- -

H5Lf

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5L Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Lff_F03_f90.html b/fortran/doc/DevelGuide/src/H5Lff_F03_f90.html deleted file mode 100644 index 6b9640b..0000000 --- a/fortran/doc/DevelGuide/src/H5Lff_F03_f90.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - -./src/H5Lff_F03.f90 - - - - - -
-
- -

H5L (F03)

- -

[ Top ] [ Modules ]

-

NAME

-
  H5L_PROVISIONAL
-
-

FILE

-
  src/fortran/src/H5Lff_F03.f90
-
-

PURPOSE

-
  This file contains Fortran 90 and Fortran 2003 interfaces for H5L functions.
-  It contains the same functions as H5Lff_DEPRECIATE.f90 but includes the
-  Fortran 2003 functions and the interface listings. This file will be compiled
-  instead of H5Lff_DEPRECIATE.f90 if Fortran 2003 functions are enabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5A function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5literate_by_name_f

- -

[ Top ] [ H5L (F03) ] [ Subroutines ]

-

NAME

-
  h5literate_by_name_f
-
-

PURPOSE

-
  Iterates through links in a group.
-
-

INPUTS

-
  loc_id        - File or group identifier specifying location of subject group
-  group_name    - Name of subject group
-  index_type    - Type of index which determines the order
-  order         - Order within index
-  idx           - Iteration position at which to start
-  op            - Callback function passing data regarding the link to the calling application
-  op_data       - User-defined pointer to data required by the application for its processing of the link
-
-

OUTPUTS

-
  idx      - Position at which an interrupted iteration may be restarted
-  hdferr   - Error code:
-               Success:  0
-               Failure: -1
-
-

OPTIONAL PARAMETERS

-
  lapl_id  - Link access property list
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  Augest 18, 2008
-
-

SOURCE

-
  SUBROUTINE h5literate_by_name_f(loc_id, group_name, index_type, order, idx, op, op_data, return_value, hdferr, lapl_id)
-    USE ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id    ! Identifier specifying subject group
-    CHARACTER(LEN=*) :: group_name          ! Name of subject group
-    INTEGER, INTENT(IN) :: index_type       ! Type of index which determines the order:
-                                                ! H5_INDEX_NAME_F - Alpha-numeric index on name
-                                                ! H5_INDEX_CRT_ORDER_F - Index on creation order
-    INTEGER, INTENT(IN) :: order            ! Order within index:
-                                                ! H5_ITER_INC_F - Increasing order
-                                                ! H5_ITER_DEC_F - Decreasing order
-                                                ! H5_ITER_NATIVE_F - Fastest available order
-    INTEGER(HSIZE_T), INTENT(INOUT) :: idx  ! IN : Iteration position at which to start
-                                            ! OUT: Position at which an interrupted iteration may be restarted
-
-    TYPE(C_FUNPTR):: op      ! Callback function passing data regarding the link to the calling application
-    TYPE(C_PTR)   :: op_data ! User-defined pointer to data required by the application for its processing of the link
-
-    INTEGER, INTENT(OUT) :: return_value ! Success:   The return value of the first operator that
-                                         !            returns non-zero, or zero if all members were
-                                         !            processed with no operator returning non-zero.
-
-                                         ! Failure:   Negative if something goes wrong within the
-                                         !            library, or the negative value returned by one
-                                         !            of the operators.
-
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code:
-                                         ! 0 on success and -1 on failure
-
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list
-
- -
- -

h5literate_f

- -

[ Top ] [ H5L (F03) ] [ Subroutines ]

-

NAME

-
  h5literate_f
-
-

PURPOSE

-
  Iterates through links in a group.
-
-

INPUTS

-
  group_id      - Identifier specifying subject group
-  index_type    - Type of index which determines the order
-  order         - Order within index
-  idx           - Iteration position at which to start
-  op            - Callback function passing data regarding the link to the calling application
-  op_data       - User-defined pointer to data required by the application for its processing of the link
-
-

OUTPUTS

-
  idx           - Position at which an interrupted iteration may be restarted
-  hdferr        - Error code:
-                    Success:  0
-                    Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  July 8, 2008
-
-

SOURCE

-
  SUBROUTINE h5literate_f(group_id, index_type, order, idx, op, op_data, return_value, hdferr)
-    USE ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: group_id  ! Identifier specifying subject group
-    INTEGER, INTENT(IN) :: index_type       ! Type of index which determines the order:
-                                                ! H5_INDEX_NAME_F - Alpha-numeric index on name
-                                                ! H5_INDEX_CRT_ORDER_F - Index on creation order
-    INTEGER, INTENT(IN) :: order            ! Order within index:
-                                                ! H5_ITER_INC_F - Increasing order
-                                                ! H5_ITER_DEC_F - Decreasing order
-                                                ! H5_ITER_NATIVE_F - Fastest available order
-    INTEGER(HSIZE_T), INTENT(INOUT) :: idx  ! IN : Iteration position at which to start
-                                            ! OUT: Position at which an interrupted iteration may be restarted
-
-    TYPE(C_FUNPTR):: op      ! Callback function passing data regarding the link to the calling application
-    TYPE(C_PTR)   :: op_data ! User-defined pointer to data required by the application for its processing of the link
-
-    INTEGER, INTENT(OUT) :: return_value ! Success:   The return value of the first operator that
-                                         !            returns non-zero, or zero if all members were
-                                         !            processed with no operator returning non-zero.
-
-                                         ! Failure:   Negative if something goes wrong within the
-                                         !            library, or the negative value returned by one
-                                         !            of the operators.
-
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code:
-                                         ! 0 on success and -1 on failure
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Lff_F90_f90.html b/fortran/doc/DevelGuide/src/H5Lff_F90_f90.html deleted file mode 100644 index 6d1a9bb..0000000 --- a/fortran/doc/DevelGuide/src/H5Lff_F90_f90.html +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - -./src/H5Lff_F90.f90 - - - - - -
-
- -

H5L (F90)

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5L_PROVISIONAL
-
-

PURPOSE

-
  This file contains Fortran 90 interfaces for H5L functions. It contains
-  the same functions as H5Lff_F03.f90 but excludes the Fortran 2003 functions
-  and the interface listings. This file will be compiled instead of H5Lff_F03.f90
-  if Fortran 2003 functions are not enabled.
-
- NOTE
-  Currently contains no functions.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Lff_f90.html b/fortran/doc/DevelGuide/src/H5Lff_f90.html deleted file mode 100644 index 1a209f2..0000000 --- a/fortran/doc/DevelGuide/src/H5Lff_f90.html +++ /dev/null @@ -1,637 +0,0 @@ - - - - - - - -./src/H5Lff.f90 - - - - - -
-
- -

H5L

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5L
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5L functions. It includes
-  all the functions that are independent on whether the Fortran 2003 functions
-  are enabled or disabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5L function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5lcopy_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  h5lcopy_f
-
-

PURPOSE

-
  Copies a link from one location to another.
-
-

INPUTS

-
  src_loc_id    - Location identifier of the source link
-  src_name      - Name of the link to be copied
-  dest_loc_id   - Location identifier specifying the destination of the copy
-  dest_name     - Name to be assigned to the NEW copy
-  loc_id        - Identifier of the file or group containing the object
-  name          - Name of the link to delete
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lcpl_id       - Link creation property list identifier
-  lapl_id       - Link access property list identifier
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 27, 2008
-
-

SOURCE

-
  SUBROUTINE h5lcopy_f(src_loc_id, src_name, dest_loc_id, dest_name, hdferr, &
-       lcpl_id, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: src_loc_id  ! Location identifier of the source link
-    CHARACTER(LEN=*), INTENT(IN) :: src_name   ! Name of the link to be copied
-    INTEGER(HID_T), INTENT(IN) :: dest_loc_id ! Location identifier specifying the destination of the copy
-    CHARACTER(LEN=*), INTENT(IN) :: dest_name ! Name to be assigned to the NEW copy
-
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code:
-                                          ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Link creation property list identifier
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list identifier
-
- -
- -

H5Lcreate_external_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  H5Lcreate_external_f
-
-

PURPOSE

-
  Creates a soft link to an object in a different file.
-
-

INPUTS

-
  file_name     - Name of the file containing the target object. Neither the file nor the target object is
-  required to exist. May be the file the link is being created in.
-  obj_name      - Path within the target file to the target object.
-  link_loc_id   - The file or group identifier for the new link.
-  link_name     - The name of the new link.
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lcpl_id       - Link creation property list identifier.
-  lapl_id       - Link access property list identifier.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 27, 2008
-
-

SOURCE

-
  SUBROUTINE h5lcreate_external_f(file_name, obj_name, link_loc_id, link_name, hdferr, lcpl_id, lapl_id)
-    IMPLICIT NONE
-    CHARACTER(LEN=*), INTENT(IN) :: file_name ! Name of the file containing the target object. Neither
-                                              ! the file nor the target object is required to exist.
-                                              ! May be the file the link is being created in.
-    CHARACTER(LEN=*), INTENT(IN) :: obj_name  ! Name of the target object, which must already exist.
-    INTEGER(HID_T), INTENT(IN) :: link_loc_id ! The file or group identifier for the new link.
-    CHARACTER(LEN=*), INTENT(IN) :: link_name ! The name of the new link.
-
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code:
-                                          ! 0 on success and -1 on failure
-
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Link creation property list identifier.
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list identifier.
-
- -
- -

H5Lcreate_hard_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  H5Lcreate_hard_f
-
-

PURPOSE

-
  Creates a hard link to an object.
-
-

INPUTS

-
  obj_loc_id    - The file or group identifier for the target object.
-  obj_name      - Name of the target object, which must already exist.
-  link_loc_id   - The file or group identifier for the new link.
-  link_name     - The name of the new link.
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lcpl_id       - Link creation property list identifier.
-  lapl_id       - Link access property list identifier.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 27, 2008
-
-

SOURCE

-
  SUBROUTINE h5lcreate_hard_f(obj_loc_id, obj_name, link_loc_id, link_name, hdferr, lcpl_id, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_loc_id  ! The file or group identifier for the target object.
-    CHARACTER(LEN=*), INTENT(IN) :: obj_name  ! Name of the target object, which must already exist.
-    INTEGER(HID_T), INTENT(IN) :: link_loc_id ! The file or group identifier for the new link.
-    CHARACTER(LEN=*), INTENT(IN) :: link_name ! The name of the new link.
-
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code:
-                                          ! 0 on success and -1 on failure
-
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) ::   lcpl_id         ! Link creation property list identifier.
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) ::   lapl_id         ! Link access property list identifier.
-
- -
- -

H5Lcreate_soft_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  H5Lcreate_soft_f
-
-

PURPOSE

-
  Creates a soft link to an object.
-
-

INPUTS

-
  target_path   - Path to the target object, which is not required to exist.
-  link_loc_id   - The file or group identifier for the new link.
-  link_name     - The name of the new link.
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lcpl_id       - Link creation property list identifier.
-  lapl_id       - Link access property list identifier.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 20, 2008
-
-

SOURCE

-
  SUBROUTINE h5lcreate_soft_f(target_path, link_loc_id, link_name, hdferr, lcpl_id, lapl_id)
-    IMPLICIT NONE
-    CHARACTER(LEN=*), INTENT(IN) :: target_path   ! Path to the target object, which is not required to exist.
-    INTEGER(HID_T), INTENT(IN) :: link_loc_id     ! The file or group identifier for the new link.
-    CHARACTER(LEN=*), INTENT(IN) :: link_name     ! The name of the new link.
-    INTEGER, INTENT(OUT) :: hdferr                ! Error code:
-                                                  !   0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Link creation property list identifier.
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list identifier.
-
- -
- -

h5ldelete_by_idx_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  h5ldelete_by_idx_f
-
-

PURPOSE

-
  Removes the nth link in a group.
-
-

INPUTS

-
  loc_id        - File or group identifier specifying location of subject group
-  group_name    - Name of subject group
-  index_field   - Type of index; Possible values are:
-                    H5_INDEX_UNKNOWN_F = -1  - Unknown index type
-                    H5_INDEX_NAME_F          - Index on names
-                    H5_INDEX_CRT_ORDER_F     - Index on creation order
-                    H5_INDEX_N_F             - Number of indices defined
-
-  order         - Order within field or index; Possible values are:
-                    H5_ITER_UNKNOWN_F   - Unknown order
-                    H5_ITER_INC_F       - Increasing order
-                    H5_ITER_DEC_F       - Decreasing order
-                    H5_ITER_NATIVE_F    - No particular order, whatever is fastest
-                    H5_ITER_N_F         - Number of iteration orders
-
-  n             - Link for which to retrieve information
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 29, 2008
-
-

SOURCE

-
  SUBROUTINE h5ldelete_by_idx_f(loc_id, group_name, index_field, order, n, hdferr, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id       ! Identifer for object to which attribute is attached
-    CHARACTER(LEN=*), INTENT(IN) :: group_name ! Name of object, relative to location,
-                                               !  from which attribute is to be removed
-    INTEGER, INTENT(IN) :: index_field         ! Type of index; Possible values are:
-                                               !    H5_INDEX_UNKNOWN_F   - Unknown index type
-                                               !    H5_INDEX_NAME_F      - Index on names
-                                               !    H5_INDEX_CRT_ORDER_F - Index on creation order
-                                               !    H5_INDEX_N_F              - Number of indices defined
-    INTEGER, INTENT(IN) :: order               ! Order in which to iterate over index; Possible values are:
-                                               !    H5_ITER_UNKNOWN_F  - Unknown order
-                                               !    H5_ITER_INC_F      - Increasing order
-                                               !    H5_ITER_DEC_F      - Decreasing order
-                                               !    H5_ITER_NATIVE_F   - No particular order, whatever is fastest
-                                               !    H5_ITER_N_F     - Number of iteration orders
-    INTEGER(HSIZE_T), INTENT(IN) :: n      ! Offset within index
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code:
-                                           ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id     ! Link access property list
-
- -
- -

h5ldelete_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  h5ldelete_f
-
-

PURPOSE

-
  Removes a link from a group.
-
-

INPUTS

-
  loc_id        - Identifier of the file or group containing the object
-  name          - Name of the link to delete
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list identifier
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5ldelete_f(loc_id, name, hdferr, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id  ! Identifier of the file or group containing the object
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of the link to delete
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code:
-                                          ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list identifier
-
- -
- -

H5Lexists_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  H5Lexists_f
-
-

PURPOSE

-
  Check if a link with a particular name exists in a group.
-
-

INPUTS

-
  loc_id        - Identifier of the file or group to query.
-  name          - Link name to check
-
-

OUTPUTS

-
  link_exists   - link exists status (.TRUE.,.FALSE.)
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list identifier.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 29, 2008
-
-

SOURCE

-
  SUBROUTINE h5lexists_f(loc_id, name, link_exists, hdferr, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id  ! Identifier of the file or group to query.
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Link name to check.
-    LOGICAL, INTENT(OUT) :: link_exists   ! .TRUE. if exists, .FALSE. otherwise
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code:
-                                          ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id
-                                          ! Link access property list identifier.
-
- -
- -

h5lget_info_by_idx_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  h5lget_info_by_idx_f
-
-

PURPOSE

-
  Retrieves metadata for a link in a group, according to the order within a field or index.
-
-

INPUTS

-
  loc_id        - File or group identifier specifying location of subject group
-  group_name    - Name of subject group
-  index_field   - Index or field which determines the order
-  order         - Order within field or index
-  n             - Link for which to retrieve information
-
-

OUTPUTS

-
            NOTE: In C these are defined as a structure: H5L_info_t
-  corder_valid  - Indicates whether the creation order data is valid for this attribute
-  corder        - Is a positive integer containing the creation order of the attribute
-  cset          - Indicates the character set used for the attribute’s name 
- address        - If the link is a hard link, address specifies the file address that the link points to
- val_size       - If the link is a symbolic link, val_size will be the length of the link value, e.g., 
-                  the length of the name of the pointed-to object with a null terminator.
- hdferr         - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 29, 2008
-
-

HISTORY

-
   Changed the link_type names to match those in C (bug 1720) from,
-   H5L_LINK_HARD_F, H5L_LINK_SOFT_F,H5L_LINK_EXTERNAL_F,H5L_LINK_ERROR_F
-   to
-   H5L_TYPE_HARD_F, H5L_TYPE_SOFT_F,H5L_TYPE_EXTERNAL_F,H5L_TYPE_ERROR_F
-   MSB January 8, 2010.  
-
-

SOURCE

-
  SUBROUTINE h5lget_info_by_idx_f(loc_id, group_name, index_field, order, n, &
-       link_type, f_corder_valid, corder, cset, address, val_size, hdferr, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id       ! File or group identifier specifying location of subject group  
-    CHARACTER(LEN=*), INTENT(IN) :: group_name ! Name of subject group
-    INTEGER, INTENT(IN) :: index_field  ! Index or field which determines the order
-                                        !    H5_INDEX_UNKNOWN_F   - Unknown index type
-                                        !    H5_INDEX_NAME_F      - Index on names
-                                        !    H5_INDEX_CRT_ORDER_F - Index on creation order
-                                        !    H5_INDEX_N_F             - Number of indices defined
-    INTEGER, INTENT(IN) :: order        ! Order in which to iterate over index; Possible values are:
-                                        !    H5_ITER_UNKNOWN_F  - Unknown order
-                                        !    H5_ITER_INC_F      - Increasing order
-                                        !    H5_ITER_DEC_F      - Decreasing order
-                                        !    H5_ITER_NATIVE_F   - No particular order, whatever is fastest
-    INTEGER(HSIZE_T), INTENT(IN) :: n   ! Attribute’s position in index
-    INTEGER, INTENT(OUT) :: link_type ! Specifies the link class:
-                                      !  H5L_TYPE_HARD_F      - Hard link
-                                      !  H5L_TYPE_SOFT_F      - Soft link
-                                      !  H5L_TYPE_EXTERNAL_F  - External link
-                                      !  H5L_TYPE_ERROR _F    - Error
-    LOGICAL, INTENT(OUT) :: f_corder_valid ! Indicates whether the creation order data is valid for this attribute 
-    INTEGER, INTENT(OUT) :: corder         ! Is a positive integer containing the creation order of the attribute
-    INTEGER, INTENT(OUT) :: cset           ! Indicates the character set used for the attribute’s name
-    INTEGER(HADDR_T), INTENT(OUT) :: address  ! If the link is a hard link, address specifies the file address that the link points to
-    INTEGER(SIZE_T), INTENT(OUT) :: val_size  ! If the link is a symbolic link, val_size will be the length of the link value, e.g., 
-                                              ! the length of the name of the pointed-to object with a null terminator. 
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code:
-                                         ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id  ! Link access property list
-
- -
- -

h5lget_info_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  h5lget_info_f
-
-

PURPOSE

-
  Returns information about a link.
-
-

INPUTS

-
  link_loc_id   - File or group identifier.
-  link_name     - Name of the link for which information is being sought
-
-

OUTPUTS

-
            NOTE: In C these are contained in the structure H5L_info_t
-
-  cset          - indicates the character set used for link’s name.
-  corder        - specifies the link’s creation order position.
-  corder_valid  - indicates whether the value in corder is valid.
-  link_type     - specifies the link class:
-                    H5L_TYPE_HARD_F     - Hard link
-                    H5L_TYPE_SOFT_F     - Soft link
-                    H5L_TYPE_EXTERNAL_F - External link
-                    H5L_TYPE_ERROR_ F   - Error
-  address       - If the link is a hard link, address specifies the file address that the link points to
-  val_size      - If the link is a symbolic link, val_size will be the length of the link value, e.g., 
-                  the length of the name of the pointed-to object with a null terminator. 
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Link access property list
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 29, 2008
-
-

HISTORY

-
   Changed the link_type names to match those in C (bug 1720) from,
-   H5L_LINK_HARD_F, H5L_LINK_SOFT_F,H5L_LINK_EXTERNAL_F,H5L_LINK_ERROR_F
-   to
-   H5L_TYPE_HARD_F, H5L_TYPE_SOFT_F,H5L_TYPE_EXTERNAL_F,H5L_TYPE_ERROR_F
-   MSB January 8, 2010.
-
-

SOURCE

-
  SUBROUTINE h5lget_info_f(link_loc_id, link_name, &
-       cset, corder, f_corder_valid, link_type, address, val_size, &
-       hdferr, lapl_id)
-    IMPLICIT NONE
-
-    INTEGER(HID_T), INTENT(IN) :: link_loc_id ! File or group identifier.
-    CHARACTER(LEN=*), INTENT(IN) :: link_name ! Name of the link for which information is being sought
-
-! OUTPUTS  NOTE: In C these are contained in the structure H5L_info_t
-    INTEGER, INTENT(OUT) :: cset ! Indicates the character set used for the link’s name.
-    INTEGER, INTENT(OUT) :: corder ! Specifies the link’s creation order position.
-    LOGICAL, INTENT(OUT) :: f_corder_valid ! Indicates whether the value in corder is valid.
-    INTEGER, INTENT(OUT) :: link_type ! Specifies the link class:
-                                      !  H5L_TYPE_HARD_F      - Hard link
-                                      !  H5L_TYPE_SOFT_F      - Soft link
-                                      !  H5L_TYPE_EXTERNAL_F  - External link
-                                      !  H5L_TYPE_ERROR _F    - Error
-    INTEGER(HADDR_T), INTENT(OUT) :: address ! If the link is a hard link, address specifies the file address that the link points to
-    INTEGER(SIZE_T), INTENT(OUT) :: val_size ! If the link is a symbolic link, val_size will be the length of the link value, e.g., 
-                                             ! the length of the name of the pointed-to object with a null terminator. 
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code:
-                                         ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id  ! Link access property list
-
- -
- -

h5lget_name_by_idx_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  h5lget_name_by_idx_f
-
-

PURPOSE

-
  Retrieves name of the nth link in a group, according to the order within a specified field or index.
-
-

INPUTS

-
  loc_id        - File or group identifier specifying location of subject group
-  group_name    - Name of subject group
-  index_field   - Index or field which determines the order
-  order         - Order within field or index
-  n             - Link for which to retrieve information
-
-

OUTPUTS

-
  name          - Buffer in which link value is returned
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - List access property list identifier.
-  size          - Maximum number of characters of link value to be returned.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 10, 2008
-
-

SOURCE

-
  SUBROUTINE h5lget_name_by_idx_f(loc_id, group_name, index_field, order, n, &
-        name, hdferr, size, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id       ! File or group identifier specifying location of subject group
-    CHARACTER(LEN=*), INTENT(IN) :: group_name ! Name of subject group
-    INTEGER, INTENT(IN) :: index_field  ! Index or field which determines the order
-                                        !    H5_INDEX_UNKNOWN_F   - Unknown index type
-                                        !    H5_INDEX_NAME_F      - Index on names
-                                        !    H5_INDEX_CRT_ORDER_F - Index on creation order
-                                        !    H5_INDEX_N_F             - Number of indices defined
-    INTEGER, INTENT(IN) :: order        ! Order in which to iterate over index; Possible values are:
-                                        !    H5_ITER_UNKNOWN_F  - Unknown order
-                                        !    H5_ITER_INC_F      - Increasing order
-                                        !    H5_ITER_DEC_F      - Decreasing order
-                                        !    H5_ITER_NATIVE_F   - No particular order, whatever is fastest
-    INTEGER(HSIZE_T), INTENT(IN) :: n   ! Attribute’s position in index
-    CHARACTER(LEN=*), INTENT(OUT) :: name ! Buffer in which link value is returned
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code:
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5lis_registered_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  h5lis_registered_f
-
-

PURPOSE

-
  Determines whether a class of user-defined links is registered.
-
-

INPUTS

-
  link_cls_id   - User-defined link class identifier
-
-

OUTPUTS

-
  registered    - .TRUE.  - if the link class has been registered
-                  .FALSE. - if it is unregistered
-  hdferr        - Error code
-  Success:  0
-  Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 29, 2008
-
-

SOURCE

-
  SUBROUTINE h5lis_registered_f(link_cls_id, registered, hdferr)
-    IMPLICIT NONE
-    INTEGER, INTENT(IN) :: link_cls_id  ! User-defined link class identifier
-    LOGICAL, INTENT(OUT) :: registered  ! .TRUE. - if the link class has been registered and
-                                        ! .FALSE. - if it is unregistered
-    INTEGER, INTENT(OUT) :: hdferr      ! Error code:
-                                        ! 0 on success and -1 on failure
-
- -
- -

h5lmove_f

- -

[ Top ] [ H5L ] [ Subroutines ]

-

NAME

-
  h5lmove_f
-
-

PURPOSE

-
  Renames a link within an HDF5 file.
-
-

INPUTS

-
  src_loc_id    - Original file or group identifier.
-  src_name      - Original link name.
-  dest_loc_id   - Destination file or group identifier.
-  dest_name     - NEW link name.
-
-

OUTPUTS

-
  hdferr        - Error code:
-                   0 on success and -1 on failure
-
-

OPTIONAL PARAMETERS

-
  lcpl_id       - Link creation property list identifier to be associated WITH the NEW link.
-  lapl_id       - Link access property list identifier to be associated WITH the NEW link.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 3, 2008
-
-

SOURCE

-
  SUBROUTINE h5lmove_f(src_loc_id, src_name, dest_loc_id, dest_name, hdferr, lcpl_id, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: src_loc_id  ! Original file or group identifier.
-    CHARACTER(LEN=*), INTENT(IN) :: src_name  ! Original link name.
-    INTEGER(HID_T), INTENT(IN) :: dest_loc_id ! Destination file or group identifier.
-    CHARACTER(LEN=*), INTENT(IN) :: dest_name ! NEW link name.
-    INTEGER, INTENT(OUT) :: hdferr     ! Error code:
-                                              ! 0 on success and -1 on failure
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Link creation property list identifier
-                                                    ! to be associated WITH the NEW link.
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link access property list identifier
-                                                    ! to be associated WITH the NEW link.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Of_c.html b/fortran/doc/DevelGuide/src/H5Of_c.html deleted file mode 100644 index e4a97e9..0000000 --- a/fortran/doc/DevelGuide/src/H5Of_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Of.c - - - - - -
-
- -

H5Of

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5O Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Off_f90.html b/fortran/doc/DevelGuide/src/H5Off_f90.html deleted file mode 100644 index 790810e..0000000 --- a/fortran/doc/DevelGuide/src/H5Off_f90.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - - -./src/H5Off.f90 - - - - - -
-
- -

H5O

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5O
-
-

FILE

-
  fortran/src/H5Off.f90
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5O functions. It includes
-  all the functions that are independent on whether the Fortran 2003 functions
-  are enabled or disabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5O function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5oclose_f

- -

[ Top ] [ H5O ] [ Subroutines ]

-

NAME

-
  h5oclose_f
-
-

PURPOSE

-
  Closes an object in an HDF5 file.
-
-

INPUTS

-
  object_id     - Object identifier
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  December 17, 2008
-
-

SOURCE

-
  SUBROUTINE h5oclose_f(object_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN)  :: object_id
-    INTEGER,        INTENT(OUT) :: hdferr
-
- -
- -

h5olink_f

- -

[ Top ] [ H5O ] [ Subroutines ]

-

NAME

-
  h5olink_f
-
-

PURPOSE

-
  Creates a hard link to an object in an HDF5 file.
-
-

INPUTS

-
  object_id     - Object to be linked.
-  new_loc_id    - File or group identifier specifying location at which object is to be linked.
-  new_link_name - Name of link to be created, relative to new_loc_id.
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

OPTIONAL PARAMETERS

-
  lcpl_id       - Link creation property list identifier.
-  lapl_id       - Link access property list identifier.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 21, 2008
-
-

SOURCE

-
  SUBROUTINE h5olink_f(object_id, new_loc_id, new_link_name, hdferr, lcpl_id, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: object_id  ! Object to be linked
-    INTEGER(HID_T), INTENT(IN) :: new_loc_id ! File or group identifier specifying
-                                             ! location at which object is to be linked.
-    CHARACTER(LEN=*), INTENT(IN) :: new_link_name ! Name of link to be created, relative to new_loc_id.
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          !   Success:  0
-                                          !   Failure: -1
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Link creation property list identifier.
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link creation property list identifier.
-
- -
- -

h5oopen_f

- -

[ Top ] [ H5O ] [ Subroutines ]

-

NAME

-
  h5oopen_f
-
-

PURPOSE

-
  Opens an object in an HDF5 file by location identifier and path name.
-
-

INPUTS

-
  loc_id        - File or group identifier
-  name          - Path to the object, relative to loc_id.
-
-

OUTPUTS

-
  obj_id        - Object identifier for the opened object
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

OPTIONAL PARAMETERS

-
  lapl_id       - Access property list identifier for the link pointing to the object
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 18, 2008
-
-

SOURCE

-
  SUBROUTINE h5oopen_f(loc_id, name, obj_id, hdferr, lapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id  ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Path to the object, relative to loc_id
-    INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier for the opened object
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          !   Success:  0
-                                          !   Failure: -1
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id  ! Attribute access property list
-
- -
- -

h5open_by_addr_f

- -

[ Top ] [ H5O ] [ Subroutines ]

-

NAME

-
  h5oopen_by_addr_f 
-
-

PURPOSE

-
  Opens an object using its address within an HDF5 file. 
-
-

INPUTS

-
    loc_id - File or group identifier
-    addr   - Object’s address in the file
- OUTPUTS: 
-    obj_id - Object identifier for the opened object
-    hdferr - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  September 14, 2009
-
-

SOURCE

-
  SUBROUTINE h5oopen_by_addr_f(loc_id, addr, obj_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id  ! File or group identifier
-    INTEGER(HADDR_T), INTENT(IN) :: addr  ! Object’s address in the file
-    INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier for the opened object
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code:
-                                          ! 0 on success and -1 on failure
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Pf_c.html b/fortran/doc/DevelGuide/src/H5Pf_c.html deleted file mode 100644 index 6b8079a..0000000 --- a/fortran/doc/DevelGuide/src/H5Pf_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Pf.c - - - - - -
-
- -

H5Pf

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5P Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Pff_F03_f90.html b/fortran/doc/DevelGuide/src/H5Pff_F03_f90.html deleted file mode 100644 index 51882ba..0000000 --- a/fortran/doc/DevelGuide/src/H5Pff_F03_f90.html +++ /dev/null @@ -1,832 +0,0 @@ - - - - - - - -./src/H5Pff_F03.f90 - - - - - -
-
- -

H5P (F03)

- -

[ Top ] [ Modules ]

-

NAME

-
  H5P_PROVISIONAL
-
-

PURPOSE

-
  This file contains Fortran 90 and Fortran 2003 interfaces for H5P functions.
-  It contains the same functions as H5Pff_DEPRECIATE.f90 but includes the
-  Fortran 2003 functions and the interface listings. This file will be compiled
-  instead of H5Pff_DEPRECIATE.f90 if Fortran 2003 functions are enabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5P function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5pget_double

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pget_double
-
-

PURPOSE

-
  Gets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-
-

OUTPUTS

-
  value         - value of property
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pget_double(prp_id, name, value, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to modify
-    DOUBLE PRECISION,   INTENT(OUT), TARGET :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pcreate_class_f

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pcreate_class_f
-
-

PURPOSE

-
  Create a new property list class
-
-

INPUTS

-
  parent        - Property list identifier of the parent class
-                  Possible values include:
-                   H5P_ROOT_F
-                   H5P_FILE_CREATE_F
-                   H5P_FILE_ACCESS_F
-                   H5P_DATASET_CREATE_F
-                   H5P_DATASET_XFER_F
-                   H5P_FILE_MOUNT_F
-  name          - name of the class we are creating
-
-

OUTPUTS

-
  class         - porperty list class identifier
-  hdferr:       - error code
-
-  Success: 0
-  Failure: -1
-
-

OPTIONAL PARAMETERS

-
  H5P_cls_create_func_t (create) - Callback routine called when a property list is created
-  create_data                    - User pointer to any class creation information needed
-  H5P_cls_copy_func_t   (copy)   - Callback routine called when a property list is copied
-  copy_data                      - User pointer to any class copy information needed
-  H5P_cls_close_func_t  (close)  - Callback routine called when a property list is being closed
-  close_data                     - User pointer to any class close information needed
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

HISTORY

-
  Added callback arguments
-  M. Scot Breitenfeld, July 3, 2008
-
-

SOURCE

-
  SUBROUTINE h5pcreate_class_f(parent, name, class, hdferr, create, create_data, copy, copy_data, close, close_data)
-    USE iso_c_binding
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: parent  ! parent property list class identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! name of property tocreate
-    INTEGER(HID_T), INTENT(OUT) :: class  ! property list class identifier
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-    TYPE(C_PTR), OPTIONAL :: create_data, copy_data, close_data
-    TYPE(C_FUNPTR), OPTIONAL :: create, copy, close
-
- -
- -

h5pget_char

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pget_char
-
-

PURPOSE

-
  Gets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-
-

OUTPUTS

-
  value         - value of property
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pget_char(prp_id, name, value, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id   ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of property to modify
-    CHARACTER(LEN=*), INTENT(OUT) :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5pget_integer

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pget_integer
-
-

PURPOSE

-
  Gets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-
-

OUTPUTS

-
  value         - value of property
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pget_integer(prp_id, name, value, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id    ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name    ! Name of property to modify
-    INTEGER,   INTENT(OUT), TARGET :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5pget_real

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pget_real
-
-

PURPOSE

-
  Gets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-
-

OUTPUTS

-
  value         - value of property
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pget_real(prp_id, name, value, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to modify
-    REAL,   INTENT(OUT), TARGET :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-
- -
- -

h5pinsert_char

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pinsert_char
-
-

PURPOSE

-
  Registers a temporary property with a property list class.
-
-

INPUTS

-
  plist         - property list identifier
-                  permanent property within
-  name          - name of property to insert
-  size          - size of property in bytes
-  value         - initial value for the property
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pinsert_char(plist, name, size, value, hdferr)
-    USE iso_c_binding
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist      ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name     ! Name of property to insert
-    INTEGER(SIZE_T), INTENT(IN) :: size      ! Size of property value
-    CHARACTER(LEN=*),   INTENT(IN) :: value  ! Property value
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-
- -
- -

h5pinsert_double

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pinsert_double
-
-

PURPOSE

-
  Registers a temporary property with a property list class.
-
-

INPUTS

-
  plist         - property list identifier
-                  permanent property within
-  name          - name of property to insert
-  size          - size of property in bytes
-  value         - initial value for the property
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

OPTIONAL PARAMETERS

-
  NONE
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pinsert_double(plist, name, size, value, hdferr)
-    USE iso_c_binding
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist   ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to insert
-    INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value
-    DOUBLE PRECISION, INTENT(IN), TARGET :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pinsert_integer

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pinsert_integer
-
-

PURPOSE

-
  Registers a temporary property with a property list class.
-
-

INPUTS

-
  plist         - property list identifier
-  name          - name of property to insert
-  size          - size of property in bytes
-  value         - initial value for the property
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pinsert_integer(plist, name, size, value, hdferr)
-    USE iso_c_binding
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist    ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of property to insert
-    INTEGER(SIZE_T), INTENT(IN) :: size    ! Size of the property value
-    INTEGER,   INTENT(IN), TARGET :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5pinsert_ptr

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pinsert_ptr
-
-

PURPOSE

-
  Registers a temporary property with a property list class.
-
-

INPUTS

-
  plist         - property list identifier
-                  permanent property within
-  name          - name of property to insert
-  size          - size of property in bytes
-  value         - initial value for the property
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  June 24, 2008
-
-

SOURCE

-
  SUBROUTINE h5pinsert_ptr(plist, name, size, value, hdferr)
-    USE iso_c_binding
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist  ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to insert
-    INTEGER(SIZE_T), INTENT(IN) :: size  ! Size of property value
-    TYPE(c_ptr),   INTENT(IN) :: value   ! Property value
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-
- -
- -

h5pinsert_real

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pinsert_real
-
-

PURPOSE

-
  Registers a temporary property with a property list class.
-
-

INPUTS

-
  plist         - property list identifier
-                  permanent property within
-  name          - name of property to insert
-  size          - size of property in bytes
-  value         - initial value for the property
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pinsert_real(plist, name, size, value, hdferr)
-    USE iso_c_binding
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist   ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to insert
-    INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value
-    REAL,   INTENT(IN), TARGET :: value   ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pregister_char

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pregister_char
-
-

PURPOSE

-
  Registers a permanent property with a property list class.
-
-

INPUTS

-
  class         - property list class to register
-                  permanent property within
-  name          - name of property to register
-  size          - size of property in bytes
-  value         - default value for property in newly
-                  created property lists
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pregister_char(class, name, size, value, hdferr)
-    USE ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class     ! Property list class identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name    ! Name of property to register
-    INTEGER(SIZE_T), INTENT(IN) :: size     ! size of the property value
-    CHARACTER(LEN=*),   INTENT(IN) :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5pregister_double

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pregister_double
-
-

PURPOSE

-
  Registers a permanent property with a property list class.
-
-

INPUTS

-
  class         - property list class to register
-                  permanent property within
-  name          - name of property to register
-  size          - size of property in bytes
-  value         - default value for property in newly
-                  created property lists
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pregister_double(class, name, size, value, hdferr)
-    USE ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class  ! Property list class identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to register
-    INTEGER(SIZE_T), INTENT(IN) :: size  ! size of the property value
-    DOUBLE PRECISION,   INTENT(IN), TARGET :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-
- -
- -

h5pregister_integer

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pregister_integer
-
-

PURPOSE

-
  Registers a permanent property with a property list class.
-
-

INPUTS

-
  class         - property list class to register
-                  permanent property within
-  name          - name of property to register
-  size          - size of property in bytes
-  value         - default value for property in newly
-                  created property lists
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pregister_integer(class, name, size, value, hdferr)
-    USE ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class    ! Property list class identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of property to register
-    INTEGER(SIZE_T), INTENT(IN) :: size    ! Size of the property value
-    INTEGER,   INTENT(IN), TARGET :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5pregister_ptr

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pregister_ptr
-
-

PURPOSE

-
  Registers a permanent property with a property list class.
-
-

INPUTS

-
  class         - property list class to register
-                  permanent property within
-  name          - name of property to register
-  size          - size of property in bytes
-  value         - default value for property in newly
-                  created property lists
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  June 24, 2008
-
-

SOURCE

-
  SUBROUTINE h5pregister_ptr(class, name, size, value, hdferr)
-    USE ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class   ! Property list class identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to register
-    INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value
-    TYPE(C_PTR), INTENT(IN) :: value      ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pregister_real

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pregister_real
-
-

PURPOSE

-
  Registers a permanent property with a property list class.
-
-

INPUTS

-
  class         - property list class to register
-                  permanent property within
-  name          - name of property to register
-  size          - size of property in bytes
-  value         - default value for property in newly
-                  created property lists
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pregister_real(class, name, size, value, hdferr)
-    USE ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class   ! Property list class identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to register
-    INTEGER(SIZE_T), INTENT(IN) :: size   ! size of the property value
-    REAL,   INTENT(IN), TARGET :: value   ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pset(get)fill_value_f

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pset(get)fill_value_f
-
-

PURPOSE

-
  Sets(gets) fill value for a dataset creation property list
-
-

INPUTS

-
  prp_id        - dataset creation property list identifier
-  type_id       - datatype identifier for fill value
-  fillvalue     - fill value
-
-

OUTPUTS

-
  type_id       - datatype identifier for fill value
-  fillvalue     - fill value
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 14, 2001
-
-  Added the recommended way of passing fillvalue
-  and that is by passing the C address, all other
-  ways are obsolete and should be avoided. June, 2008 MSB
-
-

NOTES

-
  h5pset(get)fill_value_f function is overloaded to support
-  INTEGER, REAL, DOUBLE PRECISION and CHARACTER dtatypes.
-
-

SOURCE

-
  SUBROUTINE h5pset_fill_value_integer(prp_id, type_id, fillvalue, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
-    INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier of
-                                          ! of fillvalue datatype
-                                          ! (in memory)
-    INTEGER, INTENT(IN), TARGET :: fillvalue   ! Fillvalue
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-
- -
- -

h5pset_char

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pset_char
-
-

PURPOSE

-
  Sets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-  value         - value to set property to
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

OPTIONAL PARAMETERS

-
  NONE
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pset_char(prp_id, name, value, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id    ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name    ! Name of property to modify
-    CHARACTER(LEN=*),   INTENT(IN) :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5pset_double

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pset_double
-
-

PURPOSE

-
  Sets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-  value         - value to set property to
-
-

OUTPUTS

-
  hdferr:       - error code
-                    Success:  0
-                    Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pset_double(prp_id, name, value, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to modify
-    DOUBLE PRECISION,   INTENT(IN), TARGET :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr                  ! Error code
-
- -
- -

h5pset_integer

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pset_integer
-
-

PURPOSE

-
  Sets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-  value         - value to set property to
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pset_integer(prp_id, name, value, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id   ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of property to modify
-    INTEGER,   INTENT(IN), TARGET :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5pset_real

- -

[ Top ] [ H5P (F03) ] [ Subroutines ]

-

NAME

-
  h5pset_real
-
-

PURPOSE

-
  Sets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-  value         - value to set property to
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                    Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pset_real(prp_id, name, value, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to modify
-    REAL,   INTENT(IN), TARGET :: value  ! Property value
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Pff_F90_f90.html b/fortran/doc/DevelGuide/src/H5Pff_F90_f90.html deleted file mode 100644 index 5f8d579..0000000 --- a/fortran/doc/DevelGuide/src/H5Pff_F90_f90.html +++ /dev/null @@ -1,715 +0,0 @@ - - - - - - - -./src/H5Pff_F90.f90 - - - - - -
-
- -

H5P (_F90)

- -

[ Top ] [ Modules ]

-

NAME

-
  H5P_PROVISIONAL
-
-

PURPOSE

-
  This file contains Fortran 90 interfaces for H5P functions. It contains
-  the same functions as H5Pff_F03.f90 but excludes the Fortran 2003 functions
-  and the interface listings. This file will be compiled instead of H5Pff_F03.f90
-  if Fortran 2003 functions are not enabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5P function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5pcreate_class_f

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pcreate_class_f
-
-

PURPOSE

-
  Create a new property list class
-
-

INPUTS

-
  parent        - Property list identifier of the parent class
-                  Possible values include:
-                    H5P_ROOT_F
-                    H5P_FILE_CREATE_F
-                    H5P_FILE_ACCESS_F
-                    H5P_DATASET_CREATE_F
-                    H5P_DATASET_XFER_F
-                    H5P_FILE_MOUNT_F
-  name          - name of the class we are creating
-
-

OUTPUTS

-
  class         - property list class identifier
-  hdferr        - error code
-                   Success: 0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pcreate_class_f(parent, name, class, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: parent  ! parent property list class
-                                          ! identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! name of property tocreate
-    INTEGER(HID_T), INTENT(OUT) :: class  ! property list class identifier
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pget_char

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pget_char
-
-

PURPOSE

-
  Gets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-
-

OUTPUTS

-
  value         - value of property
-  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pget_char(prp_id, name, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id     ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name     ! Name of property to modify
-    CHARACTER(LEN=*),   INTENT(OUT) :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-
- -
- -

h5pget_double

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pget_double
-
-

PURPOSE

-
  Gets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-
-

OUTPUTS

-
  value         - value of property
-  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pget_double(prp_id, name, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id     ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name     ! Name of property to modify
-    DOUBLE PRECISION,   INTENT(OUT) :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-
- -
- -

h5pget_integer

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pget_integer
-
-

PURPOSE

-
  Gets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-
-

OUTPUTS

-
  value         - value of property
-  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pget_integer(prp_id, name, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to modify
-    INTEGER,   INTENT(OUT) :: value       ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pget_real

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pget_real
-
-

PURPOSE

-
  Gets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-
-

OUTPUTS

-
  value         - value of property
-  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pget_real(prp_id, name, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to modify
-    REAL,   INTENT(OUT) :: value          ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pinsert_char

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pinsert_char
-
-

PURPOSE

-
  Registers a temporary property with a property list class.
-
-

INPUTS

-
  plist         - property list identifier
-                  permanent property within
-  name          - name of property to insert
-  size          - size of property in bytes
-  value         - initial value for the property
-
-

OUTPUTS

-
  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
SUBROUTINE h5pinsert_char(plist, name, size, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist      ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name     ! Name of property to insert
-    INTEGER(SIZE_T), INTENT(IN) :: size      ! Size of property value
-    CHARACTER(LEN=*),   INTENT(IN) :: value  ! Property value
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-
- -
- -

h5pinsert_double

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pinsert_double
-
-

PURPOSE

-
  Registers a temporary property with a property list class.
-
-

INPUTS

-
  plist         - property list identifier
-                  permanent property within
-  name          - name of property to insert
-  size          - size of property in bytes
-  value         - initial value for the property
-
-

OUTPUTS

-
  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pinsert_double(plist, name, size, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist   ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to insert
-    INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value
-    DOUBLE PRECISION, INTENT(IN) :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pinsert_integer

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pinsert_integer
-
-

PURPOSE

-
  Registers a temporary property with a property list class.
-
-

INPUTS

-
  plist         - property list identifier
-  name          - name of property to insert
-  size          - size of property in bytes
-  value         - initial value for the property
-
-

OUTPUTS

-
  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pinsert_integer(plist, name, size, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist   ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to insert
-    INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value
-    INTEGER,   INTENT(IN) :: value        ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pinsert_real

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pinsert_real
-
-

PURPOSE

-
  Registers a temporary property with a property list class.
-
-

INPUTS

-
  plist         - property list identifier
-                  permanent property within
-  name          - name of property to insert
-  size          - size of property in bytes
-  value         - initial value for the property
-
-

OUTPUTS

-
  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pinsert_real(plist, name, size, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist   ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to insert
-    INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value
-    REAL,   INTENT(IN) :: value           ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pregister_char

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pregister_char
-
-

PURPOSE

-
  Registers a permanent property with a property list class.
-
-

INPUTS

-
  class         - property list class to register
-                  permanent property within
-  name          - name of property to register
-  size          - size of property in bytes
-  value         - default value for property in newly
-                  created property lists
-
-

OUTPUTS

-
  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pregister_char(class, name, size, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class     ! Property list class identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name    ! Name of property to register
-    INTEGER(SIZE_T), INTENT(IN) :: size     ! size of the property value
-    CHARACTER(LEN=*),   INTENT(IN) :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5pregister_double

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pregister_double
-
-

PURPOSE

-
  Registers a permanent property with a property list class.
-
-

INPUTS

-
  class         - property list class to register
-                  permanent property within
-  name          - name of property to register
-  size          - size of property in bytes
-  value         - default value for property in newly
-                  created property lists
-
-

OUTPUTS

-
  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pregister_double(class, name, size, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class     ! Property list class identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name    ! Name of property to register
-    INTEGER(SIZE_T), INTENT(IN) :: size     ! Size of the property value
-    DOUBLE PRECISION,   INTENT(IN) :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5pregister_integer

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pregister_integer
-
-

PURPOSE

-
  Registers a permanent property with a property list class.
-
-

INPUTS

-
  class         - property list class to register
-  permanent property within
-  name          - name of property to register
-  size          - size of property in bytes
-  value         - default value for property in newly
-  created property lists
-
-

OUTPUTS

-
  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pregister_integer(class, name, size, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class   ! Property list class identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to register
-    INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value
-    INTEGER,   INTENT(IN) :: value        ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pregister_real

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pregister_real
-
- PURPOSE       Registers a permanent property with a property list class.
-
-

INPUTS

-
  class         - property list class to register
-                  permanent property within
-  name          - name of property to register
-  size          - size of property in bytes
-  value         - default value for property in newly
-                  created property lists
-
-

OUTPUTS

-
  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 10, 2002
-
-

SOURCE

-
  SUBROUTINE h5pregister_real(class, name, size, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class   ! Property list class identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to register
-    INTEGER(SIZE_T), INTENT(IN) :: size   ! size of the property value
-    REAL,   INTENT(IN) :: value           ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pset(get)fill_value_f

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pset(get)fill_value_f
-
-

PURPOSE

-
  Sets(gets) fill value for a dataset creation property list
-
-

INPUTS

-
  prp_id        - dataset creation property list identifier
-  type_id       - datatype identifier for fill value
-  fillvalue     - fill value
-
-

OUTPUTS

-
  type_id      - datatype identifier for fill value
-  fillvalue    - fill value
-  hdferr       - error code
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 14, 2001
-
-

NOTES

-
  h5pset(get)fill_value_f function is overloaded to support
-  INTEGER, REAL, DOUBLE PRECISION and CHARACTER dtatypes.
-
-

SOURCE

-
  SUBROUTINE h5pset_fill_value_integer(prp_id, type_id, fillvalue, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
-    INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier of
-                                          ! of fillvalue datatype
-                                          ! (in memory)
-    INTEGER, INTENT(IN) :: fillvalue      ! Fillvalue
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pset_char

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pset_char
-
-

PURPOSE

-
  Sets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-  value         - value to set property to
-
-

OUTPUTS

-
  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

OPTIONAL PARAMETERS

-
  NONE
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pset_char(prp_id, name, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id    ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name    ! Name of property to modify
-    CHARACTER(LEN=*),   INTENT(IN) :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5pset_double

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pset_double
-
-

PURPOSE

-
  Sets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-  value         - value to set property to
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pset_double(prp_id, name, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id    ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name    ! Name of property to modify
-    DOUBLE PRECISION,   INTENT(IN) :: value ! Property value
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5pset_integer

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pset_integer
-
-

PURPOSE

-
  Sets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-  value         - value to set property to
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pset_integer(prp_id, name, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to modify
-    INTEGER, INTENT(IN) :: value          ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5pset_real

- -

[ Top ] [ H5P (F90) ] [ Subroutines ]

-

NAME

-
  h5pset_real
-
-

PURPOSE

-
  Sets a property list value
-
-

INPUTS

-
  prp_id        - iproperty list identifier to modify
-  name          - name of property to modify
-  value         - value to set property to
-
-

OUTPUTS

-
  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002
-
-

SOURCE

-
  SUBROUTINE h5pset_real(prp_id, name, value, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to modify
-    REAL, INTENT(IN) :: value             ! Property value
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Pff_f90.html b/fortran/doc/DevelGuide/src/H5Pff_f90.html deleted file mode 100644 index 0e9ff5c..0000000 --- a/fortran/doc/DevelGuide/src/H5Pff_f90.html +++ /dev/null @@ -1,4752 +0,0 @@ - - - - - - - -./src/H5Pff.f90 - - - - - -
-
- -

H5P (F90)

- -

[ Top ] [ Modules ]

-

NAME

-
  H5P_PROVISIONAL
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5P functions. It includes
-  all the functions that are independent on whether the Fortran 2003 functions
-  are enabled or disabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5P function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5pget_hyper_vector_size_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_hyper_vector_size_f 
-
-

PURPOSE

-
  Get the number of "I/O" vectors (vector size)
-
-

INPUTS

-
  plist_id     - dataset transfer property list identifier
-
-

OUTPUTS

-
  size         - vector size
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 7, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pget_hyper_vector_size_f(plist_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset transfer property list identifier 
-    INTEGER(SIZE_T), INTENT(OUT) :: size   ! Vector size
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pset_family_offset_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_family_offset_f 
-
-

PURPOSE

-
  Sets offset for family file driver.
-
-

INPUTS

-
  prp_id       - file creation property list identifier
-  offset       - file offset
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  19 March 2003
-
-

SOURCE

-
  SUBROUTINE h5pset_family_offset_f(prp_id, offset, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id   ! Property list identifier 
-    INTEGER(HSIZE_T), INTENT(IN) :: offset ! Offset in bytes
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pset_fapl_family_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pset_fapl_family_f 
-
-

PURPOSE

-
  Sets the file access property list to use the family driver. 
-
-

INPUTS

-
  prp_id       - file access property list identifier
-  memb_size    - size in bytes of each file member 
-  memb_plist   - identifier of the file access property 
-                 list to be used for each family member
-
-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_fapl_family_f(prp_id, memb_size, memb_plist , hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id      ! Property list identifier 
-    INTEGER(HSIZE_T), INTENT(IN) :: memb_size ! Logical size, in bytes,
-                                              ! of each family member
-    INTEGER(HID_T), INTENT(IN) :: memb_plist  ! Identifier of the file 
-                                              ! access property list for 
-                                              ! each member of the family
-    INTEGER, INTENT(OUT) :: hdferr            ! Error code
-                                              ! 0 on success and -1 on failure
-
- -
- -

h5pset_meta_block_size_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_meta_block_size_f 
-
-

PURPOSE

-
  Sets the minimum size of metadata block allocations 
-
-

INPUTS

-
  plist_id     - file access property list identifier
-  size         - metatdata block size
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 7, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pset_meta_block_size_f(plist_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id  ! File access property list identifier 
-    INTEGER(HSIZE_T), INTENT(IN) :: size    ! Block size in bytes; 
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-                                            ! 0 on success and -1 on failure
-
- -
- -

h5pall_filters_avail_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pall_filters_avail_f 
-
-

PURPOSE

-
  Checks if all filters set in the dataset creation
-  property list are available
-
-

INPUTS

-
  prp_id       - data creation property list identifier
-
-

OUTPUTS

-
  flag         - .TRUE. if all filters are available
-                 .FALSE. otherwise
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  April 10 2003
-
-

SOURCE

-
  SUBROUTINE h5pall_filters_avail_f(prp_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset creation property 
-                                         !  list identifier 
-    LOGICAL, INTENT(OUT) :: flag         ! .TRUE. if all filters are available
-                                         ! .FALSE. otherwise
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pclose_class_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pclose_class_f 
-
-

PURPOSE

-
  Closes an existing property list class.
-
-

INPUTS

-
  class        - Property list class identifier
-
-

OUTPUTS

-
  hdferr       - error code         
-                  Success: 0 
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pclose_class_f(class, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class ! Property list class identifier
-    INTEGER, INTENT(OUT) :: hdferr      ! Error code
-                                        ! 0 on success and -1 on failure
-
- -
- -

h5pclose_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pclose_f 
-
-

PURPOSE

-
  Terminates access to a property list. 
-
-

INPUTS

-
  prp_id - identifier of the property list to 
-           terminate access to. 
-
-

OUTPUTS

-
  hdferr - error code          
-           Success:  0
-           Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pclose_f(prp_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5pcopy_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pcopy_f 
-
-

PURPOSE

-
  Copies an existing property list to create a new 
-  property list
-
-

INPUTS

-
  prp_id       - property list identifier
-
-

OUTPUTS

-
  new_prp_id   - new property list identifier
-  hdferr:      - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001
-
-

SOURCE

-
  SUBROUTINE h5pcopy_f(prp_id, new_prp_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id      ! Property list identifier 
-    INTEGER(HID_T), INTENT(OUT) :: new_prp_id ! Identifier of property list
-    INTEGER, INTENT(OUT) :: hdferr            ! Error code
-                                              ! 0 on success and -1 on failure
-
- -
- -

h5pcopy_prop_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pcopy_prop_f 
-
-

PURPOSE

-
  Copies a property from one list or class to another.
-
-

INPUTS

-
  dst_id               - Identifier of the destination property list
-  src_id               - Identifier of the source property list 
-  name                 - name of the property to copy
-
-

OUTPUTS

-
  hdferr:              - error code
-                          Success: 0 
-                          Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pcopy_prop_f(dst_id, src_id, name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dst_id  ! Destination property list 
-                                          ! identifier 
-    INTEGER(HID_T), INTENT(IN) :: src_id  ! Source property list identifier 
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Property name
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5pcreate_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pcreate_f 
-
-

PURPOSE

-
       Creates a new property as an instance of a property 
-       list class.
-
-

INPUTS

-
  class  - type of the property class to be created.
-           Possible values are:
-             H5P_FILE_CREATE_F
-             H5P_FILE_ACCESS_F
-             H5P_DATASET_CREATE_F
-             H5P_DATASET_XFER_F
-             H5P_FILE_MOUNT_F
-
-

OUTPUTS

-
  prp_id - property list identifier
-  hdferr - error code          
-            Success:  0
-            Failure: -1 
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pcreate_f(class, prp_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class   ! The type of the property list 
-                                          ! to be created. Possible values are: 
-                                          !  H5P_FILE_CREATE_F
-                                          !  H5P_FILE_ACCESS_F
-                                          !  H5P_DATASET_CREATE_F
-                                          !  H5P_DATASET_XFER_F
-                                          !  H5P_FILE_MOUNT_F
-    INTEGER(HID_T), INTENT(OUT) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5pequal_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pequal_f 
-
-

PURPOSE

-
  Checks if two property lists are eqaul
-
-

INPUTS

-
  plist1_id    - property list identifier
-  plist2_id    - property list identifier
-
-

OUTPUTS

-
  flag         - flag, possible values
-                   .TRUE. or .FALSE.
-  hdferr:      - error code            
-                  Success:  0
-                  Failure: -1, flag is set to .FALSE.   
-
-

AUTHOR

-
  Elena Pourmal
-  September 30, 2002   
-
-

SOURCE

-
  SUBROUTINE h5pequal_f(plist1_id, plist2_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist1_id ! Property list identifier 
-    INTEGER(HID_T), INTENT(IN) :: plist2_id ! Property list identifier 
-    LOGICAL, INTENT(OUT)       :: flag      ! Flag
-    INTEGER, INTENT(OUT)       :: hdferr    ! Error code
-                                            !  0 on success and -1 on failure
-
- -
- -

h5pexist_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pexist_f 
-
-

PURPOSE

-
  Queries whether a property name exists in a property list or class. 
-
-

INPUTS

-
  prp_id       - property list identifier to query
-  name         - name of property to check for
-
-

OUTPUTS

-
  flag         - logical flag
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pexist_f(prp_id, name, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to modify
-    LOGICAL, INTENT(OUT) :: flag          ! .TRUE. if exists, .FALSE. otherwise
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-                                    ! 0 on success and -1 on failure
-
- -
- -

h5pfill_value_defined_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pfill_value_defined_f
-
-

PURPOSE

-
  Check if fill value is defined.
-
-

INPUTS

-
  plist_id     - dataset creation property list identifier
-
-

OUTPUTS

-
  flag         - fill value status flag
-                 Possible values are:
-                   H5D_FILL_VALUE_ERROR_F
-                   H5D_FILL_VALUE_UNDEFINED_F
-                   H5D_FILL_VALUE_DEFAULT_F
-                   H5D_FILL_VALUE_USER_DEFINED_F
-  hdferr       - error code            
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 4, 2002
-
-

SOURCE

-
  SUBROUTINE h5pfill_value_defined_f(plist_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id  ! Dataset creation property list identifier
-    INTEGER, INTENT(OUT) :: flag            ! Fill value status flag
-                                            !  H5D_FILL_VALUE_ERROR_F
-                                            !  H5D_FILL_VALUE_UNDEFINED_F
-                                            !  H5D_FILL_VALUE_DEFAULT_F
-                                            !  H5D_FILL_VALUE_USER_DEFINED_F
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-                                            ! 0 on success and -1 on failure
-
- -
- -

h5pget_alignment_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_alignment_f 
-
-

PURPOSE

-
  Retrieves the current settings for alignment 
-  properties from a file access property list. 
-
-

INPUTS

-
  prp_id       - file access property list identifier
-
-

OUTPUTS

-
  threshold    - threshold value       
-  alignment    - alignment value
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_alignment_f(prp_id, threshold,  alignment, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id       ! Property list identifier 
-    INTEGER(HSIZE_T), INTENT(OUT) :: threshold ! Threshold value
-    INTEGER(HSIZE_T), INTENT(OUT) :: alignment ! alignment value
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-                                             ! 0 on success and -1 on failure
-
- -
- -

h5pget_alloc_time_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_alloc_time_f
-
-

PURPOSE

-
  Get space allocation time for dataset during creation.
-
-

INPUTS

-
  plist_id     - dataset creation property list identifier
-
-

OUTPUTS

-
  flag         - allocation time flag:
-                   H5D_ALLOC_TIME_ERROR_F
-                   H5D_ALLOC_TIME_DEFAULT_F
-                   H5D_ALLOC_TIME_EARLY_F
-                   H5D_ALLOC_TIME_LATE_F
-                   H5D_ALLOC_TIME_INCR_F
-  hdferr:      - error code            
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 4, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pget_alloc_time_f(plist_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id  ! Dataset creation property list identifier
-    INTEGER, INTENT(OUT) :: flag   ! Allocation time flag:
-                                   !  H5D_ALLOC_TIME_ERROR_F
-                                   !  H5D_ALLOC_TIME_DEFAULT_F
-                                   !  H5D_ALLOC_TIME_EARLY_F
-                                   !  H5D_ALLOC_TIME_LATE_F
-                                   !  H5D_ALLOC_TIME_INCR_F
-    INTEGER, INTENT(OUT) :: hdferr ! Error code
-                                   ! 0 on success and -1 on failure
-
- -
- -

H5Pget_attr_creation_order_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pget_attr_creation_order_f
-
-

PURPOSE

-
  Retrieves tracking and indexing settings for attribute creation order
-
-

INPUTS

-
  ocpl_id         - Object (group or dataset) creation property list identifier
-
-

OUTPUTS

-
  crt_order_flags - Flags specifying whether to track and index attribute creation order
-  hdferr          - Error code         
-                       Success:  0
-                       Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February, 2008
-
-

SOURCE

-
  SUBROUTINE h5pget_attr_creation_order_f(ocpl_id, crt_order_flags, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: ocpl_id   ! Object (group or dataset) creation property list identifier 
-    INTEGER, INTENT(OUT) :: crt_order_flags ! Flags specifying whether to track and index attribute creation order 
-    INTEGER, INTENT(OUT) :: hdferr   ! Error code
-                                     ! 0 on success and -1 on failure
-
- -
- -

H5Pget_attr_phase_change_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pget_attr_phase_change_f 
-
-

PURPOSE

-
  Retrieves attribute storage phase change thresholds 
-
-

INPUTS

-
  ocpl_id         - Object (dataset or group) creation property list identifier
-
-

OUTPUTS

-
  max_compact     - Maximum number of attributes to be stored in compact storage
-                    (Default: 8)
-  min_dense       - Minimum number of attributes to be stored in dense storage
-                    (Default: 6)
-  hdferr          - Error code         
-                     Success:  0
-                     Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5pget_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: ocpl_id ! Object (dataset or group) creation property list identifier
-    INTEGER, INTENT(OUT) :: max_compact   ! Maximum number of attributes to be stored in compact storage
-                                          ! (Default: 8)
-    INTEGER, INTENT(OUT) :: min_dense     ! Minimum number of attributes to be stored in dense storage
-                                          ! (Default: 6)
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5pget_btree_ratios_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_btree_ratios_f
-
-

PURPOSE

-
  Gets B-tree split ratios for a dataset transfer property list
-
-

INPUTS

-
  prp_id       - the dataset transfer property list 
-                 identifier 
-
-

OUTPUTS

-
  left         - the B-tree split ratio for left-most nodes 
-  middle       - the B-tree split ratio for all other nodes
-  right        - the B-tree split ratio for right-most nodes
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pget_btree_ratios_f(prp_id, left, middle, right, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-    REAL, INTENT(OUT) :: left   ! The B-tree split ratio for left-most nodes.
-    REAL, INTENT(OUT) :: middle ! The B-tree split ratio for all other nodes 
-    REAL, INTENT(OUT) :: right  ! The B-tree split ratio for right-most 
-                                !  nodes and lone nodes.
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-                                    ! 0 on success and -1 on failure
-
- -
- -

h5pget_buffer_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_buffer_f 
-
-

PURPOSE

-
  Gets size for conversion buffer
-
-

INPUTS

-
  plist_id     - data transfer property list identifier
-
-

OUTPUTS

-
  size         - buffer size 
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 2, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pget_buffer_f(plist_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! Data transfer property list identifier 
-    INTEGER(HSIZE_T), INTENT(OUT) :: size  ! Buffer size in bytes; 
-                                           !  buffer is allocated and freed by 
-                                           !  the library.
-    INTEGER, INTENT(OUT)       :: hdferr   ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pget_cache_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_cache_f 
-
-

PURPOSE

-
  Queries the meta data cache and raw data chunk cache 
-  parameters.  
-
-

INPUTS

-
  prp_id       - file access property list identifier
-
-

OUTPUTS

-
  mdc_nelmts   - number of elements (objects) in the meta 
-                 data cache 
-  rdcc_nelmts  - number of elements (objects) in the raw 
-                 data chunk cache 
-  rdcc_nbytes  - total size of the raw data chunk cache, in bytes 
-  rdcc_w0      - preemption policy (0 or 1)
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-  Bug fix: type of the rdcc_nelmts parameter should be INTEGER
-  instead of INTEGER(SIZE_T) October 10, 2003 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_cache_f(prp_id, mdc_nelmts, rdcc_nelmts, rdcc_nbytes, rdcc_w0, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: mdc_nelmts   ! Number of elements (objects)
-                                         !  in the meta data cache
-    INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nelmts  ! Number of elements (objects)
-                                                 !  in the meta data cache
-    INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nbytes  ! Total size of the raw data 
-                                                 !  chunk cache, in bytes 
-    REAL, INTENT(OUT) :: rdcc_w0                 ! Preemption policy
-    INTEGER, INTENT(OUT) :: hdferr               ! Error code
-                                                 ! 0 on success and -1 on failure
-
- -
- -

H5Pget_char_encoding_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pget_char_encoding_f
-
-

PURPOSE

-
  Retrieves the character encoding used to create a string
-
-

INPUTS

-
  plist_id - Property list identifier
-
-

OUTPUTS

-
  encoding - Valid values for encoding are:
-               H5T_CSET_ASCII_F -> US ASCII
-               H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
-  hdferr   - Error code                
-               Success:  0
-               Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 3, 2008
-
-

SOURCE

-
  SUBROUTINE  h5pget_char_encoding_f(plist_id, encoding, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! Property list identifier
-
-    INTEGER, INTENT(OUT) :: encoding       ! Valid values for encoding are:
-                                           !  H5T_CSET_ASCII_F -> US ASCII
-                                           !  H5T_CSET_UTF8_F  -> UTF-8 Unicode encoding
-    INTEGER, INTENT(OUT) :: hdferr   ! Error code
-                                     ! 0 on success and -1 on failure
-
- -
- -

H5Pget_chunk_cache_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pget_chunk_cache_f
-
-

PURPOSE

-
  Retrieves the maximum possible number of elements in the meta
-  data cache and the maximum possible number of elements and
-  bytes and the RDCC_W0 value in the raw data chunk cache.  Any
-  (or all) arguments may be null pointers in which case the
-  corresponding datum is not returned.  If these properties have
-  not been set on this property list, the default values for a
-  file access property list are returned.
-
-

INPUTS

-
  dapl_id            - Dataset access property list identifier.
-
-

OUTPUTS

-
  rdcc_nslots        - Number of chunk slots in the raw data chunk cache hash table. 
-  rdcc_nbytes        - Total size of the raw data chunk cache, in bytes. 
-  rdcc_w0            - Preemption policy. 
-  hdferr             - Error code              
-                        Success:  0
-                        Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 13, 2009
-
-

HISTORY

-

SOURCE

-
  SUBROUTINE h5pget_chunk_cache_f(dapl_id, rdcc_nslots, rdcc_nbytes, rdcc_w0, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dapl_id       ! Dataset access property list identifier.
-    INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nslots ! Number of chunk slots in the raw data chunk cache hash table.
-    INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nbytes ! Total size of the raw data chunk cache, in bytes. 
-    REAL, INTENT(OUT) :: rdcc_w0                ! Preemption policy.
-    INTEGER, INTENT(OUT) :: hdferr              ! Error code:
-                                                ! 0 on success and -1 on failure
-
- -
- -

h5pget_chunk_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_chunk_f 
-
-

PURPOSE

-
  Retrieves the size of chunks for the raw data of a 
-  chunked layout dataset
-
-

INPUTS

-
  prp_id       - property list identifier
-  ndims        - size of dims array
-
-

OUTPUTS

-
  dims         - array with dimension sizes for each chunk
-  hdferr       - error code            
-                  Success:  number of chunk dimensions
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_chunk_f(prp_id, ndims, dims, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: ndims         ! Number of chunk dimensions to
-                                         ! to return
-    INTEGER(HSIZE_T), DIMENSION(ndims), INTENT(OUT) :: dims    
-                                         ! Array containing sizes of
-                                         ! chunk dimensions
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code:
-                                         !  number of chunk dimensions on success,
-                                         !  -1 on failure
-
- -
- -

h5pget_class_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_class_f 
-
-

PURPOSE

-
  Returns the property list class for a property list.
-
-

INPUTS

-
  prp_id       - property list identifier
-
-

OUTPUTS

-
  classtype    - property list class
-                 Possible values are:
-                  H5P_ROOT_F
-                  H5P_FILE_CREATE_F
-                  H5P_FILE_ACCESS_F
-                  H5PE_DATASET_CREATE_F
-                  H5P_DATASET_XFER_F
-                  H5P_FILE_MOUNT_F
-  hdferr:      - error code            
-                  Success:  0
-                  Failure: -1 
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pget_class_f(prp_id, classtype, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: classtype    ! The type of the property list 
-                                         ! to be created. Possible values are: 
-                                         !  H5P_ROOT_F
-                                         !  H5P_FILE_CREATE_F
-                                         !  H5P_FILE_ACCESS_F
-                                         !  H5PE_DATASET_CREATE_F 
-                                         !  H5P_DATASET_XFER_F
-                                         !  H5P_FILE_MOUNT_F
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pget_class_name_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_class_name_f 
-
-

PURPOSE

-
  Queries the name of a class.
-
-

INPUTS

-
  prp_id       - property list identifier to query
-
-

OUTPUTS

-
  name         - name of a class
-  size         - Actual length of the class name
-                   NOTE: If provided buffer "name" is smaller,
-                   than name will be truncated to fit into
-                   provided user buffer
-  hdferr:      - error code
-                  Success: 0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002      
-
-

HISTORY

-
 Returned the size of name as an argument      
-
-

SOURCE

-
  SUBROUTINE h5pget_class_name_f(prp_id, name, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
-    CHARACTER(LEN=*), INTENT(OUT) :: name ! Buffer to retireve class name
-    INTEGER, INTENT(OUT) :: size          ! Actual length of the class name
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5pget_class_parent_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_class_parent_f 
-
-

PURPOSE

-
  Retrieves the parent class of a genric property class. 
-
-

INPUTS

-
  prp_id       - property list identifier to query
-
-

OUTPUTS

-
  parent_id    - identifier of the parent class
-  hdferr:      - error code          
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pget_class_parent_f(prp_id, parent_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id     ! Property list identifier 
-    INTEGER(HID_T), INTENT(OUT) :: parent_id ! Parent class property list 
-                                             ! identifier 
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-                                    ! 0 on success and -1 on failure
-
- -
- -

h5pget_copy_object_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_copy_object_f 
-
-

PURPOSE

-
  Retrieves the properties to be used when an object is copied.
-
-

INPUTS

-
  ocp_plist_id - Object copy property list identifier
-
-

OUTPUTS

-
  copy_options - Copy option(s) to be get
-  hdferr       - Error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 3, 2008
-
-

HISTORY

-

SOURCE

-
  SUBROUTINE h5pget_copy_object_f(ocp_plist_id, copy_options, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: ocp_plist_id ! Object copy property list identifier
-    INTEGER, INTENT(OUT) :: copy_options       ! Valid copy options returned are:
-                                               !   H5O_COPY_SHALLOW_HIERARCHY_F
-                                               !   H5O_COPY_EXPAND_SOFT_LINK_F 
-                                               !   H5O_COPY_EXPAND_EXT_LINK_F
-                                               !   H5O_COPY_EXPAND_REFERENCE_F
-                                               !   H5O_COPY_WITHOUT_ATTR_FLAG_F
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-                                               ! 0 on success and -1 on failure
-
- -
- -

H5Pget_create_inter_group_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pget_create_inter_group_f
-
-

PURPOSE

-
  Determines whether property is set to enable creating missing intermediate groups.
-
-

INPUTS

-
  lcpl_id            - Link creation property list identifier
-  crt_intermed_group - Specifying whether to create intermediate groups upon 
-                       the creation of an object
-
-

OUTPUTS

-
  hdferr             - Error code              
-                        Success:  0
-                        Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 4, 2008
-
-

HISTORY

-
 The long subroutine name (>31) on older f90 compilers causes problems
-          so the name was shortened
-
-

SOURCE

-
  SUBROUTINE h5pget_create_inter_group_f(lcpl_id, crt_intermed_group, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: lcpl_id      ! Link creation property list identifier
-    INTEGER, INTENT(IN) :: crt_intermed_group  ! Flag specifying whether to create intermediate groups
-                                               ! upon creation of an object
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-                                               ! 0 on success and -1 on failure
-
- -
- -

h5pget_data_transform_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_data_transform_f 
-
-

PURPOSE

-
  Retrieves a data transform expression.
-
-

INPUTS

-
  plist_id   - Identifier of the property list or class
-
-

OUTPUTS

-
  expression - buffer to hold transform expression
-  hdferr     - Error code
-                 Success:  Actual lenght of the expression
-                           If provided buffer "expression" is 
-                           smaller, than expression will be 
-                           truncated to fit into
-                           provided user buffer
-                 Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 19, 2008
-
-

HISTORY

-
 Should hdferr return just 0 or 1 and add another arguement for the size?
-
-

SOURCE

-
SUBROUTINE h5pget_data_transform_f(plist_id, expression, hdferr, size)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id         ! Identifier of the property list or class
-    CHARACTER(LEN=*), INTENT(OUT) :: expression    ! Buffer to hold transform expression
-    INTEGER(SIZE_T), INTENT(OUT), OPTIONAL :: size ! Registered size of the transform expression
-    INTEGER, INTENT(OUT) :: hdferr                 ! Error code
-                                                   !  0 on success and -1 on failure
-
- -
- -

h5pget_driver_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_driver_f 
-
-

PURPOSE

-
  Returns low-lever driver identifier. 
-
-

INPUTS

-
  prp_id  - file access or data transfer property 
-            list identifier. 
-
-

OUTPUTS

-
  driver  - low-level driver identifier
-  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_driver_f(prp_id, driver, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
-    INTEGER(HID_T), INTENT(OUT) :: driver ! Low-level file driver identifier
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5pget_edc_check_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_edc_check_f 
-
-

PURPOSE

-
  Queries error detecting  
-
-

INPUTS

-
  prp_id       - dataset creation property list identifier
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  March 13, 2003
-
-

SOURCE

-
  SUBROUTINE h5pget_edc_check_f(prp_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset transfer property list identifier 
-    INTEGER, INTENT(OUT) :: flag         ! Checksum filter flag
-                                         ! May have one of the following values:
-                                         !  H5Z_ERROR_EDC_F
-                                         !  H5Z_DISABLE_EDC_F
-                                         !  H5Z_ENABLE_EDC_F
-                                         !  H5Z_NO_EDC_F
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

H5Pget_est_link_info_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pget_est_link_info_f 
-
-

PURPOSE

-
  Queries data required to estimate required local heap or object header size.
-
-

INPUTS

-
  gcpl_id         - Group creation property list identifier
-
-

OUTPUTS

-
  est_num_entries - Estimated number of links to be inserted into group
-  est_name_len    - Estimated average length of link names
-  hdferr          - Error code
-                     Success:  0
-                     Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 21, 2008
-
-

HISTORY

-

SOURCE

-
  SUBROUTINE h5pget_est_link_info_f(gcpl_id, est_num_entries, est_name_len, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: gcpl_id   ! Group creation property list identifier  
-    INTEGER, INTENT(OUT) :: est_num_entries ! Estimated number of links to be inserted into group
-    INTEGER, INTENT(OUT) :: est_name_len    ! Estimated average length of link names
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-                                            ! 0 on success and -1 on failure
-
- -
- -

h5pget_external_count_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_external_count_f 
-
-

PURPOSE

-
  Returns the number of external files for a dataset. 
-
-

INPUTS

-
  prp_id       - dataset creation property list identifier
-
-

OUTPUTS

-
  count        - number of external files for the 
-                 specified dataset
-  hdferr       - error code            
-                   Success:  0
-                   Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pget_external_count_f (prp_id, count, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: count        ! Number of external files for the 
-                                         ! Specified dataset
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pget_external_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_external_f 
-
-

PURPOSE

-
  Returns information about an external file. 
-
-

INPUTS

-
  prp_id       - dataset creation property list identifier
-
-

OUTPUTS

-
  idx          - external file index 
-  name_size    - maximum size of name array
-  name         - name of the external file     
-  name         - name of external file
-  offset       - offset in bytes from the beginning of the 
-                 file to the location in the file
-                 where the data starts
-  bytes        - size of the external file data
-  hdferr       - error code            
-                  Success:  0
-                   Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pget_external_f(prp_id, idx, name_size, name, offset,bytes, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-    INTEGER, INTENT(IN) :: idx           ! External file index.
-    INTEGER(SIZE_T), INTENT(IN) :: name_size ! Maximum length of name array 
-    CHARACTER(LEN=*), INTENT(OUT) :: name    ! Name of an external file
-    INTEGER, INTENT(OUT) :: offset           ! Offset, in bytes, from the beginning 
-                                             !  of the file to the location in the file 
-                                             !  where the data starts.
-    INTEGER(HSIZE_T), INTENT(OUT) :: bytes   ! Number of bytes reserved in the 
-                                             !  file for the data
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-                                             ! 0 on success and -1 on failure
-
- -
- -

h5pget_fapl_core_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_fapl_core_f 
-
-

PURPOSE

-
  Queries core file driver properties. 
-
-

INPUTS

-
  prp_id        - file access property list identifier
-
-

OUTPUTS

-
  increment     - size, in bytes, of memory increments 
-  backing_store - boolean flag indicating whether to write 
-                  the file contents to disk when the file is closed. 
-  hdferr        - error code           
-                   Success:  0
-                   Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_fapl_core_f(prp_id, increment, backing_store, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id      ! Property list identifier 
-    INTEGER(SIZE_T), INTENT(OUT) :: increment ! File block size in bytes.
-    LOGICAL, INTENT(OUT) :: backing_store   ! Flag to indicate that
-                                            ! entire file contents are flushed to a file 
-                                            ! with the same name as this core file.
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-                                            ! 0 on success and -1 on failure
-
- -
- -

h5pget_fapl_direct_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_fapl_direct_f
-
-

PURPOSE

-
  Gets up use of the direct I/O driver.
-
-

INPUTS

-
  fapl_id      - File access property list identifier
-
-

OUTPUTS

-
  alignment    - Required memory alignment boundary
-  block_size   - File system block size
-  cbuf_size    - Copy buffer size
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 21, 2008
-
-

SOURCE

-
  SUBROUTINE h5pget_fapl_direct_f(fapl_id, alignment, block_size, cbuf_size, hdferr)
-    IMPLICIT NONE  
-    INTEGER(HID_T), INTENT(IN) :: fapl_id       ! File access property list identifier
-    INTEGER(SIZE_T), INTENT(OUT) :: alignment   ! Required memory alignment boundary!
-    INTEGER(SIZE_T), INTENT(OUT) :: block_size  ! File system block size
-    INTEGER(SIZE_T), INTENT(OUT) :: cbuf_size   ! Copy buffer size
-    INTEGER, INTENT(OUT) :: hdferr              ! Error code
-                                                ! 0 on success and -1 on failure
-
- -
- -

h5pget_fapl_family_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_fapl_family_f 
-
-

PURPOSE

-
  Returns file access property list information.       
-
-

INPUTS

-
  prp_id       - file access property list identifier
-
-

OUTPUTS

-
  memb_size    - size in bytes of each file member 
-  memb_plist   - identifier of the file access property 
-                 list to be used for each family member
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_fapl_family_f(prp_id, memb_size, memb_plist , hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id       ! Property list identifier 
-    INTEGER(HSIZE_T), INTENT(OUT) :: memb_size ! Logical size, in bytes,
-                                               ! of each family member
-    INTEGER(HID_T), INTENT(OUT) :: memb_plist  ! Identifier of the file 
-                                               ! access property list for 
-                                               ! each member of the family
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-                                               ! 0 on success and -1 on failure
-
- -
- -

h5pget_fapl_multi_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_fapl_multi_f 
-
-

PURPOSE

-
  Sets up use of the multi-file driver. 
-
-

INPUTS

-
  prp_id       - file creation property list identifier
-
-

OUTPUTS

-
  mem_map      - mapping array
-  memb_fapl    - property list for each memory usage type
-  memb_name    - names of member file
-  relax        - flag 
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

OPTIONAL PARAMETERS

-
  maxlen_out   - maximum length for memb_name array element 
-
-

AUTHOR

-
  Elena Pourmal
-  24 March 2003
-
-

SOURCE

-
  SUBROUTINE h5pget_fapl_multi_f(prp_id, memb_map, memb_fapl, memb_name, memb_addr, relax, hdferr, maxlen_out)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! File creation property list identifier 
-    INTEGER, DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(OUT) :: memb_map
-    INTEGER(HID_T), DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(OUT) :: memb_fapl
-    CHARACTER(LEN=*), DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(OUT) :: memb_name
-    !INTEGER(HADDR_T), DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(OUT) :: memb_addr
-    REAL, DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(OUT) :: memb_addr
-    INTEGER, OPTIONAL, INTENT(OUT) :: maxlen_out 
-    LOGICAL, INTENT(OUT) :: relax
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pget_fclose_degree_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_fclose_degree_f 
-
-

PURPOSE

-
  Returns the degree for the file close behavior.
-
-

INPUTS

-
  fapl_id      - File access property list identifier
-
-

OUTPUTS

-
  degree       - Possible values are:
-                  H5F_CLOSE_DEFAULT_F
-                  H5F_CLOSE_WEAK_F
-                  H5F_CLOSE_SEMI_F
-                  H5F_CLOSE_STRONG_F
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  September 26, 2002   
-
-

HISTORY

-

SOURCE

-
  SUBROUTINE h5pget_fclose_degree_f(fapl_id, degree, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: fapl_id ! File Access Property list identifier 
-    INTEGER, INTENT(OUT) :: degree        ! Possible values are: 
-                                          !  H5F_CLOSE_DEFAULT_F
-                                          !  H5F_CLOSE_WEAK_F
-                                          !  H5F_CLOSE_SEMI_F
-                                          !  H5F_CLOSE_STRONG_F
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5pget_fill_time_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_fill_time_f
-
-

PURPOSE

-
  Get fill value writing time for dataset
-
-

INPUTS

-
  plist_id     - dataset creation property list identifier
-
-

OUTPUTS

-
  hdferr:      - error code            
-                  Success:  0
-                  Failure: -1
-
-

OPTIONAL PARAMETERS

-
  flag         - fill time flag:
-                  H5D_FILL_TIME_ERROR_F
-                  H5D_FILL_TIME_ALLOC_F
-                  H5D_FILL_TIME_NEVER_F
-
-

AUTHOR

-
  Elena Pourmal
-  October 4, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pget_fill_time_f(plist_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id  ! Dataset creation property list identifier
-    INTEGER, INTENT(OUT) :: flag   ! Fill time flag:
-                                   !  H5D_FILL_TIME_ERROR_F
-                                   !  H5D_FILL_TIME_ALLOC_F
-                                   !  H5D_FILL_TIME_NEVER_F
-    INTEGER, INTENT(OUT) :: hdferr ! Error code
-                                   ! 0 on success and -1 on failure
-
- -
- -

h5pget_filter_by_id_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_filter_by_id_f 
-
-

PURPOSE

-
  Returns information about a filter in a pipeline
-
-

INPUTS

-
  prp_id       - data creation or transfer property list 
-                 identifier
-
-

OUTPUTS

-
  filter_id    - filter identifier
-  flags        - bit vector specifying certain general
-                 properties of the filter
-  cd_nelmts    - number of elements in cd_values
-  cd_values    - auxiliary data for the filter
-  namelen      - number of characters in the name buffer
-  name         - buffer to retrieve filter name
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  April 10 2003
-
-

SOURCE

-
  SUBROUTINE h5pget_filter_by_id_f(prp_id, filter_id, flags, cd_nelmts, cd_values, namelen, name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id   ! Property list identifier 
-    INTEGER, INTENT(IN) :: filter_id       ! Filter identifier
-    INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts     ! Number of elements in cd_values.
-    INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values ! Auxiliary data for the filter.
-    INTEGER, INTENT(OUT) :: flags          ! Bit vector specifying certain general
-                                           ! properties of the filter.
-    INTEGER(SIZE_T), INTENT(IN) :: namelen ! Anticipated number of characters in name.
-    CHARACTER(LEN=*), INTENT(OUT) :: name  ! Name of the filter
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pget_filter_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_filter_f 
-
-

PURPOSE

-
  Returns information about a filter in a pipeline
-
-

INPUTS

-
  prp_id        - data creation or transfer property list 
-                  identifier
-  filter_number - sequence number within the filter
-                  pipeline of the filter for which 
-                  information is sought
-
-

OUTPUTS

-
  filter_id    - filter identification number
-  flags        - bit vector specifying certain general
-                 properties of the filter
-  cd_nelmts    - number of elements in cd_values
-  cd_values    - auxiliary data for the filter
-  namelen      - number of characters in the name buffer
-  name         - buffer to retrieve filter name
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pget_filter_f(prp_id, filter_number, flags, cd_nelmts, cd_values, namelen, name, filter_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: filter_number ! Sequence number within the filter
-                                         !  pipeline of the filter for which 
-                                         !  information is sought
-    INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values  ! Auxiliary data for the filter.
-    INTEGER, INTENT(OUT) :: flags        ! Bit vector specifying certain general
-                                         !  properties of the filter.
-    INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts  ! Number of elements in cd_values.
-    INTEGER(SIZE_T), INTENT(IN) :: namelen       ! Anticipated number of characters in name.
-    CHARACTER(LEN=*), INTENT(OUT) :: name        ! Name of the filter
-    INTEGER, INTENT(OUT) :: filter_id            ! Filter identification number  
-    INTEGER, INTENT(OUT) :: hdferr               ! Error code
-                                                 ! 0 on success and -1 on failure
-
- -
- -

h5pget_gc_references_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_gc_references_f 
-
-

PURPOSE

-
  Returns garbage collecting references setting.       
-
-

INPUTS

-
  prp_id       - file access property list identifier
-
-

OUTPUTS

-
  gc_reference - flag for stting garbage collection on 
-                 and off (1 or 0)
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_gc_references_f(prp_id, gc_reference, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: gc_reference ! The flag for garbage collecting
-                                         !  references for the file
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pget_istore_k_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_istore_k_f 
-
-

PURPOSE

-
  Queries the 1/2 rank of an indexed storage B-tree. 
-
-

INPUTS

-
  prp_id       - file creation property list identifier
-
-

OUTPUTS

-
  ik           - 1/2 rank of chunked storage B-tree
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_istore_k_f(prp_id, ik, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: ik           ! 1/2 rank of chunked storage B-tree
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pget_layout_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_layout_f 
-
-

PURPOSE

-
  Returns the layout of the raw data for a dataset. 
-
-

INPUTS

-
  prp_id       - data creation property list identifier
-
-

OUTPUTS

-
  layout       - type of storage layout for raw data
-                 possible values are:
-                  H5D_COMPACT_F
-                  H5D_CONTIGUOUS_F
-                  H5D_CHUNKED_F
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pget_layout_f (prp_id, layout, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: layout       ! Type of storage layout for raw data
-                                         ! possible values are:
-                                         !  H5D_COMPACT_F(0)
-                                         !  H5D_CONTIGUOUS_F(1)
-                                         !  H5D_CHUNKED_F(2)
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

H5Pget_link_creation_order_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pget_link_creation_order_f
-
-

PURPOSE

-
  Queries whether link creation order is tracked and/or indexed in a group.
-
-

INPUTS

-
  gcpl_id - Group creation property list identifier
-
-

OUTPUTS

-
  crt_order_flags - Creation order flag(s)
-  hdferr          - Error code         
-                     Success:  0
-                     Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 3, 2008
-
-

SOURCE

-
  SUBROUTINE h5pget_link_creation_order_f(gcpl_id, crt_order_flags, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: gcpl_id   ! Group creation property list identifier
-    INTEGER, INTENT(OUT) :: crt_order_flags ! Creation order flag(s)
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-                                            ! 0 on success and -1 on failure
-
- -
- -

H5Pget_link_phase_change_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pget_link_phase_change_f
-
-

PURPOSE

-
  Queries the settings for conversion between compact and dense groups.
-
-

INPUTS

-
  gcpl_id      - Group creation property list identifier
-
-

OUTPUTS

-
  max_compact  - Maximum number of attributes to be stored in compact storage
-  min_dense    - Minimum number of attributes to be stored in dense storage
-  hdferr       - Error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 20, 2008
-
-

SOURCE

-
  SUBROUTINE h5pget_link_phase_change_f(gcpl_id, max_compact, min_dense, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: gcpl_id ! Group creation property list identifier
-    INTEGER, INTENT(OUT) :: max_compact   ! Maximum number of attributes to be stored in compact storage
-    INTEGER, INTENT(OUT) :: min_dense     ! Minimum number of attributes to be stored in dense storage
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

H5Pget_local_heap_size_hint_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pget_local_heap_size_hint_f 
-
-

PURPOSE

-
  Queries the local heap size hint for original-style groups.
-
-

INPUTS

-
  gcpl_id   - Group creation property list identifier
-
-

OUTPUTS

-
  size_hint - Hint for size of local heap
-  hdferr    - Error code
-               Success:  0
-               Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 21, 2008
-
-

SOURCE

-
  SUBROUTINE h5pget_local_heap_size_hint_f(gcpl_id, size_hint, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: gcpl_id     ! Group creation property list identifier
-    INTEGER(SIZE_T), INTENT(OUT) :: size_hint ! Hint for size of local heap
-    INTEGER, INTENT(OUT) :: hdferr            ! Error code
-                                              ! 0 on success and -1 on failure
-
- -
- -

h5pget_meta_block_size_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_meta_block_size_f 
-
-

PURPOSE

-
  Gets the minimum size of metadata block allocations 
-
-

INPUTS

-
  plist_id     - file access property list identifier
-
-

OUTPUTS

-
  size         - metatdata block size
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 7, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pget_meta_block_size_f(plist_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id  ! File access property list identifier 
-    INTEGER(HSIZE_T), INTENT(OUT) :: size   ! Block size in bytes; 
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-                                            ! 0 on success and -1 on failure
-
- -
- -

h5pget_nfilters_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_nfilters_f 
-
-

PURPOSE

-
  Returns the number of filters in the pipeline. 
-
-

INPUTS

-
  prp_id       - data creation or transfer property list 
-                 identifier
-
-

OUTPUTS

-
  nfilters     - number of filters in the pipeline
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pget_nfilters_f (prp_id, nfilters, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: nfilters     ! The number of filters in the pipeline
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pget_nlinks_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_nlinks_f 
-
-

PURPOSE

-
  Gets maximum number of soft or user-defined link traversals.
-
-

INPUTS

-
  lapl_id - File access property list identifier
-  nlinks  - Maximum number of links to traverse
-
-

OUTPUTS

-
  hdferr  - error code
-             Success:  0
-             Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 24, 2008
-
-

SOURCE

-
  SUBROUTINE h5pget_nlinks_f(lapl_id, nlinks, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: lapl_id  ! File access property list identifier
-    INTEGER(SIZE_T), INTENT(OUT) :: nlinks ! Maximum number of links to traverse
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pget_npros_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_npros_f 
-
-

PURPOSE

-
  Queries number of properties in property list or class
-
-

INPUTS

-
  prp_id       - iproperty list identifier to query
-
-

OUTPUTS

-
  nprops       - number of properties in property object
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pget_nprops_f(prp_id, nprops, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id    ! Property list identifier 
-    INTEGER(SIZE_T), INTENT(OUT) :: nprops  ! Number of properties
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-                                            ! 0 on success and -1 on failure
-
- -
- -

H5Pget_obj_track_times_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pget_obj_track_times_f 
-
-

PURPOSE

-
  Returns whether times are tracked for an object.
-
-

INPUTS

-
  plist_id     - property list id
-  flag         - object timestamp setting
-                 .TRUE.,.FALSE.
-
-

OUTPUTS

-
  hdferr       - error code            
-                 Success:  0
-                 Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 22, 2008
-
-

SOURCE

-
  SUBROUTINE h5pget_obj_track_times_f(plist_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property 
-                                           ! list identifier 
-    LOGICAL, INTENT(OUT) :: flag   ! Object timestamp setting
-    INTEGER, INTENT(OUT) :: hdferr ! Error code
-                                   ! 0 on success and -1 on failure
-
- -
- -

h5pget_preserve_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_preserve_f 
-
-

PURPOSE

-
  Checks status of the dataset transfer property list.
-
-

INPUTS

-
  prp_id  - property list identifier
-
-

OUTPUTS

-
  flag    - status flag
-  hdferr  - error code         
-       Success:  0
-       Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001
- 
-  Datatype of the flag parameter is changed from 
-  INTEGER to LOGICAL 
-  June 4, 2003 
-
-

SOURCE

-
  SUBROUTINE h5pget_preserve_f(prp_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    LOGICAL, INTENT(OUT) ::  flag        ! TRUE/FALSE flag. Shows status of the dataset's
-                                         ! transfer property for partial writing/reading
-                                         ! compound datatype
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pget_sec2_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_sec2_f 
-
-

PURPOSE

-
  NOT AVAILABLE
-
-

INPUTS

-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
- SOURCE!          SUBROUTINE h5pget_sec2_f (prp_id, sec2, hdferr) 
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-            INTEGER, INTENT(OUT) :: sec2   ! value indicates whether the file
-            INTEGER, INTENT(OUT) :: hdferr  ! Error code
- 0 on success and -1 on failure
-
- -
- -

h5pget_sieve_buf_size_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_sieve_buf_size_f 
-
-

PURPOSE

-
  Gets the maximum size of the data sieve buffer
-
-

INPUTS

-
  plist_id     - file access property list identifier
-
-

OUTPUTS

-
  size         - sieve buffer size
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 7, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pget_sieve_buf_size_f(plist_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list identifier 
-    INTEGER(SIZE_T), INTENT(OUT) :: size   ! Buffer size in bytes 
-    INTEGER, INTENT(OUT)       :: hdferr   ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pget_size_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_size_f 
-
-

PURPOSE

-
  Queries the size of a property value in bytes.
-
-

INPUTS

-
  prp_id       - property list identifier to query
-  name         - name of property to query
-
-

OUTPUTS

-
  size         - size of property in bytes
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002      
-
-

HISTORY

-

SOURCE

-
  SUBROUTINE h5pget_size_f(prp_id, name, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to query
-    INTEGER(SIZE_T), INTENT(OUT) :: size  ! Size in bytes
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5pget_sizes_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_sizes_f 
-
-

PURPOSE

-
  Retrieves the size of the offsets and lengths used 
-  in an HDF5 file
-
-

INPUTS

-
  prp_id       - file creation property list identifier
-
-

OUTPUTS

-
  sizeof_addr  - size of an object offset in bytes 
-  sizeof_size  - size of an object length in bytes
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_sizes_f(prp_id, sizeof_addr, sizeof_size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id        ! Property list identifier 
-    INTEGER(SIZE_T), INTENT(OUT) :: sizeof_addr ! Size of an object
-                                                ! offset in bytes 
-    INTEGER(SIZE_T), INTENT(OUT) :: sizeof_size ! Size of an object
-                                                ! length in bytes 
-    INTEGER, INTENT(OUT) :: hdferr              ! Error code
-                                                ! 0 on success and -1 on failure
-
- -
- -

h5pget_small_data_block_size_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_small_data_block_size_f 
-
-

PURPOSE

-
  Gets the minimum size of "small" raw data block
-
-

INPUTS

-
  plist_id     - file access property list identifier
-
-

OUTPUTS

-
  size         - small raw data block size
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 7, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pget_small_data_block_size_f(plist_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id  ! File access property list identifier 
-    INTEGER(HSIZE_T), INTENT(OUT) :: size   ! Small raw data block size
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-                                            ! 0 on success and -1 on failure
-
- -
- -

h5pget_split_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pget_split_f 
-
-

PURPOSE

-
  NOT AVAILABLE
-
-

INPUTS

-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
!          SUBROUTINE h5pget_split_f(prp_id, meta_ext_size, meta_ext, meta_plist,raw_ext_size,&
-!                                     raw_ext, raw_plist, hdferr)
-!            IMPLICIT NONE
-!            INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-!            INTEGER(SIZE_T), INTENT(IN) :: meta_ext_size ! Number of characters of the meta
-                                                         ! file extension to be copied to the
-                                                         ! meta_ext buffer
-
-!            CHARACTER(LEN=*), INTENT(OUT) :: meta_ext  !Name of the extension for
-                                                      !the metafile filename
-!            INTEGER(HID_T), INTENT(OUT) :: meta_plist  ! Identifier of the meta file
-                                                      ! access property list
-!            INTEGER(SIZE_T), INTENT(IN) :: raw_ext_size ! Number of characters of the raw
-                                                         ! file extension to be copied to the
-                                                         ! raw_ext buffer
-!            CHARACTER(LEN=*), INTENT(OUT) :: raw_ext  !Name extension for the raw file filename
-!            INTEGER(HID_T), INTENT(OUT) :: raw_plist  !Identifier of the raw file
-                                                     !access property list
-!            INTEGER, INTENT(OUT) :: hdferr  ! Error code
-                                     ! 0 on success and -1 on failure
-
- -
- -

h5pget_stdio_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_stdio_f 
-
-

PURPOSE

-
  NOT AVAILABLE
-
-

INPUTS

-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
!          SUBROUTINE h5pget_stdio_f (prp_id, io, hdferr)
-!
-!            IMPLICIT NONE
-!            INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-!            INTEGER, INTENT(OUT) :: io   ! value indicates that the file
-                                         !access property list is set to
-                                         !the stdio driver
-!            INTEGER, INTENT(OUT) :: hdferr  ! Error code
-                                     ! 0 on success and -1 on failure
-
- -
- -

h5pget_sym_k_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_sym_k_f 
-
-

PURPOSE

-
  Retrieves the size of the symbol table B-tree 1/2 rank
-  and the symbol table leaf node 1/2 size. 
-
-

INPUTS

-
  prp_id       - file creation property list identifier
-
-

OUTPUTS

-
  ik           - symbol table tree 1/2 rank
-  lk           - symbol table node 1/2 size
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_sym_k_f(prp_id, ik, lk, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: ik           ! Symbol table tree rank
-    INTEGER, INTENT(OUT) :: lk           ! Symbol table node size
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pget_userblock_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_userblock_f 
-
-

PURPOSE

-
  Gets user block size.
-
-

INPUTS

-
  prp_id       - file creation property list identifier
-
-

OUTPUTS

-
  block_size   - size of the user block in bytes
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_userblock_f(prp_id, block_size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id         ! Property list identifier 
-    INTEGER(HSIZE_T), INTENT(OUT) ::  block_size ! Size of the 
-                                                 ! user-block in bytes 
-    INTEGER, INTENT(OUT) :: hdferr               ! Error code
-                                                 ! 0 on success and -1 on failure
-
- -
- -

h5pget_version_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pget_version_f 
-
-

PURPOSE

-
  Retrieves the version information of various objects 
-  for a file creation property list
-
-

INPUTS

-
  prp_id       - file createion property list identifier
-
-

OUTPUTS

-
  boot         - super block version number
-  freelist     - global freelist version number
-  stab         - symbol table version number
-  shhdr        - shared object header version number
-  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pget_version_f(prp_id, boot, freelist, &
-       stab, shhdr, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id        ! Property list identifier 
-    INTEGER, DIMENSION(:), INTENT(OUT) :: boot  ! Array to put boot
-                                                ! block version number
-    INTEGER, DIMENSION(:), INTENT(OUT) :: freelist  ! Array to put global
-                                                    ! Freelist version number
-
-    INTEGER, DIMENSION(:), INTENT(OUT) :: stab  ! Array to put symbol
-                                                ! table version number
-    INTEGER, DIMENSION(:), INTENT(OUT) :: shhdr ! Array to put shared
-                                                ! object header version number
-    INTEGER, INTENT(OUT) :: hdferr              ! Error code
-                                                ! 0 on success and -1 on failure
-
- -
- -

h5pisa_class_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pisa_class_f 
-
-

PURPOSE

-
  Determines whether a property list is a member of a class. 
-
-

INPUTS

-
  plist        - property list identifier 
-  pclass       - identifier of the property class
-
-

OUTPUTS

-
  flag         - .TRUE. if a member, .FALSE. otherwise
-  hdferr:      - error code           
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pisa_class_f(plist, pclass, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist     ! Property list identifier 
-    INTEGER(HID_T), INTENT(IN) :: pclass    ! Class identifier
-    LOGICAL, INTENT(OUT) :: flag            ! logical flag
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-                                    ! 0 on success and -1 on failure
-
- -
- -

h5pmodify_filter_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pmodify_filter_f 
-
-

PURPOSE

-
  Adds a filter to the filter pipeline. 
-
-

INPUTS

-
  prp_id       - data creation or transfer property list 
-                 identifier
-  filter       - filter to be modified
-  flags        - bit vector specifying certain general
-                 properties of the filter
-  cd_nelmts    - number of elements in cd_values
-  cd_values    - auxiliary data for the filter
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  April 10 2003
-
-

SOURCE

-
  SUBROUTINE h5pmodify_filter_f(prp_id, filter, flags, cd_nelmts, cd_values,  hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: filter        ! Filter to be modified
-    INTEGER, INTENT(IN) :: flags         ! Bit vector specifying certain general
-                                         !  properties of the filter
-    INTEGER(SIZE_T), INTENT(IN) :: cd_nelmts       ! Number of elements in cd_values
-    INTEGER, DIMENSION(*), INTENT(IN) :: cd_values ! Auxiliary data for the filter
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5premove_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5premove_f 
-
-

PURPOSE

-
  Removes a property from a property list. 
-
-

INPUTS

-
  plid         - Property list identofoer
-  name         - name of the property to remove
-
-

OUTPUTS

-
  hdferr:      - error code
-                  Success: 0 
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002      
-
-

SOURCE

-
  SUBROUTINE h5premove_f(plid, name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plid   ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to remove
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         !  0 on success and -1 on failure
-
- -
- -

h5premove_filter_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5premove_filter_f 
-
-

PURPOSE

-
  Delete one or more filters from the filter pipeline. 
-
-

INPUTS

-
  prp_id       - data creation or transfer property list 
-                 identifier
-  filter       - filter to be removed
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Quincey Koziol
-  January 27 2004
-
-

SOURCE

-
  SUBROUTINE h5premove_filter_f(prp_id, filter, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset creation property list
-                                         ! identifier
-    INTEGER, INTENT(IN) :: filter        ! Filter to be removed
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_alignment_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_alignment_f 
-
-

PURPOSE

-
  Sets alignment properties of a file access property list. 
-
-

INPUTS

-
  prp_id       - file access property list identifier
-  threshold    - threshold value       
-  alignment    - alignment value
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_alignment_f(prp_id, threshold,  alignment, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id      ! Property list identifier 
-    INTEGER(HSIZE_T), INTENT(IN) :: threshold ! Threshold value
-    INTEGER(HSIZE_T), INTENT(IN) :: alignment ! alignment value
-    INTEGER, INTENT(OUT) :: hdferr            ! Error code
-                                              ! 0 on success and -1 on failure
-
- -
- -

h5pset_alloc_time_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_alloc_time_f
-
-

PURPOSE

-
  Set space allocation time for dataset during creation.
-
-

INPUTS

-
  plist_id     - dataset creation property list identifier
-  flag         - allocation time flag:
-                   H5D_ALLOC_TIME_ERROR_F
-                   H5D_ALLOC_TIME_DEFAULT_F
-                   H5D_ALLOC_TIME_EARLY_F
-                   H5D_ALLOC_TIME_LATE_F
-                   H5D_ALLOC_TIME_INCR_F
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 4, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pset_alloc_time_f(plist_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id  ! Dataset creation property list identifier
-    INTEGER, INTENT(IN) :: flag             ! Allocation time flag:
-                                            !  H5D_ALLOC_TIME_ERROR_F
-                                            !  H5D_ALLOC_TIME_DEFAULT_F
-                                            !  H5D_ALLOC_TIME_EARLY_F
-                                            !  H5D_ALLOC_TIME_LATE_F
-                                            !  H5D_ALLOC_TIME_INCR_F
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-                                            ! 0 on success and -1 on failure
-
- -
- -

H5Pset_attr_creation_order_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pset_attr_creation_order_f 
-
-

PURPOSE

-
  Sets tracking and indexing of attribute creation order
-
-

INPUTS

-
  ocpl_id         - Object creation property list identifier
-  crt_order_flags - Flags specifying whether to track and index attribute creation order
-
-

OUTPUTS

-
  hdferr          - Error code         
-                     Success:  0
-                     Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5pset_attr_creation_order_f(ocpl_id, crt_order_flags , hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: ocpl_id   ! Object (dataset or group) creation property list identifier
-    INTEGER, INTENT(IN) :: crt_order_flags  ! Flags specifying whether to track and index attribute creation order
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-                                            ! 0 on success and -1 on failure
-
- -
- -

H5Pset_attr_phase_change_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pset_attr_phase_change_f 
-
-

PURPOSE

-
  Sets attribute storage phase change thresholds.
-
-

INPUTS

-
  ocpl_id - Object (dataset or group) creation property list identifier
-
-

OUTPUTS

-
  max_compact     - Maximum number of attributes to be stored in compact storage
-                    (Default: 8)
-  min_dense       - Minimum number of attributes to be stored in dense storage
-                    (Default: 6)
-  hdferr          - Error code         
-                     Success:  0
-                     Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: ocpl_id ! Object (dataset or group) creation property list identifier
-    INTEGER, INTENT(IN) :: max_compact    ! Maximum number of attributes to be stored in compact storage
-                                          !(Default: 8)
-    INTEGER, INTENT(IN) :: min_dense      ! Minimum number of attributes to be stored in dense storage
-                                          ! (Default: 6)
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5pset_btree_ratios_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pset_btree_ratios_f 
-
-

PURPOSE

-
  Sets B-tree split ratios for a dataset transfer 
-  property list. 
-
-

INPUTS

-
  prp_id       - the dataset transfer property list 
-                 identifier 
-  left         - the B-tree split ratio for left-most nodes 
-  middle       - the B-tree split ratio for all other nodes
-  right        - the B-tree split ratio for right-most nodes
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pset_btree_ratios_f(prp_id, left, middle, right, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
-    REAL, INTENT(IN) :: left   ! The B-tree split ratio for left-most nodes.
-    REAL, INTENT(IN) :: middle ! The B-tree split ratio for all other nodes 
-    REAL, INTENT(IN) :: right  ! The B-tree split ratio for right-most 
-                               !  nodes and lone nodes. 
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-                                    ! 0 on success and -1 on failure
-
- -
- -

h5pset_buffer_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_buffer_f 
-
-

PURPOSE

-
  Sets sixe for conversion buffer
-
-

INPUTS

-
  plist_id     - data transfer property list identifier
-  size         - buffer size 
-
-

OUTPUTS

-
  hdferr:      - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 2, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pset_buffer_f(plist_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! Data transfer property list identifier 
-    INTEGER(HSIZE_T), INTENT(IN) :: size   ! Buffer size in bytes; 
-                                           ! buffer is allocated and freed by 
-                                           ! the library.
-    INTEGER, INTENT(OUT)       :: hdferr   ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pset_cache_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pset_cache_f 
-
-

PURPOSE

-
  Sets the meta data cache and raw data chunk 
-  cache parameters
-
-

INPUTS

-
  prp_id       - file access property list identifier
-  mdc_nelmts   - number of elements (objects) in the meta 
-                 data cache 
-  rdcc_nelmts  - number of elements (objects) in the raw 
-                 data chunk cache 
-  rdcc_nbytes  - total size of the raw data chunk cache, in bytes 
-  rdcc_w0      - preemption policy (0 or 1)
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_cache_f(prp_id, mdc_nelmts,rdcc_nelmts, rdcc_nbytes, rdcc_w0, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: mdc_nelmts    ! Number of elements (objects)
-                                         !  in the meta data cache
-    INTEGER(SIZE_T), INTENT(IN) :: rdcc_nelmts ! Number of elements (objects)
-                                               !  in the meta data cache
-    INTEGER(SIZE_T), INTENT(IN) :: rdcc_nbytes ! Total size of the raw data 
-                                               !  chunk cache, in bytes 
-    REAL, INTENT(IN) :: rdcc_w0                ! Preemption policy
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-                                               !  0 on success and -1 on failure
-
- -
- -

H5Pset_char_encoding_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pset_char_encoding_f
-
-

PURPOSE

-
  Sets the character encoding used to encode a string.
-
-

INPUTS

-
  plist_id - Property list identifier
-  encoding - Valid values for encoding are:
-               H5T_CSET_ASCII_F -> US ASCII
-               H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
-
-

OUTPUTS

-
  hdferr   - Error code                
-               Success:  0
-               Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 3, 2008
-
-

SOURCE

-
  SUBROUTINE h5pset_char_encoding_f(plist_id, encoding, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! Property list identifier
-    INTEGER, INTENT(IN) :: encoding        ! String encoding character set:
-                                           !   H5T_CSET_ASCII_F -> US ASCII
-                                           !   H5T_CSET_UTF8_F  -> UTF-8 Unicode encoding
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

H5Pset_chunk_cache_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pset_chunk_cache_f
-
-

PURPOSE

-
  Set the number of objects in the meta data cache and the
-  maximum number of chunks and bytes in the raw data chunk cache.
-  Once set, these values will override the values in the file access
-  property list.  Each of these values can be individually unset
-  (or not set at all) by passing the macros:
-    H5D_CHUNK_CACHE_NSLOTS_DFLT_F,
-    H5D_CHUNK_CACHE_NBYTES_DFLT_F, and/or
-    H5D_CHUNK_CACHE_W0_DFLT_F
-    as appropriate.
-
-  The RDCC_W0 value should be between 0 and 1 inclusive and
-  indicates how much chunks that have been fully read or fully
-  written are favored for preemption.  A value of zero means
-  fully read or written chunks are treated no differently than
-  other chunks (the preemption is strictly LRU) while a value
-  of one means fully read chunks are always preempted before
-  other chunks.
-
-

INPUTS

-
  dapl_id          - Dataset access property list identifier.
-  rdcc_nslots      - The number of chunk slots in the raw data chunk cache for this dataset.
-  rdcc_nbytes      - The total size of the raw data chunk cache for this dataset.
-  rdcc_w0          - The chunk preemption policy for this dataset.
-
-

OUTPUTS

-
  hdferr           - Error code                
-                       Success:  0
-                       Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 13, 2009
-
-

HISTORY

-

SOURCE

-
  SUBROUTINE h5pset_chunk_cache_f(dapl_id, rdcc_nslots, rdcc_nbytes, rdcc_w0, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dapl_id      ! Dataset access property list identifier.
-    INTEGER(SIZE_T), INTENT(IN) :: rdcc_nslots ! The number of chunk slots in the raw data 
-                                               ! chunk cache for this dataset.
-    INTEGER(SIZE_T), INTENT(IN) :: rdcc_nbytes ! The total size of the raw data chunk cache 
-                                               ! for this dataset.
-    REAL, INTENT(IN) :: rdcc_w0                ! The chunk preemption policy for this dataset.
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-                                               ! 0 on success and -1 on failure
-
- -
- -

h5pset_chunk_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pset_chunk_f 
-
-

PURPOSE

-
  Sets the size of the chunks used to store 
-  a chunked layout dataset. 
-
-

INPUTS

-
  prp_id  - datatset creation property list identifier
-  ndims   - number of dimensions for each chunk
-  dims    - array with dimension sizes for each chunk
-
-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
   Explicit Fortran interfaces were added for 
-   called C functions (it is needed for Windows
-   port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_chunk_f(prp_id, ndims, dims, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: ndims         ! Number of chunk dimensions
-    INTEGER(HSIZE_T), DIMENSION(ndims), INTENT(IN) :: dims    
-                                         ! Array containing sizes of
-                                         ! chunk dimensions
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_copy_object_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_copy_object_f 
-
-

PURPOSE

-
  Sets properties to be used when an object is copied.
-
-

INPUTS

-
  ocp_plist_id - Object copy property list identifier
-  copy_options - Copy option(s) to be set
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 3, 2008
-
-

HISTORY

-

SOURCE

-
  SUBROUTINE h5pset_copy_object_f(ocp_plist_id, copy_options, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: ocp_plist_id ! Object copy property list identifier
-    INTEGER, INTENT(IN) :: copy_options ! Copy option(s) to be set, valid options are:
-                                        !   H5O_COPY_SHALLOW_HIERARCHY_F
-                                        !   H5O_COPY_EXPAND_SOFT_LINK_F
-                                        !   H5O_COPY_EXPAND_EXT_LINK_F
-                                        !   H5O_COPY_EXPAND_REFERENCE_F
-                                        !   H5O_COPY_WITHOUT_ATTR_FLAG_F
-    INTEGER, INTENT(OUT) :: hdferr      ! Error code
-                                        ! 0 on success and -1 on failure
-
- -
- -

H5Pset_create_inter_group_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pset_create_inter_group_f
-
-

PURPOSE

-
  Specifies in property list whether to create missing intermediate groups.
-
-

INPUTS

-
  lcpl_id            - Link creation property list identifier
-  crt_intermed_group - crt_intermed_group specifying whether 
-                       to create intermediate groups upon the creation 
-                       of an object
-
-

OUTPUTS

-
  hdferr             - Error code              
-                         Success:  0
-                         Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 22, 2008
-
-

HISTORY

-
 The long subroutine name (>31) on older f90 compilers causes problems
-          so had to shorten the name
-
-

SOURCE

-
  SUBROUTINE h5pset_create_inter_group_f(lcpl_id, crt_intermed_group, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: lcpl_id      ! Link creation property list identifier
-    INTEGER, INTENT(IN) :: crt_intermed_group  ! specifying whether to create intermediate groups
-                                               ! upon the creation of an object
-    INTEGER, INTENT(OUT) :: hdferr ! Error code
-                                   ! 0 on success and -1 on failure
-
- -
- -

h5pset_data_transform_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_data_transform_f 
-
-

PURPOSE

-
  Sets a data transform expression.
-
-

INPUTS

-
  plist_id   - Identifier of the property list or class 
-  expression - Buffer to hold transform expression
-
-

OUTPUTS

-
  hdferr     - error code
-                 Success:  0
-                 Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 19, 2008
-
-

SOURCE

-
  SUBROUTINE h5pset_data_transform_f(plist_id, expression, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id     ! Identifier of the property list or class
-    CHARACTER(LEN=*), INTENT(IN) :: expression ! Buffer to hold transform expression
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-                                               ! 0 on success and -1 on failure
-
- -
- -

h5pset_deflate_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pset_deflate_f 
-
-

PURPOSE

-
   Sets compression method and compression level. 
-
-

INPUTS

-
   prp_id  - property list identifier
-   level   - compression level
-
-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1
-
-

AUTHOR

-
       Elena Pourmal
-               August 12, 1999
-
-

HISTORY

-
       Explicit Fortran interfaces were added for 
-                       called C functions (it is needed for Windows
-                       port).  March 14, 2001
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_deflate_f(prp_id, level, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: level         ! Compression level 
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_edc_check_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_edc_check_f 
-
-

PURPOSE

-
  Enables/disables error detecting  
-
-

INPUTS

-
  prp_id       - dataset creation property list identifier
-  flag         - EDC flag; possible values:
-                   H5Z_DISABLE_EDC_F
-                   H5Z_ENABLE_EDC_F
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  March 13, 2003
-
-

SOURCE

-
  SUBROUTINE h5pset_edc_check_f(prp_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: flag          ! Checksum filter flag
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_est_link_info_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_est_link_info_f 
-
-

PURPOSE

-
  Sets estimated number of links and length of link names in a group.
-
-

INPUTS

-
 gcpl_id         - Group creation property list identifier  
- est_num_entries - Estimated number of links to be inserted into group
- est_name_len    - Estimated average length of link names
-
-

OUTPUTS

-
  hdferr         - Error code
-                    Success:  0
-                    Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 21, 2008
-
-

SOURCE

-
  SUBROUTINE h5pset_est_link_info_f(gcpl_id, est_num_entries, est_name_len, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: gcpl_id  ! Group creation property list identifier  
-    INTEGER, INTENT(IN) :: est_num_entries ! Estimated number of links to be inserted into group
-    INTEGER, INTENT(IN) :: est_name_len    ! Estimated average length of link names
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pset_external_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pset_external_f 
-
-

PURPOSE

-
  Adds an external file to the list of external files. 
-
-

INPUTS

-
  prp_id       - dataset creation property list identifier
-  name         - name of external file
-  offset       - offset in bytes from the beginning of the 
-                 file to the location in the file
-                 where the data starts
-  bytes        - size of the external file data. 
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pset_external_f(prp_id, name, offset,bytes, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of an external file
-    INTEGER, INTENT(IN) :: offset         ! Offset, in bytes, from the beginning 
-                                          !  of the file to the location in the file 
-                                          !  where the data starts.
-    INTEGER(HSIZE_T), INTENT(IN) :: bytes ! Number of bytes reserved in the 
-                                          !  file for the data
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5pset_fapl_core_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pset_fapl_core_f 
-
-

PURPOSE

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

INPUTS

-
  prp_id           - file access property list identifier
-  increment        - size, in bytes, of memory increments 
-  backing_store    - boolean flag indicating whether to write 
-                     the file contents to disk when the file is closed. 
-
-

OUTPUTS

-
  hdferr           - error code                
-                       Success:  0
-                       Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_fapl_core_f(prp_id, increment, backing_store, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id     ! Property list identifier 
-    INTEGER(SIZE_T), INTENT(IN) :: increment ! File block size in bytes.
-    LOGICAL, INTENT(IN) :: backing_store ! Flag to indicate that
-                                         ! entire file contents are flushed to a file 
-                                         ! with the same name as this core file.
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_fapl_direct_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_fapl_direct_f
-
-

PURPOSE

-
  Sets up use of the direct I/O driver.
-
-

INPUTS

-
  fapl_id      - File access property list identifier
-  alignment    - Required memory alignment boundary
-  block_size   - File system block size
-  cbuf_size    - Copy buffer size
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 21, 2008
-
-

SOURCE

-
SUBROUTINE h5pset_fapl_direct_f(fapl_id, alignment, block_size, cbuf_size, hdferr)
-    IMPLICIT NONE  
-    INTEGER(HID_T), INTENT(IN) :: fapl_id     ! File access property list identifier
-    INTEGER(SIZE_T), INTENT(IN) :: alignment  ! Required memory alignment boundary!
-    INTEGER(SIZE_T), INTENT(IN) :: block_size ! File system block size
-    INTEGER(SIZE_T), INTENT(IN) :: cbuf_size  ! Copy buffer size
-    INTEGER, INTENT(OUT) :: hdferr            ! Error code
-                                              ! 0 on success and -1 on failure
-
- -
- -

h5pset_fapl_multi_l

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_fapl_multi_l 
-
-

PURPOSE

-
  Sets up use of the multi-file driver. 
-
-

INPUTS

-
  prp_id       - file creation property list identifier
-  mem_map      - mapping array
-  memb_fapl    - property list for each memory usage type
-  memb_name    - names of member file
-  relax        - flag 
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  20 March 2003
-
-

SOURCE

-
  SUBROUTINE h5pset_fapl_multi_l(prp_id, memb_map, memb_fapl, memb_name, memb_addr, relax, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! File creation property list identifier 
-    INTEGER, DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(IN) :: memb_map ! Mapping array
-    INTEGER(HID_T), DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(IN) :: memb_fapl ! Property list for each memory usage type
-    CHARACTER(LEN=*), DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(IN) :: memb_name ! Names of member file
-    REAL, DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(IN) :: memb_addr 
-    LOGICAL, INTENT(IN) :: relax     ! Flag
-    INTEGER, INTENT(OUT) :: hdferr   ! Error code
-                                     ! 0 on success and -1 on failure
-
- -
- -

h5pset_fapl_multi_s

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_fapl_multi_s 
-
-

PURPOSE

-
  Sets up use of the multi-file driver. 
-
-

INPUTS

-
  prp_id       - file creation property list identifier
-  relax        - flag 
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  31 March 2003
-
-

SOURCE

-
  SUBROUTINE h5pset_fapl_multi_s(prp_id, relax, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! File creation property list identifier 
-    LOGICAL, INTENT(IN) :: relax
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_fapl_sec2_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_fapl_sec2_f 
-
-

PURPOSE

-
  Sets the sec2 driver. 
-
-

INPUTS

-
  prp_id  - file access property list identifier
-
-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_fapl_sec2_f (prp_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_fapl_split_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pset_fapl_split_f 
-
-

PURPOSE

-
  Emulates the old split file driver. 
-
-

INPUTS

-
  prp_id       - file access property list identifier
-  meta_ext     - name of the extension for the metafile 
-                 filename
-  meta_plist   - identifier of the meta file access property 
-                 list
-  raw_ext      - name extension for the raw file filename
-  raw_plist    - identifier of the raw file access property list
-
-

OUTPUTS

-
  hdferr       - error code            
-                   Success:  0
-                   Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_fapl_split_f(prp_id, meta_ext, meta_plist, raw_ext, raw_plist, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id     ! Property list identifier 
-    CHARACTER(LEN=*), INTENT(IN) :: meta_ext ! Name of the extension for
-                                             !  the metafile filename
-    INTEGER(HID_T), INTENT(IN) :: meta_plist ! Identifier of the meta file
-                                             !  access property list
-    CHARACTER(LEN=*), INTENT(IN) :: raw_ext  ! Name extension for the raw file filename
-    INTEGER(HID_T), INTENT(IN) :: raw_plist  ! Identifier of the raw file 
-                                             !  access property list
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-                                             ! 0 on success and -1 on failure
-
- -
- -

h5pset_fapl_stdio_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_fapl_stdio_f 
-
-

PURPOSE

-
  Sets the standard I/O driver. 
-
-

INPUTS

-
  prp_id  - file access property list identifier
-
-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_fapl_stdio_f (prp_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_fclose_degree_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_fclose_degree_f 
-
-

PURPOSE

-
  Sets the degree for the file close behavior.
-
-

INPUTS

-
  fapl_id      - file access property list identifier
-  degree       - Possible values are:
-                   H5F_CLOSE_DEFAULT_F
-                   H5F_CLOSE_WEAK_F
-                   H5F_CLOSE_SEMI_F
-                   H5F_CLOSE_STRONG_F
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  September 26, 2002   
-
-

SOURCE

-
  SUBROUTINE h5pset_fclose_degree_f(fapl_id, degree, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: fapl_id ! File Access Property list identifier 
-    INTEGER, INTENT(IN) :: degree         ! Possible values are: 
-                                          !  H5F_CLOSE_DEFAULT_F
-                                          !  H5F_CLOSE_WEAK_F
-                                          !  H5F_CLOSE_SEMI_F
-                                          !  H5F_CLOSE_STRONG_F
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

h5pset_fill_time_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_fill_time_f
-
-

PURPOSE

-
  Set fill value writing time for dataset
-
-

INPUTS

-
  plist_id     - dataset creation property list identifier
-  flag         - fill time flag:
-                   H5D_FILL_TIME_ERROR_F
-                   H5D_FILL_TIME_ALLOC_F
-                   H5D_FILL_TIME_NEVER_F
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 4, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pset_fill_time_f(plist_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id  ! Dataset creation property list identifier
-    INTEGER, INTENT(IN) :: flag             ! Fill time flag:
-                                            !  H5D_FILL_TIME_ERROR_F
-                                            !  H5D_FILL_TIME_ALLOC_F
-                                            !  H5D_FILL_TIME_NEVER_F
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-                                            ! 0 on success and -1 on failure
-
- -
- -

h5pset_filter_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_filter_f 
-
-

PURPOSE

-
  Adds a filter to the filter pipeline. 
-
-

INPUTS

-
  prp_id       - data creation or transfer property list 
-                 identifier
-  filter       - filter to be added to the pipeline 
-  flags        - bit vector specifying certain general
-                 properties of the filter
-  cd_nelmts    - number of elements in cd_values
-  cd_values    - auxiliary data for the filter
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  February, 2003
-
-

SOURCE

-
  SUBROUTINE h5pset_filter_f(prp_id, filter, flags, cd_nelmts, cd_values,  hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: filter        ! Filter to be added to the pipeline.
-    INTEGER, INTENT(IN) :: flags         ! Bit vector specifying certain general
-                                       !  properties of the filter.
-    INTEGER(SIZE_T), INTENT(IN) :: cd_nelmts       ! Number of elements in cd_values.
-    INTEGER, DIMENSION(*), INTENT(IN) :: cd_values ! Auxiliary data for the filter.
-    INTEGER, INTENT(OUT) :: hdferr                 ! Error code
-                                                 ! 0 on success and -1 on failure
-
- -
- -

h5pset_fletcher32_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_fletcher32_f 
-
-

PURPOSE

-
  Sets Fletcher32 checksum of EDC for a dataset creation 
-  property list.
-
-

INPUTS

-
  prp_id       - dataset creation property list identifier
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  March 13, 2003
-
-

SOURCE

-
  SUBROUTINE h5pset_fletcher32_f(prp_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_gc_references_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pset_gc_references_f 
-
-

PURPOSE

-
  Sets garbage collecting references flag. 
-
-

INPUTS

-
  prp_id       - file access property list identifier
-  gc_reference - flag for stting garbage collection on 
-                 and off (1 or 0)
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_gc_references_f (prp_id, gc_reference, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: gc_reference  ! The flag for garbage collecting
-                                         !  references for the file
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_hyper_vector_size_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_hyper_vector_size_f 
-
-

PURPOSE

-
  Set the number of "I/O" vectors (vector size)
-
-

INPUTS

-
  plist_id     - dataset transfer property list identifier
-  size         - vector size
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 7, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pset_hyper_vector_size_f(plist_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset transfer property list identifier 
-    INTEGER(SIZE_T), INTENT(IN) :: size    ! Vector size
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pset_istore_k_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_istore_k_f 
-
-

PURPOSE

-
  Sets the size of the parameter used to control the 
-  B-trees for indexing chunked datasets
-
-

INPUTS

-
  prp_id       - file creation property list identifier
-  ik           - 1/2 rank of chunked storage B-tree
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_istore_k_f (prp_id, ik, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: ik            ! 1/2 rank of chunked storage B-tree
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_layout_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pset_layout_f 
-
-

PURPOSE

-
  Sets the type of storage used store the raw data 
-  for a dataset. 
-
-

INPUTS

-
  prp_id       - data creation property list identifier
-  layout       - type of storage layout for raw data
-                 possible values are:
-                   H5D_COMPACT_F
-                   H5D_CONTIGUOUS_F
-                   H5D_CHUNKED_F
-
-

OUTPUTS

-
  hdferr      - error code             
-                 Success:  0
-                 Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pset_layout_f (prp_id, layout, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: layout        ! Type of storage layout for raw data
-                                         ! possible values are:
-                                         !   H5D_COMPACT_F
-                                         !   H5D_CONTIGUOUS_F
-                                         !   H5D_CHUNKED_F
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

H5Pset_libver_bounds_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
             H5Pset_libver_bounds_f
-
-

PURPOSE

-
    Sets bounds on library versions, and indirectly format versions, to be used when creating objects.
-
-

INPUTS

-
  fapl_id - File access property list identifier
-  low     - The earliest version of the library that will be used for writing objects.
-  high    - The latest version of the library that will be used for writing objects.
-
-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 18, 2008
-
-

SOURCE

-
  SUBROUTINE h5pset_libver_bounds_f(fapl_id, low, high, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: fapl_id ! File access property list identifier
-    INTEGER, INTENT(IN) :: low   ! The earliest version of the library that will be used for writing objects.
-                                 ! Currently, low must be one of two pre-defined values:
-                                 !            HDF_LIBVER_EARLIEST_F
-                                 !            HDF_LIBVER_LATEST_F
-    INTEGER, INTENT(IN) :: high  ! The latest version of the library that will be used for writing objects.
-                                 ! Currently, low must set to the pre-defined value:
-                                 !            HDF_LIBVER_LATEST_F
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-                                    ! 0 on success and -1 on failure
-
- -
- -

H5Pset_link_creation_order_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pset_link_creation_order_f 
-
-

PURPOSE

-
    Sets creation order tracking and indexing for links in a group.
-
-

INPUTS

-
  gcpl_id         - Group creation property list identifier
-  crt_order_flags - Creation order flag(s)
-
-

OUTPUTS

-
  hdferr           - Error code                
-                       Success:  0
-                       Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 18, 2008
-
-

SOURCE

-
  SUBROUTINE h5pset_link_creation_order_f(gcpl_id, crt_order_flags, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: gcpl_id  ! File access property list identifier
-    INTEGER, INTENT(IN) :: crt_order_flags ! Creation order flag(s)
-    INTEGER, INTENT(OUT) :: hdferr   ! Error code
-                                     ! 0 on success and -1 on failure
-
- -
- -

h5pset_link_phase_change_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_link_phase_change_f
-
-

PURPOSE

-
  Sets the parameters for conversion between compact and dense groups.
-
-

INPUTS

-
  gcpl_id         - Group creation property list identifier  
-  max_compact     - Maximum number of attributes to be stored in compact storage
-  min_dense       - Minimum number of attributes to be stored in dense storage
-
-

OUTPUTS

-
  hdferr          - error code         
-                     Success:  0
-                     Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 21, 2008
-
-

SOURCE

-
SUBROUTINE h5pset_link_phase_change_f(gcpl_id, max_compact, min_dense, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: gcpl_id ! Group creation property list identifier
-    INTEGER, INTENT(IN) :: max_compact    ! Maximum number of attributes to be stored in compact storage
-    INTEGER, INTENT(IN) :: min_dense      ! Minimum number of attributes to be stored in dense storage
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-                                          ! 0 on success and -1 on failure
-
- -
- -

H5Pset_local_heap_size_hint_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pset_local_heap_size_hint_f 
-
-

PURPOSE

-
  Sets the local heap size hint for original-style groups.
-
-

INPUTS

-
  gcpl_id   - Group creation property list identifier
-  size_hint - Hint for size of local heap
-
-

OUTPUTS

-
  hdferr    - Error code
-               Success:  0
-               Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 21, 2008
-
-

SOURCE

-
  SUBROUTINE h5pset_local_heap_size_hint_f(gcpl_id, size_hint, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: gcpl_id    ! Group creation property list identifier
-    INTEGER(SIZE_T), INTENT(IN) :: size_hint ! Hint for size of local heap
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-                                             ! 0 on success and -1 on failure
-
- -
- -

H5Pset_nbit_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pset_nbit_f 
-
-

PURPOSE

-
  Sets up the use of the N-Bit filter.
-
-

INPUTS

-
  plist_id - Dataset creation property list identifier.
-
-

OUTPUTS

-
  hdferr   - Error code
-              Success:  0
-              Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 21, 2008
-
-

HISTORY

-

SOURCE

-
  SUBROUTINE h5pset_nbit_f(plist_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property list identifier
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pset_nlinks_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_nlinks_f 
-
-

PURPOSE

-
  Sets maximum number of soft or user-defined link traversals.
-
-

INPUTS

-
  lapl_id - File access property list identifier
-   nlinks - Maximum number of links to traverse
-
-

OUTPUTS

-
  hdferr  - Error code
-             Success:  0
-             Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 24, 2008
-
-

HISTORY

-

SOURCE

-
  SUBROUTINE h5pset_nlinks_f(lapl_id, nlinks, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: lapl_id ! File access property list identifier
-    INTEGER(SIZE_T), INTENT(IN) :: nlinks ! Maximum number of links to traverse
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code   
-                                          ! 0 on success and -1 on failure
-
- -
- -

H5Pset_obj_track_times_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pset_obj_track_times_f 
-
-

PURPOSE

-
  Set whether the birth, access, modification & change times for
-  an object are stored.
-
-  Birth time is the time the object was created.  Access time is
-  the last time that metadata or raw data was read from this
-  object.  Modification time is the last time the data for
-  this object was changed (either writing raw data to a dataset
-  or inserting/modifying/deleting a link in a group).  Change
-  time is the last time the metadata for this object was written
-  (adding/modifying/deleting an attribute on an object, extending
-  the size of a dataset, etc).
-
-   If these times are not tracked, they will be reported as
-   12:00 AM UDT, Jan. 1, 1970 (i.e. 0 seconds past the UNIX
-   epoch) when queried.
-
-

INPUTS

-
  plist_id     - property list id
-  flag         - object timestamp setting
-                 .TRUE.,.FALSE.
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 22, 2008
-       
-
-

SOURCE

-
  SUBROUTINE h5pset_obj_track_times_f(plist_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property
-                                           ! list identifier
-    LOGICAL, INTENT(IN) :: flag    ! Object timestamp setting
-    INTEGER, INTENT(OUT) :: hdferr ! Error code
-                                   ! 0 on success and -1 on failure
-
- -
- -

h5pset_preserve_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
   h5pset_preserve_f 
-
-

PURPOSE

-
  Sets the dataset transfer property list status to 
-  TRUE or FALSE for initializing compound datatype
-  members during write/read operations.
-
-

INPUTS

-
  prp_id       - property list identifier
-  flag         - status flag
-
-

OUTPUTS

-
  hdferr       - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  NONE
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-                       
-  Datatype of the flag parameter is changed from 
-  INTEGER to LOGICAL June 4, 2003
-
-

SOURCE

-
  SUBROUTINE h5pset_preserve_f(prp_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    LOGICAL, INTENT(IN) ::  flag         ! TRUE/FALSE flag to set the dataset
-                                         ! transfer property for partila writing/reading
-                                         ! compound datatype
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_scaleoffset_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_scaleoffset_f 
-
-

PURPOSE

-
  Sets up the use of the Scale-Offset filter.
-
-

INPUTS

-
  plist_id     - Dataset creation property list identifier.
-  scale_type   - Flag indicating compression method.
-  scale_factor - Parameter related to scale.
-
-

OUTPUTS

-
  hdferr        - Error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 21, 2008
-
-

HISTORY

-

SOURCE

-
  SUBROUTINE h5pset_scaleoffset_f(plist_id, scale_type, scale_factor, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property list identifier
-    INTEGER, INTENT(IN) :: scale_type      ! Flag indicating compression method.
-    INTEGER, INTENT(IN) :: scale_factor    ! Parameter related to scale.
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

H5Pset_shared_mesg_index_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pset_shared_mesg_index_f
-
-

PURPOSE

-
  Configures the specified shared object header message index
-
-

INPUTS

-
  fcpl_id         - File creation property list identifier.
-  index_num       - Index being configured.
-  mesg_type_flags - Types of messages that should be stored in this index.
-  min_mesg_size   - Minimum message size.
-
-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5pset_shared_mesg_index_f(fcpl_id, index_num, mesg_type_flags, min_mesg_size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: fcpl_id  ! file creation property list
-    INTEGER, INTENT(IN) :: index_num       ! Index being configured.
-    INTEGER, INTENT(IN) :: mesg_type_flags ! Types of messages that should be stored in this index.
-    INTEGER, INTENT(IN) :: min_mesg_size   ! Minimum message size.
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

H5Pset_shared_mesg_nindexes_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  H5Pset_shared_mesg_nindexes_f 
-
-

PURPOSE

-
  Sets number of shared object header message indexes 
-
-

INPUTS

-
  plist_id - file creation property list
-  nindexes - Number of shared object header message indexes to be available in files created with this property list
-
-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  January, 2008
-
-

SOURCE

-
  SUBROUTINE h5pset_shared_mesg_nindexes_f( plist_id, nindexes, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! File creation property list
-    INTEGER, INTENT(IN) :: nindexes  ! Number of shared object header message indexes 
-                                     !  available in files created WITH this property list
-    INTEGER, INTENT(OUT) :: hdferr   ! Error code
-                                     ! 0 on success and -1 on failure
-
- -
- -

h5pset_shuffle_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_shuffle_f 
-
-

PURPOSE

-
  Sets shuffling filter
-
-

INPUTS

-
  prp_id       - dataset creation property list identifier
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  March 12, 2003
-
-

SOURCE

-
  SUBROUTINE h5pset_shuffle_f(prp_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_sieve_buf_size_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_sieve_buf_size_f 
-
-

PURPOSE

-
  Sets the maximum size of the data sieve buffer
-
-

INPUTS

-
  plist_id     - file access property list identifier
-  size         - sieve buffer size
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 7, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pset_sieve_buf_size_f(plist_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list identifier 
-    INTEGER(SIZE_T), INTENT(IN) :: size    ! Buffer size in bytes; 
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pset_sizes_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_sizes_f 
-
-

PURPOSE

-
  Sets the byte size of the offsets and lengths used 
-  to address objects in an HDF5 file.
-
-

INPUTS

-
  prp_id       - file creation property list identifier
-  sizeof_addr  - size of an object offset in bytes 
-  sizeof_size  - size of an object length in bytes
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_sizes_f (prp_id, sizeof_addr, sizeof_size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id       ! Property list identifier 
-    INTEGER(SIZE_T), INTENT(IN) :: sizeof_addr ! Size of an object 
-                                               !  offset in bytes 
-    INTEGER(SIZE_T), INTENT(IN) :: sizeof_size ! Size of an object 
-                                               !  length in bytes 
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-                                               ! 0 on success and -1 on failure
-
- -
- -

h5pset_small_data_block_size_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_small_data_block_size_f 
-
-

PURPOSE

-
  Sets the minimum size of "small" raw data block
-
-

INPUTS

-
  plist_id     - file access property list identifier
-  size         - small raw data block size
-
-

OUTPUTS

-
  hdferr       - error code            
-                  Success:  0
-                  Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  October 7, 2002      
-
-

SOURCE

-
  SUBROUTINE h5pset_small_data_block_size_f(plist_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list identifier 
-    INTEGER(HSIZE_T), INTENT(IN) :: size   ! Small raw data block size
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-                                           ! 0 on success and -1 on failure
-
- -
- -

h5pset_sym_k_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_sym_k_f 
-
-

PURPOSE

-
  Sets the size of parameters used to control the 
-
-

INPUTS

-
  prp_id  - file creation property list identifier
-  ik      - symbol table tree rank
-  lk      - symbol table node size
-
-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-               
-
-

SOURCE

-
  SUBROUTINE h5pset_sym_k_f (prp_id, ik, lk, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER, INTENT(IN) :: ik            ! Symbol table tree rank 
-    INTEGER, INTENT(IN) :: lk            ! Symbol table node size 
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_szip_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_szip_f 
-
-

PURPOSE

-
  Sets up use of szip compression
-
-

INPUTS

-
  prp_id           - dataset creation property list identifier
-  options_mask     - A bit-mask conveying the desired SZIP options.
-                     Current valid values in Fortran are:
-                        H5_SZIP_EC_OM_F
-                        H5_SZIP_NN_OM_F
-  pixels_per_block - szip parameters
-
-

OUTPUTS

-
  hdferr           - error code                
-                       Success:  0
-                       Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  April 10 2003
-
-

SOURCE

-
  SUBROUTINE h5pset_szip_f(prp_id, options_mask, pixels_per_block, hdferr) 
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset creation property 
-                                         ! list identifier 
-    INTEGER, INTENT(IN) :: options_mask  ! A bit-mask conveying the desired
-                                         ! SZIP options
-                                         ! Current valid values in Fortran are:
-                                         !    H5_SZIP_EC_OM_F
-                                         !    H5_SZIP_NN_OM_F
-    INTEGER, INTENT(IN) :: pixels_per_block ! The number of pixels or data elements 
-                                            ! in each data block
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5pset_userblock_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5pset_userblock_f 
-
-

PURPOSE

-
   Sets user block size
-
-

INPUTS

-
   prp_id - file creation property list to modify
-   size   - size of the user-block in bytes
-
-

OUTPUTS

-
  hdferr  - error code         
-             Success:  0
-             Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999      
-
-

HISTORY

-
  Explicit Fortran interfaces were added for 
-  called C functions (it is needed for Windows
-  port).  March 14, 2001 
-
-

SOURCE

-
  SUBROUTINE h5pset_userblock_f (prp_id, size, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
-    INTEGER(HSIZE_T), INTENT(IN) :: size ! Size of the user-block in bytes 
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5punregister_f

- -

[ Top ] [ Subroutines ]

-

NAME

-
  h5punregister_f 
-
-

PURPOSE

-
  Removes a property from a property list class. 
-
-

INPUTS

-
  class        - Property list class identifier
-  name         - name of the property to remove
-
-

OUTPUTS

-
  hdferr:      - error code
-                  Success: 0 
-                  Failure: -1   
-
-

AUTHOR

-
  Elena Pourmal
-  October 9, 2002      
-
-

SOURCE

-
  SUBROUTINE h5punregister_f(class, name, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: class  ! property list class identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name ! name of property to remove
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-                                         ! 0 on success and -1 on failure
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Rf_c.html b/fortran/doc/DevelGuide/src/H5Rf_c.html deleted file mode 100644 index bba197e..0000000 --- a/fortran/doc/DevelGuide/src/H5Rf_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Rf.c - - - - - -
-
- -

H5Rf

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5R Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Rff_F03_f90.html b/fortran/doc/DevelGuide/src/H5Rff_F03_f90.html deleted file mode 100644 index 3202540..0000000 --- a/fortran/doc/DevelGuide/src/H5Rff_F03_f90.html +++ /dev/null @@ -1,492 +0,0 @@ - - - - - - - -./src/H5Rff_F03.f90 - - - - - -
-
- -

H5R (F03)

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5R_PROVISIONAL
-
-

FILE

-
  fortran/src/H5Rff_F03.f90
-
-

PURPOSE

-
  This file contains Fortran 90 and Fortran 2003 interfaces for H5R functions.
-  It contains the same functions as H5Rff_DEPRECIATE.f90 but includes the
-  Fortran 2003 functions and the interface listings. This file will be compiled
-  instead of H5Rff_DEPRECIATE.f90 if Fortran 2003 functions are enabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5R function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5rcreate_object_f

- -

[ Top ] [ H5R (F03) ] [ Subroutines ]

-

NAME

-
  h5rcreate_object_f
-
-

PURPOSE

-
  Creates reference to the object
-
-

INPUTS

-
  loc_id    - location identifier
-  name      - name of the object at the specified location
-
-

OUTPUTS

-
  ref       - reference to the specified object
-  hdferr:   - error code
-               Success:  0
-               Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

NOTES

-
  This is a module procedure for the h5rcreate_f subroutine.
-
-

SOURCE

-
  SUBROUTINE h5rcreate_object_f(loc_id, name, ref, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! Location identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the object at location specified
-                                           ! by loc_id identifier
-    TYPE(hobj_ref_t_f), INTENT(INOUT), TARGET :: ref   ! Object reference
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5rcreate_ptr_f

- -

[ Top ] [ H5R (F03) ] [ Subroutines ]

-

NAME

-
  h5rcreate_ptr_f
-
-

PURPOSE

-
  Creates a reference.
-
-

INPUTS

-
  loc_id     - location identifier
-  name       - name of the dataset at the specified location
-  ref_type   - type of reference:
-                H5R_OBJECT
-                H5T_STD_REF_DSETREG
-
-

OUTPUTS

-
  ref        - reference created by the function call.
-  hdferr     - error code
-                  Success:  0
-                  Failure: -1
- OPTIONAL
-  space_id   - dataspace identifier that describes selected region
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  June 20, 2008
-
-

NOTES

-
  This is a module procedure for the h5rcreate_f
-  subroutine where the output is a pointer.
-
-

SOURCE

-
  SUBROUTINE h5rcreate_ptr_f(loc_id, name, ref_type, ref, hdferr, space_id)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id     ! Location identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name     ! Name of the dataset at location specified
-                                             ! by loc_id identifier
-    INTEGER, INTENT(IN) :: ref_type          ! type of reference
-    TYPE(C_PTR), INTENT(INOUT) :: ref        ! Reference created by the function call
-    INTEGER, INTENT(OUT) :: hdferr           ! Error code
-    INTEGER(HID_T), INTENT(IN), OPTIONAL :: space_id ! Dataset's dataspace identifier
-
- -
- -

h5rcreate_region_f

- -

[ Top ] [ H5R (F03) ] [ Subroutines ]

-

NAME

-
  h5rcreate_region_f
-
-

PURPOSE

-
  Creates reference to the dataset region
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - name of the dataset at the specified location
-  space_id      - dataspace identifier that describes selected region
-
-

OUTPUTS

-
  ref           - reference to the dataset region
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

NOTES

-
  This is a module procedure for the h5rcreate_f subroutine.
-
-

SOURCE

-
  SUBROUTINE h5rcreate_region_f(loc_id, name, space_id, ref, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! Location identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the dataset at location specified
-                                           ! by loc_id identifier
-    INTEGER(HID_T), INTENT(IN) :: space_id ! Dataset's dataspace identifier
-    TYPE(hdset_reg_ref_t_f), INTENT(INOUT), TARGET :: ref ! Dataset region reference
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5rdereference_object_f

- -

[ Top ] [ H5R (F03) ] [ Subroutines ]

-

NAME

-
  h5rdereference_object_f
-
-

PURPOSE

-
  Opens the HDF5 object referenced
-
-

INPUTS

-
  dset_id  - identifier of the dataset containing
-             reference
-  ref      - reference to open
-
-

OUTPUTS

-
  obj_id   - object_identifier
-  hdferr:  - error code
-              Success:  0
-              Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

NOTES

-
  This is a module procedure for the h5rdereference_f subroutine.
-
-

SOURCE

-
  SUBROUTINE h5rdereference_object_f(obj_id, ref, ref_obj_id, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id          ! Dataset identifier
-    TYPE(hobj_ref_t_f), INTENT(IN), TARGET :: ref ! Object reference
-    INTEGER(HID_T), INTENT(OUT) :: ref_obj_id     ! Object identifier
-    INTEGER, INTENT(OUT) :: hdferr                ! Error code
-
- -
- -

h5rdereference_ptr_f

- -

[ Top ] [ H5R (F03) ] [ Subroutines ]

-

NAME

-
  h5rdereference_ptr_f
-
-

PURPOSE

-
  Opens the HDF5 object referenced.
-
-

INPUTS

-
  obj_id     - valid identifier for the file containing the
-               referenced object or any object in that file.
-  ref_type   - the reference type of ref.
-  ref        - Reference to open.
-
-

OUTPUTS

-
  ref_obj_id - identifier of referenced object
-  hdferr     - error code
-                Success:  0
-                Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  June 20, 2008
-
-

NOTES

-
  This is a module procedure for the h5rdereference_f
-  subroutine using pointers.
-
-

SOURCE

-
  SUBROUTINE h5rdereference_ptr_f(obj_id, ref_type, ref, ref_obj_id, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id  ! Valid identifier for the file containing the
-                                          !  referenced object or any object in that file.
-    INTEGER, INTENT(IN) :: ref_type       ! The reference type of ref.
-    TYPE(C_PTR), INTENT(IN) :: ref        ! Object reference
-    INTEGER(HID_T), INTENT(OUT) :: ref_obj_id
-                                          ! Identifier of referenced object
-    INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5rdereference_region_f

- -

[ Top ] [ H5R (F03) ] [ Subroutines ]

-

NAME

-
  h5rdereference_region_f
-
-

PURPOSE

-
  Opens the dataset region
-
-

INPUTS

-
  dset_id       - identifier of the dataset containing
-                  reference to teh regions
-  ref           - reference to open
-
-

OUTPUTS

-
  obj_id        - dataspace identifier
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

NOTES

-
  This is a module procedure for the h5rdereference_f subroutine.
-
-

SOURCE

-
  SUBROUTINE h5rdereference_region_f(obj_id, ref, ref_obj_id, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id   ! Dataset identifier
-    TYPE(hdset_reg_ref_t_f), INTENT(IN), TARGET :: ref   ! Object reference
-    INTEGER(HID_T), INTENT(OUT) :: ref_obj_id  ! Dataspace identifier
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5rget_name_object_f

- -

[ Top ] [ H5R (F03) ] [ Subroutines ]

-

NAME

-
  h5rget_name_object_f
-
-

PURPOSE

-
  Retrieves a name of a referenced object.
-
-

INPUTS

-
  loc_id    - Identifier for the dataset containing the reference or for the group that dataset is in.
-  ref       - An object or dataset region reference.
-
-

OUTPUTS

-
  name      - A name associated with the referenced object or dataset region.
-
-  hdferr:   - error code
-               Success:  0
-               Failure: -1
-
-

OPTIONAL PARAMETERS

-
  size     - The size of the name buffer.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 28, 2008
-
- SOURCES
- or for the group that dataset is in.
- returning 0 (zero) if no name is associated
- with the identifier
-
- -
- -

h5rget_name_ptr_f

- -

[ Top ] [ H5R (F03) ] [ Subroutines ]

-

NAME

-
  h5rget_name_ptr_f
-
-

PURPOSE

-
  Retrieves a name of a referenced object.
-
-

INPUTS

-
  loc_id   - Identifier for the dataset containing the reference or
-             for the group that dataset is in.
-  ref_type - Type of reference.
-  ref      - An object or dataset region reference.
-
-

OUTPUTS

-
  name     - A name associated with the referenced object or dataset ptr.
-
-  hdferr   - error code
-               Success:  0
-               Failure: -1
-
-

OPTIONAL PARAMETERS

-
   size   - The size of the name buffer.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 28, 2008
-
-

SOURCE

-
  SUBROUTINE h5rget_name_ptr_f(loc_id, ref_type, ref, name, hdferr, size)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! Identifier for the dataset containing the reference
-                                           !  or for the group that dataset is in.
-    INTEGER, INTENT(IN) :: ref_type ! Type of reference.
-    TYPE(C_PTR), INTENT(IN) :: ref  ! An object or dataset region reference.
-    CHARACTER(LEN=*), INTENT(OUT) :: name  ! A name associated with the referenced object or dataset ptr.
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-    INTEGER(SIZE_T), OPTIONAL, INTENT(OUT) :: size   ! The size of the name buffer,
-                                                     ! returning 0 (zero) if no name is associated
-                                                     ! with the identifier
-
- -
- -

h5rget_name_region_f

- -

[ Top ] [ H5R (F03) ] [ Subroutines ]

-

NAME

-
  h5rget_name_region_f
-
-

PURPOSE

-
  Retrieves a name of a dataset region.
-
-

INPUTS

-
  loc_id  - Identifier for the dataset containing the reference or
-            for the group that dataset is in.
-  ref     - An object or dataset region reference.
-
-

OUTPUTS

-
  name    - A name associated with the referenced object or dataset region.
-  hdferr  - error code
-              Success:  0
-              Failure: -1
-
-

OPTIONAL PARAMETERS

-
  size    - The size of the name buffer.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 28, 2008
-
-

SOURCE

-
  SUBROUTINE h5rget_name_region_f(loc_id, ref, name, hdferr, size)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! Identifier for the dataset containing the reference
-                                           ! or for the group that dataset is in.
-    TYPE(hdset_reg_ref_t_f), INTENT(IN), TARGET :: ref ! Object reference
-    INTEGER(SIZE_T), OPTIONAL, INTENT(OUT) :: size     ! The size of the name buffer,
-                                                       ! returning 0 (zero) if no name is associated with the identifier
-    CHARACTER(LEN=*), INTENT(OUT) :: name  ! A name associated with the referenced object or dataset region.
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5rget_obj_type_f

- -

[ Top ] [ H5R (F03) ] [ Subroutines ]

-

NAME

-
  h5rget_obj_type_f
-
-

PURPOSE

-
  Retrieves the type of object that an object reference points to.
-
-

INPUTS

-
  loc_id   - Identifier for the dataset containing the reference or
-             for the group that dataset is in.
-  ref_type - Type of reference to query.
-  ref      - Reference to query.
-
-

OUTPUTS

-
  obj_type - Type of referenced object. 
-               H5G_UNKNOWN_F (-1)
-               H5G_LINK_F      0
-               H5G_GROUP_F     1
-               H5G_DATASET_F   2
-               H5G_TYPE_F      3
-              
-  hdferr   - error code
-               Success:  0
-               Failure: -1
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  Decemeber 17, 2008
-
-

SOURCE

-
  SUBROUTINE h5rget_obj_type_f(loc_id, ref_type, ref, obj_type, hdferr)
-    USE, INTRINSIC :: ISO_C_BINDING
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id
-    INTEGER, INTENT(IN) :: ref_type
-    TYPE(C_PTR), INTENT(IN) :: ref
-    INTEGER, INTENT(OUT) :: obj_type
-    INTEGER, INTENT(OUT) :: hdferr
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Rff_F90_f90.html b/fortran/doc/DevelGuide/src/H5Rff_F90_f90.html deleted file mode 100644 index 7d20d0c..0000000 --- a/fortran/doc/DevelGuide/src/H5Rff_F90_f90.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - - -./src/H5Rff_F90.f90 - - - - - -
-
- -

H5R (F90)

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5R_PROVISIONAL
-
-

FILE

-
  fortran/src/H5Rff_F90.f90
-
-

PURPOSE

-
  This file contains Fortran 90 interfaces for H5R functions. It contains
-  the same functions as H5Rff_F03.f90 but excludes the Fortran 2003 functions
-  and the interface listings. This file will be compiled instead of H5Rff_F03.f90
-  if Fortran 2003 functions are not enabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5R function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5rcreate_object_f

- -

[ Top ] [ H5R (F90) ] [ Subroutines ]

-

NAME

-
  h5rcreate_object_f
-
-

PURPOSE

-
  Creates reference to the object
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - name of the object at the specified location
-
-

OUTPUTS

-
  ref           - reference to the specified object
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

NOTES

-
  This is a module procedure for the h5rcreate_f subroutine.
-
-

SOURCE

-
  SUBROUTINE h5rcreate_object_f(loc_id, name, ref, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! Location identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the object at location specified
-                                           ! by loc_id identifier
-    TYPE(hobj_ref_t_f), INTENT(OUT) :: ref ! Object reference
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5rcreate_region_f

- -

[ Top ] [ H5R (F90) ] [ Subroutines ]

-

NAME

-
  h5rcreate_region_f
-
-

PURPOSE

-
  Creates reference to the dataset region
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - name of the dataset at the specified location
-  space_id      - dataspace identifier that describes selected region
-
-

OUTPUTS

-
  ref           - reference to the dataset region
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

NOTES

-
  This is a module procedure for the h5rcreate_f subroutine.
-
-

SOURCE

-
  SUBROUTINE h5rcreate_region_f(loc_id, name, space_id, ref, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! Location identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name   ! Name of the dataset at location specified
-                                           ! by loc_id identifier
-    INTEGER(HID_T), INTENT(IN) :: space_id ! Dataset's dataspace identifier
-    TYPE(hdset_reg_ref_t_f), INTENT(OUT) :: ref ! Dataset region reference
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5rdereference_object_f

- -

[ Top ] [ H5R (F90) ] [ Subroutines ]

-

NAME

-
  h5rdereference_object_f
-
-

PURPOSE

-
  Opens the HDF5 object referenced
-
-

INPUTS

-
  dset_id  - identifier of the dataset containing reference
-  ref      - reference to open
-
-

OUTPUTS

-
  obj_id   - object_identifier
-  hdferr   - error code
-              Success:  0
-              Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

NOTES

-
  This is a module procedure for the h5rdereference_f subroutine.
-
-

SOURCE

-
  SUBROUTINE h5rdereference_object_f(dset_id, ref, obj_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dset_id   ! Dataset identifier
-    TYPE(hobj_ref_t_f), INTENT(IN) :: ref   ! Object reference
-    INTEGER(HID_T), INTENT(OUT) :: obj_id   ! Object identifier
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5rdereference_region_f

- -

[ Top ] [ H5R (F90) ] [ Subroutines ]

-

NAME

-
  h5rdereference_region_f
-
-

PURPOSE

-
  Opens the dataset region
-
-

INPUTS

-
  dset_id       - identifier of the dataset containing
-                  reference to teh regions
-  ref           - reference to open
-
-

OUTPUTS

-
  obj_id        - dataspace identifier
-  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

NOTES

-
  This is a module procedure for the h5rdereference_f subroutine.
-
-

SOURCE

-
  SUBROUTINE h5rdereference_region_f(dset_id, ref, obj_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dset_id      ! Dataset identifier
-    TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref ! Object reference
-    INTEGER(HID_T), INTENT(OUT) :: obj_id   ! Dataspace identifier
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5rget_name_object_f

- -

[ Top ] [ H5R (F90) ] [ Subroutines ]

-

NAME

-
  h5rget_name_object_f
-
-

PURPOSE

-
  Retrieves a name of a referenced object.
-
-

INPUTS

-
  loc_id  - Identifier for the dataset containing the reference or for the group that dataset is in.
-  ref     - An object or dataset region reference.
-
-

OUTPUTS

-
  name    - A name associated with the referenced object or dataset region.
-
-  hdferr  - error code
-             Success:  0
-             Failure: -1
-
-

OPTIONAL PARAMETERS

-
  size    - The size of the name buffer.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 28, 2008
-
- SOURCES
- or for the group that dataset is in.
- returning 0 (zero) if no name is associated with the identifier
-
- -
- -

h5rget_name_region_f

- -

[ Top ] [ H5R (F90) ] [ Subroutines ]

-

NAME

-
  h5rget_name_region_f
-
-

PURPOSE

-
  Retrieves a name of a dataset region.
-
-

INPUTS

-
  loc_id        - Identifier for the dataset containing the reference or
-                  for the group that dataset is in.
-  ref           - An object or dataset region reference.
-
-

OUTPUTS

-
  name          - A name associated with the referenced object or dataset region.
-  hdferr        - error code
-                   Success:  0
-                   Failure: -1
-
-

OPTIONAL PARAMETERS

-
  size          - The size of the name buffer.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 28, 2008
-
-

SOURCE

-
  SUBROUTINE h5rget_name_region_f(loc_id, ref, name, hdferr, size)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id   ! Identifier for the dataset containing the reference
-                                           ! or for the group that dataset is in.
-    TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref       ! Object reference
-    INTEGER(SIZE_T), OPTIONAL, INTENT(OUT) :: size   ! The size of the name buffer,
-                                                     ! returning 0 (zero) if no name is associated 
-                                                     ! with the identifier
-    CHARACTER(LEN=*), INTENT(OUT) :: name  ! A name associated with the referenced object or dataset region.
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Rff_f90.html b/fortran/doc/DevelGuide/src/H5Rff_f90.html deleted file mode 100644 index 2b60b08..0000000 --- a/fortran/doc/DevelGuide/src/H5Rff_f90.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - -./src/H5Rff.f90 - - - - - -
-
- -

H5R

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5R
-
-

FILE

-
  fortran/src/H5Rff.f90
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5R functions. It includes
-  all the functions that are independent on whether the Fortran 2003 functions
-  are enabled or disabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5R function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5rget_object_type_obj_f

- -

[ Top ] [ H5R ] [ Subroutines ]

-

NAME

-
  h5rget_object_type_obj_f
-
-

PURPOSE

-
  Retrieves the type of object that an object reference points to.
-
-

INPUTS

-
  dset_id       - identifier of the dataset containing
-                  reference to the objects
-  ref           - reference to open
-
-

OUTPUTS

-
  obj_type      - object_type, possible values:
-                    H5G_UNKNOWN_F     (-1)
-                    H5G_GROUP_F        0
-                    H5G_DATASET_F      1
-                    H5G_TYPE_F         2
-                    H5G_LINK_F         3
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

NOTES

-
  This is a module procedure for the h5rget_object_type_f
-  subroutine.
-
-

SOURCE

-
  SUBROUTINE h5rget_object_type_obj_f(dset_id, ref, obj_type, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dset_id   ! Dataset identifier
-    TYPE(hobj_ref_t_f), INTENT(IN) :: ref   ! Object reference
-    INTEGER, INTENT(OUT) :: obj_type     ! Object type
-                                         !  H5G_UNKNOWN_F     (-1)
-                                         !  H5G_GROUP_F        0
-                                         !  H5G_DATASET_F      1
-                                         !  H5G_TYPE_F         2
-                                         !  H5G_LINK_F         3
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code
-
- -
- -

h5rget_region_region_f

- -

[ Top ] [ H5R ] [ Subroutines ]

-

NAME

-
  h5rget_region_region_f
-
-

PURPOSE

-
  Retrieves a dataspace with the specified region selected
-
-

INPUTS

-
  dset_id       - identifier of the dataset containing
-                  reference to the regions
-  ref           - reference to open
-
-

OUTPUTS

-
  space_id      - dataspace identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

NOTES

-
  This is a module procedure for the h5rget_region_f subroutine.
-
-

SOURCE

-
  SUBROUTINE h5rget_region_region_f(dset_id, ref, space_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dset_id      ! Dataset identifier
-    TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref ! Dataset region reference
-    INTEGER(HID_T), INTENT(OUT) :: space_id    ! Space identifier
-    INTEGER, INTENT(OUT) :: hdferr             ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Sf_c.html b/fortran/doc/DevelGuide/src/H5Sf_c.html deleted file mode 100644 index ebdedf7..0000000 --- a/fortran/doc/DevelGuide/src/H5Sf_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Sf.c - - - - - -
-
- -

H5Sf

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5S Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Sff_f90.html b/fortran/doc/DevelGuide/src/H5Sff_f90.html deleted file mode 100644 index c26b191..0000000 --- a/fortran/doc/DevelGuide/src/H5Sff_f90.html +++ /dev/null @@ -1,1165 +0,0 @@ - - - - - - - -./src/H5Sff.f90 - - - - - -
-
- -

H5S

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5S
-
-

FILE

-
  fortran/src/H5Sff.f90
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5S functions. It includes
-  all the functions that are independent on whether the Fortran 2003 functions
-  are enabled or disabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5S function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5sclose_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sclose_f
-
-

PURPOSE

-
  Releases and terminates access to a dataspace.
-
-

INPUTS

-
  space_id    - identifier of dataspace to release
-
-

OUTPUTS

-
  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sclose_f(space_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-            INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5scopy_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5scopy_f
-
-

PURPOSE

-
  Creates an exact copy of a dataspace.
-
-

INPUTS

-
  space_id      - dataspace identifier
-
-

OUTPUTS

-
  new_space_id  - identifier of dataspace's copy
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

NOTES

-

SOURCE

-
          SUBROUTINE h5scopy_f(space_id, new_space_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-            INTEGER(HID_T), INTENT(OUT) :: new_space_id
-                                             ! Identifier of dataspace's copy
-            INTEGER, INTENT(OUT) :: hdferr   ! Error code
-
- -
- -

h5screate_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5screate_f
-
-

PURPOSE

-
  Creates a new dataspace of a specified type.
-
-

INPUTS

-
  classtype   - the type of the dataspace to be created
-
-

OUTPUTS

-
  space_id    - dataspace identifier
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

NOTES

-

SOURCE

-
          SUBROUTINE h5screate_f(classtype, space_id, hdferr)
-            IMPLICIT NONE
-            INTEGER, INTENT(IN) :: classtype     ! The type of the dataspace
-                                                 ! to be created.
-                                                 ! Possible values are:
-                                                 !  H5S_SCALAR_F (0)
-                                                 !  H5S_SIMPLE_F(1)
-                                                 !  H5S_NULL_F(2)
-            INTEGER(HID_T), INTENT(OUT) :: space_id ! Dataspace identifier
-            INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5screate_simple_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5screate_simple_f
-
-

PURPOSE

-
  Creates a new simple data space and opens it for access      .
-
-

INPUTS

-
  rank        - number of dimensions
-  dims        - an array of the size of each dimension
-
-

OUTPUTS

-
  space_id    - dataspace identifier
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  maxdims     - an array of the maximum size of each dimension
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5screate_simple_f(rank, dims, space_id, hdferr, maxdims)
-
-            IMPLICIT NONE
-            INTEGER, INTENT(IN) :: rank             ! Number of dataspace dimensions
-            INTEGER(HSIZE_T), INTENT(IN) :: dims(rank)
-                                                    ! Array with the dimension
-                                                    ! sizes
-            INTEGER(HID_T), INTENT(OUT) :: space_id ! Dataspace identifier
-            INTEGER, INTENT(OUT) :: hdferr          ! Error code
-            INTEGER(HSIZE_T), OPTIONAL, INTENT(IN) :: maxdims(rank)
-                                                    ! Array with the maximum
-                                                    ! dimension sizes
-
- -
- -

H5Sdecode_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  H5Sdecode_f
-
-

PURPOSE

-
  Decode a binary object description of data space and return a new object handle.
-
-

INPUTS

-
  buf   -  Buffer for the data space object to be decoded.
-  obj_id        - Object ID
-
-

OUTPUTS

-
  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 26, 2008
-
-

SOURCE

-
  SUBROUTINE h5sdecode_f(buf, obj_id, hdferr)
-    IMPLICIT NONE
-    CHARACTER(LEN=*), INTENT(IN) :: buf ! Buffer for the data space object to be decoded.
-    INTEGER(HID_T), INTENT(OUT) :: obj_id  ! Object ID
-    INTEGER, INTENT(OUT) :: hdferr     ! Error code
-
- -
- -

H5Sencode_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  H5Sencode_f
-
-

PURPOSE

-
  Encode a data space object description into a binary buffer.
-
-

INPUTS

-
  obj_id        - Identifier of the object to be encoded.
-  buf   - Buffer for the object to be encoded into.
-  nalloc        - The size of the allocated buffer.
-
-

OUTPUTS

-
  nalloc        - The size of the buffer needed.
-  hdferr      - Returns 0 if successful and -1 if fails.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  March 26, 2008
-
-

SOURCE

-
  SUBROUTINE h5sencode_f(obj_id, buf, nalloc, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id ! Identifier of the object to be encoded.
-    CHARACTER(LEN=*), INTENT(OUT) :: buf ! Buffer for the object to be encoded into.
-    INTEGER(SIZE_T), INTENT(INOUT) :: nalloc ! The size of the allocated buffer.
-    INTEGER, INTENT(OUT) :: hdferr     ! Error code
-
- -
- -

h5sextent_copy_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sextent_copy_f
-
-

PURPOSE

-
  Copies the extent of a dataspace.
-
-

INPUTS

-
  dest_space_id         - the identifier for the dataspace to which
-  the extent is copied
-  source_space_id       - the identifier for the dataspace from
-  which the extent is copied
-
-

OUTPUTS

-
  hdferr      - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  NONE
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

NOTES

-

SOURCE

-
          SUBROUTINE h5sextent_copy_f(dest_space_id, source_space_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: dest_space_id  ! Identifier of destination
-                                                         ! dataspace
-            INTEGER(HID_T), INTENT(IN) :: source_space_id ! Identifier of source
-                                                          ! dataspace
-            INTEGER, INTENT(OUT) :: hdferr                ! Error code
-
- -
- -

h5sextent_equal_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sextent_equal_f
-
-

PURPOSE

-
  Determines whether two dataspace extents are equal.
-
-

INPUTS

-
  space1_id     - First dataspace identifier.
-  space2_id     - Second dataspace identifier.
-
-

OUTPUTS

-
  Equal         - .TRUE. if equal, .FALSE. if unequal.
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 2, 2008
-
-

SOURCE

-
  SUBROUTINE h5sextent_equal_f(space1_id, space2_id, equal, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: space1_id ! First dataspace identifier.
-    INTEGER(HID_T), INTENT(IN) :: space2_id ! Second dataspace identifier.
-    LOGICAL, INTENT(OUT) :: Equal ! .TRUE. if equal, .FALSE. if unequal.
-    INTEGER, INTENT(OUT) :: hdferr                ! Error code
-
- -
- -

h5sget_select_bounds_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sget_select_bounds_f
-
-

PURPOSE

-
  Gets the bounding box containing the current selection.
-
-

INPUTS

-
  space_id    - dataspace identifier
-
-

OUTPUTS

-
  start       - starting coordinates of bounding box
-  end         - ending coordinates of bounding box
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  NONE
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
  SUBROUTINE  h5sget_select_bounds_f(space_id, start, END, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-    INTEGER(HSIZE_T), DIMENSION(*), INTENT(OUT) :: start
-                                           ! Starting coordinates of the bounding box.
-    INTEGER(HSIZE_T), DIMENSION(*), INTENT(OUT) :: END
-                                           !Ending coordinates of the bounding box,
-                                           !i.e., the coordinates of the diagonally
-                                           !opposite corner
-    INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5sget_select_elem_npoints_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sget_select_elem_npoints_f
-
-

PURPOSE

-
  Gets the number of element points in the current selection
-
-

INPUTS

-
  space_id      - dataspace identifier
-
-

OUTPUTS

-
  num_points    - number of element points in the current
-                  dataspace selection
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sget_select_elem_npoints_f(space_id, num_points, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-            INTEGER(HSSIZE_T), INTENT(OUT) :: num_points
-                                             !number of element points
-                                             !in the current dataspace
-                                             !selection
-            INTEGER, INTENT(OUT) :: hdferr   ! Error code
-
- -
- -

h5sget_select_elem_pointlist_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sget_select_elem_pointlist_f
-
-

PURPOSE

-
  Gets the list of element points currently selected.
-
-

INPUTS

-
  space_id    - dataspace identifier
-  startpoint  - element point to start with
-  num_points  - number of elemnt points to get
-
-

OUTPUTS

-
  buf         - buffer with element points selected
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sget_select_elem_pointlist_f(space_id, startpoint, &
-                                                    num_points, buf, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-            INTEGER(HSIZE_T), INTENT(IN) :: startpoint
-                                             !Element point to start with.
-            INTEGER(HSIZE_T), INTENT(IN) :: num_points
-                                             !Number of element points to get
-            INTEGER(HSIZE_T), DIMENSION(*), INTENT(OUT) :: buf
-                                             !List of element points selected
-            INTEGER, INTENT(OUT) :: hdferr   ! Error code
-
- -
- -

h5sget_select_hyper_blocklist_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sget_select_hyper_blocklist_f
-
-

PURPOSE

-
  Gets the list of hyperslab blocks currently selected.
-
-

INPUTS

-
  space_id    - dataspace identifier
-  startblock  - hyperslab block to start with
-  num_blocks  - number of blocks to get
-
-

OUTPUTS

-
  buf         - buffer to hold block list
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sget_select_hyper_blocklist_f(space_id, startblock, &
-                                                    num_blocks, buf, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-            INTEGER(HSIZE_T), INTENT(IN) :: startblock
-                                             !Hyperslab block to start with.
-            INTEGER(HSIZE_T), INTENT(IN) :: num_blocks
-                                             !number of hyperslab blocks
-                                             !to get in the current dataspace
-                                             !selection
-            INTEGER(HSIZE_T), DIMENSION(*), INTENT(OUT) :: buf
-                                             !List of hyperslab blocks selected
-            INTEGER, INTENT(OUT) :: hdferr   ! Error code
-
- -
- -

h5sget_select_hyper_nblocks_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sget_select_hyper_nblocks_f
-
-

PURPOSE

-
  Get number of hyperslab blocks.
-
-

INPUTS

-
  space_id    - dataspace identifier
-
-

OUTPUTS

-
  num_blocks  - number of hyperslab blocks in the current
-                hyperslab selection
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sget_select_hyper_nblocks_f(space_id, num_blocks, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-            INTEGER(HSSIZE_T), INTENT(OUT) :: num_blocks
-                                             !number of hyperslab blocks
-                                             !in the current dataspace
-                                             !selection
-            INTEGER, INTENT(OUT) :: hdferr   ! Error code
-
- -
- -

h5sget_select_npoints_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sget_select_npoints_f
-
-

PURPOSE

-
  Determines the number of elements in a dataspace selection.
-
-

INPUTS

-
  space_id      - dataspace identifier
-
-

OUTPUTS

-
  npoints       - number of points in the dataspace selection
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sget_select_npoints_f(space_id, npoints, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id     ! Dataspace identifier
-            INTEGER(HSSIZE_T), INTENT(OUT) :: npoints  ! Number of elements in the
-                                                       ! selection
-            INTEGER, INTENT(OUT) :: hdferr             ! Error code
-
- -
- -

h5sget_select_type_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sget_select_type_f
-
-

PURPOSE

-
  Retrieve the type of selection
-
-

INPUTS

-
  space_id      - dataspace iidentifier with selection
-
-

OUTPUTS

-
  type          - flag, valid values are:
-                    H5S_SEL_ERROR_F
-                    H5S_SEL_NONE_F
-                    H5S_SEL_POINTS_F
-                    H5S_SEL_HYPERSLABS_F
-                    H5S_SEL_ALL_F
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  October 7, 2002
-
-

SOURCE

-
          SUBROUTINE h5sget_select_type_f(space_id, type, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(INOUT) :: space_id ! Dataspace identifier to
-            INTEGER, INTENT(OUT) :: type        ! Selection type
-                                                !  H5S_SEL_ERROR_F
-                                                !  H5S_SEL_NONE_F
-                                                !  H5S_SEL_POINTS_F
-                                                !  H5S_SEL_HYPERSLABS_F
-                                                !  H5S_SEL_ALL_F
-            INTEGER, INTENT(OUT) :: hdferr     ! Error code
-
- -
- -

h5sget_simple_extent_dims_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sget_simple_extent_dims_f
-
-

PURPOSE

-
  Retrieves dataspace dimension size and maximum size.
-
-

INPUTS

-
  space_id      - dataspace identifier
-
-

OUTPUTS

-
  dims          - array to store size of each dimension
-  maxdims       - array to store maximum size of each
-  dimension
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sget_simple_extent_dims_f(space_id, dims, maxdims, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-            INTEGER(HSIZE_T), DIMENSION(*), INTENT(OUT) :: dims
-                                                   ! Array to store dimension sizes
-            INTEGER(HSIZE_T), DIMENSION(*), INTENT(OUT) :: maxdims
-                                                   ! Array to store max dimension
-                                                   ! sizes
-            INTEGER, INTENT(OUT) :: hdferr         ! Error code: -1 on failure,
-                                                   ! number of dimensions on
-                                                   ! on success
-
- -
- -

h5sget_simple_extent_ndims_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sget_simple_extent_ndims_f
-
-

PURPOSE

-
  Determines the dimensionality of a dataspace
-
-

INPUTS

-
  space_id      - dataspace identifier
-
-

OUTPUTS

-
  rank          - number of dataspace dimensions
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sget_simple_extent_ndims_f(space_id, rank, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id     ! Dataspace identifier
-            INTEGER, INTENT(OUT) :: rank               ! Number of dimensions
-            INTEGER, INTENT(OUT) :: hdferr             ! Error code
-
- -
- -

h5sget_simple_extent_npoints_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sget_simple_extent_npoints_f
-
-

PURPOSE

-
  Determines the number of elements in a dataspace.
-
-

INPUTS

-
  space_id      - dataspace identifier
-
-

OUTPUTS

-
  npoints       - number of elements in the dataspace
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sget_simple_extent_npoints_f(space_id, npoints, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id     ! Dataspace identifier
-            INTEGER(HSIZE_T), INTENT(OUT) :: npoints  ! Number of elements in
-                                                       ! dataspace
-            INTEGER, INTENT(OUT) :: hdferr             ! Error code
-
- -
- -

h5sget_simple_extent_type_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sget_simple_extent_type_f
-
-

PURPOSE

-
  Determine the current class of a dataspace
-
-

INPUTS

-
  space_id      - dataspace identifier
-
-

OUTPUTS

-
  classtype     - class type, possible values are:
-  H5S_NO_CLASS_F (-1)
-  H5S_SCALAR_F (0)
-  H5S_SIMPLE_F (1)
-  H5S_NULL_F   (2)
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sget_simple_extent_type_f(space_id, classtype, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-            INTEGER, INTENT(OUT) :: classtype      ! Class type , possible values
-                                                   ! are:
-                                                   !  H5S_NO_CLASS_F (-1)
-                                                   !  H5S_SCALAR_F (0)
-                                                   !  H5S_SIMPLE_F (1)
-                                                   !  H5S_NULL_F   (2)
-            INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5sis_simple_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sis_simple_f
-
-

PURPOSE

-
  Determines whether a dataspace is a simple dataspace.
-
-

INPUTS

-
  space_id      - dataspace identifier
-
-

OUTPUTS

-
  status        - flag to indicate if dataspace
-  is simple or not
-  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sis_simple_f(space_id, status, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id  ! Dataspace identifier
-            LOGICAL, INTENT(OUT) :: status      ! Flag, idicates if dataspace
-                                                ! is simple or not ( TRUE or
-                                                ! FALSE)
-            INTEGER, INTENT(OUT) :: hdferr      ! Error code
-
- -
- -

h5soffset_simple_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5soffset_simple_f
-
-

PURPOSE

-
  Sets the offset of a simple dataspace.
-
-

INPUTS

-
  space_id      - dataspace identifier
-  offset        - the offset at which to position the
-  selection
-
-

OUTPUTS

-
  hdferr      - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  NONE
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5soffset_simple_f(space_id, offset, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-            INTEGER(HSSIZE_T), DIMENSION(*), INTENT(IN) ::  offset
-                                                   ! The offset at which to position
-                                                   ! the selection
-            INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- -

h5sselect_all_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sselect_all_f
-
-

PURPOSE

-
  Selects the entire dataspace.
-
-

INPUTS

-
  space_id    - Identifier for the dataspace in which
-                selection being made
-
-

OUTPUTS

-
  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sselect_all_f(space_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id  ! Dataspace identifier
-            INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5sselect_elements_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sselect_elements_f
-
-

PURPOSE

-
  Selects elements to be included in the selection for
-  a dataspace
-
-

INPUTS

-
  space_id      - dataspace identifier
-  operator      - flag, valid values are:
-                   H5S_SELECT_SET_F 
-                   H5S_SELECT_APPEND_F 
-                   H5S_SELECT_PREPEND_F
-  rank          - number of dataspace dimensions
-  num_elements  - number of elements to be selected
-  coord         - 2D (rank x num_elements) array with the
-                  elements coordinates ( 1-based); in C the
-                  array is stored in 2D as (num_element x rank)
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
  SUBROUTINE h5sselect_elements_f(space_id, OPERATOR, rank, &
-       num_elements, coord, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T),   INTENT(IN)                                :: space_id
-    INTEGER,          INTENT(IN)                                :: OPERATOR
-    INTEGER,          INTENT(IN)                                :: rank
-    INTEGER(SIZE_T),  INTENT(IN)                                :: num_elements
-    INTEGER(HSIZE_T), INTENT(IN) , DIMENSION(rank,num_elements) :: coord
-    INTEGER,          INTENT(OUT)                               :: hdferr 
-
- -
- -

h5sselect_hyperslab_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sselect_hyperslab_f
-
-

PURPOSE

-
  Selects a hyperslab region to add to the current selected
-  region
-
-

INPUTS

-
  space_id      - dataspace identifier
-  operator      - flag, valid values are:
-  H5S_SELECT_SET_F (0)
-  H5S_SELECT_OR_F (1)
-  start         - array with hyperslab offsets
-  count         - number of blocks included in the
-  hyperslab
-
-

OUTPUTS

-
  hdferr      - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  stride        - array with hyperslab strides
-  block         - array with hyperslab block sizes
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sselect_hyperslab_f(space_id, operator, start, count, &
-                                           hdferr, stride, block)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-            INTEGER, INTENT(IN) :: operator     ! Flag, valid values are:
-                                                ! H5S_SELECT_SET_F (0)
-                                                ! H5S_SELECT_OR_F (1)
-                                                !
-            INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: start
-                                          ! Starting coordinates of the hyperslab
-            INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: count
-                                          ! Number of blocks to select
-                                          ! from dataspace
-            INTEGER, INTENT(OUT) :: hdferr     ! Error code
-            INTEGER(HSIZE_T), DIMENSION(:), OPTIONAL, INTENT(IN) :: stride
-                                          ! Array of how many elements to move
-                                          ! in each direction
-            INTEGER(HSIZE_T), DIMENSION(:), OPTIONAL, INTENT(IN) :: block
-                                          ! Sizes of element block
-
- -
- -

h5sselect_none_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sselect_none_f
-
-

PURPOSE

-
  Resets the selection region to include no elements.
-
-

INPUTS

-
  space_id    - the identifier for the dataspace in which
-                the selection is being reset.
-
-

OUTPUTS

-
  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sselect_none_f(space_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id  ! Dataspace identifier
-            INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5sselect_valid_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sselect_valid_f
-
-

PURPOSE

-
  Verifies that the selection is within the extent of
-  the dataspace.
-
-

INPUTS

-
  space_id      - identifier for the dataspace for which
-  selection is verified
-
-

OUTPUTS

-
  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sselect_valid_f(space_id, status, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id  ! Dataspace identifier
-            LOGICAL, INTENT(OUT) :: status          ! TRUE if the selection is
-                                                    ! contained within the extent,
-                                                    ! FALSE otherwise.
-            INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5sset_extent_none_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sset_extent_none_f
-
-

PURPOSE

-
  Removes the extent from a dataspace.
-
-

INPUTS

-
  space_id      - dataspace identifier
-
-

OUTPUTS

-
  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sset_extent_none_f(space_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id  ! Dataspace identifier
-            INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5sset_extent_simple_f

- -

[ Top ] [ H5S ] [ Subroutines ]

-

NAME

-
  h5sset_extent_simple_f
-
-

PURPOSE

-
  Sets or resets the size of an existing dataspace.
-
-

INPUTS

-
  space_id      - dataspace identifier
-  rank          - dataspace number of dimensions
-  current_size          - array with the new sizes of dimensions
-  maximum_size          - array with the new maximum sizes of
-  dimensions
-
-

OUTPUTS

-
  hdferr      - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 6, 2001
-
-

SOURCE

-
          SUBROUTINE h5sset_extent_simple_f(space_id, rank, current_size, &
-                                            maximum_size, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
-            INTEGER, INTENT(IN) :: rank            ! Dataspace rank
-            INTEGER(HSIZE_T), DIMENSION(rank), INTENT(IN) :: current_size
-                                                   ! Array with the new sizes
-                                                   ! of dimensions
-            INTEGER(HSIZE_T), DIMENSION(rank), INTENT(IN) :: maximum_size
-                                                   ! Array with the new maximum
-                                                   ! sizes of dimensions
-                                                   ! sizes
-            INTEGER, INTENT(OUT) :: hdferr         ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Tf_c.html b/fortran/doc/DevelGuide/src/H5Tf_c.html deleted file mode 100644 index b36c2a5..0000000 --- a/fortran/doc/DevelGuide/src/H5Tf_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Tf.c - - - - - -
-
- -

H5Tf

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5T Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Tff_f90.html b/fortran/doc/DevelGuide/src/H5Tff_f90.html deleted file mode 100644 index 3b7dfe8..0000000 --- a/fortran/doc/DevelGuide/src/H5Tff_f90.html +++ /dev/null @@ -1,2378 +0,0 @@ - - - - - - - -./src/H5Tff.f90 - - - - - -
-
- -

H5T

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5T
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5T functions. It includes
-  all the functions that are independent on whether the Fortran 2003 functions
-  are enabled or disabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5T function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5tarray_create_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tarray_create_f
-
-

PURPOSE

-
  Creates an array datatype object.
-
-

INPUTS

-
  base_id       - datatype identifier for the array
-                  base datatype
-  rank          - rank of the array
-  dims          - array dimension sizes
-
-

OUTPUTS

-
  type_id       - array datatype identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tarray_create_f(base_id, rank, dims, type_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: base_id ! identifier of array base datatype
-            INTEGER, INTENT(IN) ::  rank ! Rank of the array
-            INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: dims !Sizes of each array dimension
-            INTEGER(HID_T), INTENT(OUT) :: type_id ! identifier of the array datatype
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tclose_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tclose_f
-
-

PURPOSE

-
  Releases a datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tclose_f(type_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tcommit_anon_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tcommit_anon_f
-
-

PURPOSE

-
  Commits a transient datatype to a file,
-  creating a new named datatype,
-  but does not link it into the file structure.
-
-

INPUTS

-
  loc_id        - A file or group identifier specifying the file
-                  in which the new named datatype is to be created.
-  dtype_id      - A datatype identifier.
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  tcpl_id       - A datatype creation property list identifier.
-                  (H5P_DEFAULT_F for the default property list.)
-  tapl_id       - A datatype access property list identifier.
-                  should always be passed as the value H5P_DEFAULT_F.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 25, 2008
-
-

SOURCE

-
  SUBROUTINE h5tcommit_anon_f(loc_id, dtype_id, hdferr, tcpl_id, tapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id  ! A file or group identifier specifying
-                                          ! the file in which the new named datatype
-                                          ! is to be created.
-    INTEGER(HID_T), INTENT(IN) :: dtype_id  ! Datatype identifier
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tcpl_id ! A datatype creation property
-                                                    ! list identifier.
-                                                    ! (H5P_DEFAULT_F for the default property list.)
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id ! A datatype access property list identifier.
-                                                    ! should always be passed as the value H5P_DEFAULT_F.
-
- -
- -

h5tcommit_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tcommit_f
-
-

PURPOSE

-
  Commits a transient datatype to a file, creating a
-  new named datatype.
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - name of the datatype to be stored
-                  at the specified location
-  type_id       - identifier of a datatype to be stored
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  lcpl_id       - Link creation property list
-  tcpl_id       - Datatype creation property list
-  tapl_id       - Datatype access property list
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
        - Explicit Fortran interfaces were added for
-          called C functions (it is needed for Windows
-          port).  March 7, 2001
-
-        - Added optional parameters introduced in version 1.8
-          M. Scot Breitenfeld
-
-

SOURCE

-
  SUBROUTINE h5tcommit_f(loc_id, name, type_id, hdferr, &
-       lcpl_id, tcpl_id, tapl_id  )
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id  ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name
-                                  ! Datatype name within file or group
-    INTEGER(HID_T), INTENT(IN) :: type_id  ! Datatype identifier
-    INTEGER, INTENT(OUT) :: hdferr          ! Error code
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Link creation property list
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tcpl_id ! Datatype creation property list
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id ! Datatype access property list
-
- -
- -

h5tcommitted_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tcommitted_f
-
-

PURPOSE

-
  Determines whether a datatype is a named type or a transient type.
-
-

INPUTS

-
  dtype_id      - A datatype identifier.
-
-

OUTPUTS

-
  committed     - .TRUE., if the datatype has been committed
-                  .FALSE., if the datatype has not been committed.
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  February 25, 2008
-
-

SOURCE

-
  SUBROUTINE h5tcommitted_f(dtype_id, committed, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dtype_id  ! A datatype identifier
-    LOGICAL, INTENT(OUT) :: committed ! .TRUE., if the datatype has been committed
-                                      !.FALSE., if the datatype has not been committed.
-    INTEGER, INTENT(OUT) :: hdferr     ! Error code:
-!  Success:  0
-!  Failure: -1
-
- -
- -

h5tcompiler_conv_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tcompiler_conv_f
-
-

PURPOSE

-
  Check whether the library’s default conversion is hard conversion.R
-
-

INPUTS

-
  src_id        - Identifier for the source datatype.
-  dst_id        - Identifier for the destination datatype.
-
-

OUTPUTS

-
  flag          - TRUE for compiler conversion, FALSE for library conversion
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 9, 2008
-
-

SOURCE

-
  SUBROUTINE h5tcompiler_conv_f( src_id, dst_id, flag, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: src_id ! Identifier for the source datatype.
-    INTEGER(HID_T), INTENT(IN) :: dst_id ! Identifier for the destination datatype.
-    LOGICAL, INTENT(OUT) :: flag  ! .TRUE. for compiler conversion, .FALSE. for library conversion
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code:
-                                    ! 0 on success and -1 on failure
-
- -
- -

h5tcopy_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tcopy_f
-
-

PURPOSE

-
  Creates a copy of exisiting datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  new_type_id   - identifier of datatype's copy
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tcopy_f(type_id, new_type_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER(HID_T), INTENT(OUT) :: new_type_id
-                                 ! Identifier of datatype's copy
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tcreate_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tcreate_f
-
-

PURPOSE

-
  Creates a new dataype
-
-

INPUTS

-
  class         - datatype class, possible values are:
-                    H5T_COMPOUND_F
-                    H5T_ENUM_F
-                    H5T_OPAQUE_F
-  size          - datattype size
-
-

OUTPUTS

-
  type_id       - datatype identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tcreate_f(class, size, type_id, hdferr)
-            IMPLICIT NONE
-            INTEGER, INTENT(IN) :: class ! Datatype class can be one of
-                                         ! H5T_COMPOUND_F
-                                         ! H5T_ENUM_F
-                                         ! H5T_OPAQUE_F
-            INTEGER(SIZE_T), INTENT(IN) :: size ! Size of the datatype
-            INTEGER(HID_T), INTENT(OUT) :: type_id ! Datatype identifier
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

H5Tdecode_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  H5Tdecode_f
-
-

PURPOSE

-
  Decode a binary object description of data type and return a new object handle.
-
-

INPUTS

-
  buf           -  Buffer for the data space object to be decoded.
-  obj_id        - Object ID
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 9, 2008
-
-

SOURCE

-
  SUBROUTINE h5tdecode_f(buf, obj_id, hdferr)
-    IMPLICIT NONE
-    CHARACTER(LEN=*), INTENT(IN) :: buf ! Buffer for the data space object to be decoded.
-    INTEGER(HID_T), INTENT(OUT) :: obj_id  ! Object ID
-    INTEGER, INTENT(OUT) :: hdferr     ! Error code
-
- -
- -

h5tenaum_insert_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tenaum_insert_f
-
-

PURPOSE

-
  Inserts a new enumeration datatype member.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tenum_insert_f(type_id,  name, value, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            CHARACTER(LEN=*), INTENT(IN) :: name  !Name of  the new member
-            INTEGER, INTENT(IN) :: value !value of the new member
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

H5Tencode_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  H5Tencode_f
-
-

PURPOSE

-
  Encode a data type object description into a binary buffer.
-
-

INPUTS

-
  obj_id        - Identifier of the object to be encoded.
-  buf           - Buffer for the object to be encoded into.
-  nalloc        - The size of the allocated buffer.
-
-

OUTPUTS

-
  nalloc        - The size of the buffer needed.
-  hdferr        - Returns 0 if successful and -1 if fails.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 9, 2008
-
-

SOURCE

-
  SUBROUTINE h5tencode_f(obj_id, buf, nalloc, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: obj_id ! Identifier of the object to be encoded.
-    CHARACTER(LEN=*), INTENT(OUT) :: buf ! Buffer for the object to be encoded into.
-    INTEGER(SIZE_T), INTENT(INOUT) :: nalloc ! The size of the allocated buffer.
-    INTEGER, INTENT(OUT) :: hdferr     ! Error code
-
- -
- -

h5tenum_create_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tenum_create_f
-
-

PURPOSE

-
  Creates a new enumeration datatype.
-
-

INPUTS

-
  parent_id     - datatype identifier for base datatype
-
-

OUTPUTS

-
  new_type_id   - datatype identifier for the enumeration datatype
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tenum_create_f(parent_id, new_type_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: parent_id  ! Datatype identifier for
-                                                     ! the  base datatype
-            INTEGER(HID_T), INTENT(OUT) :: new_type_id
-                                                     !datatype identifier for the
-                                                     ! new enumeration datatype
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tenum_nameof_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tenum_nameof_f
-
-

PURPOSE

-
  Returns the symbol name corresponding to a specified
-  member of an enumeration datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-  value         - value of the enumeration datatype
-  namelen       - name buffer size
-
-

OUTPUTS

-
  name          - buffer to hold symbol name
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
- NOTE
-   According to the standard: Because an INTENT(OUT) variable is considered undefined 
-   on entry to the procedure, any default initialization specified for its type will 
-   be applied. So we need to blank out the "name" to be portable and eliminate any 
-   characters the "name' may contain upon entry, depending on compiler implementation.
-
-

SOURCE

-
  SUBROUTINE h5tenum_nameof_f(type_id,  value, namelen, name, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            CHARACTER(LEN=*), INTENT(OUT) :: name  !Name of the  enumeration datatype.
-            INTEGER(SIZE_T), INTENT(IN) :: namelen !length of the name
-            INTEGER, INTENT(IN) :: value !value of the  enumeration datatype.
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tenum_valuof_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tenum_valuof_f
-
-

PURPOSE

-
  Returns the value corresponding to a specified
-  member of an enumeration datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-  name          - symbol name
-
-

OUTPUTS

-
  value         - value of the enumeration datatype
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tenum_valueof_f(type_id,  name, value, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            CHARACTER(LEN=*), INTENT(IN) :: name  !Name of the  enumeration datatype.
-            INTEGER, INTENT(OUT) :: value !value of the  enumeration datatype.
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tequal_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tequal_f
-
-

PURPOSE

-
  Determines whether two datatype identifiers refer
-  to the same datatype.
-
-

INPUTS

-
  type1_id      - datatype identifier
-  type2_id      - datatype identifier
-
-

OUTPUTS

-
  flag          - TRUE/FALSE flag to indicate
-                  if two datatypes are equal
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tequal_f(type1_id, type2_id, flag, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type1_id ! Datatype identifier
-            INTEGER(HID_T), INTENT(IN) :: type2_id ! Datatype identifier
-            LOGICAL, INTENT(OUT) :: flag ! TRUE/FALSE flag to indicate if two
-                                         ! datatypes are equal
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_array_dims_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_array_dims_f
-
-

PURPOSE

-
  Returns sizes of array dimensions.
-
-

INPUTS

-
  type_id       - array datatype identifier
-
-

OUTPUTS

-
  dims          - buffer to store array datatype dimensions
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_array_dims_f(type_id, dims, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Array datatype identifier
-            INTEGER(HSIZE_T),DIMENSION(*), INTENT(OUT) ::  dims !buffer to store array datatype
-                                                                ! dimensions
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_array_ndims_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_array_ndims_f
-
-

PURPOSE

-
  Returns the rank of an array datatype.
-
-

INPUTS

-
  type_id       - array datatype identifier
-
-

OUTPUTS

-
  ndims         - number of array dimensions
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_array_ndims_f(type_id, ndims, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Array datatype identifier
-            INTEGER, INTENT(OUT) ::  ndims ! number of array dimensions
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_class_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_class_f
-
-

PURPOSE

-
  Returns the datatype class identifier.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  class         - class, possible values are:
-                   H5T_NO_CLASS_F (-1)
-                   H5T_INTEGER_F  (0)
-                   H5T_FLOAT_F (1)
-                   H5T_TIME_F  (2)
-                   H5T_STRING_F (3)
-                   H5T_BITFIELD_F (4)
-                   H5T_OPAQUE_F (5)
-                   H5T_COMPOUND_F (6)
-                   H5T_REFERENCE_F (7)
-                   H5T_ENUM_F (8)
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_class_f(type_id, class, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(OUT) :: class
-                           ! Datatype class, possible values are:
-                                          ! H5T_NO_CLASS_F (-1)
-                                          ! H5T_INTEGER_F  (0)
-                                          ! H5T_FLOAT_F (1)
-                                          ! H5T_TIME_F  (2)
-                                          ! H5T_STRING_F (3)
-                                          ! H5T_BITFIELD_F (4)
-                                          ! H5T_OPAQUE_F (5)
-                                          ! H5T_COMPOUND_F (6)
-                                          ! H5T_REFERENCE_F (7)
-                                          ! H5T_ENUM_F (8)
-          INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_create_plist_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_create_plist_f
-
-

PURPOSE

-
  Returns a copy of a datatype creation property list.
-
-

INPUTS

-
  dtype_id      - Datatype identifier
-
-

OUTPUTS

-
  dtpl_id       - Datatype property list identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  April 9, 2008
-
-

SOURCE

-
  SUBROUTINE h5tget_create_plist_f(dtype_id, dtpl_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dtype_id  ! Datatype identifier
-    INTEGER(HID_T), INTENT(OUT) :: dtpl_id  ! Datatype property list identifier.
-    INTEGER, INTENT(OUT) :: hdferr       ! Error code:
-                                         ! 0 on success and -1 on failure
-
- -
- -

h5tget_cset_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_cset_f
-
-

PURPOSE

-
  Retrieves the character set type of a string datatype.
-
-

INPUTS

-
  type_id  - Datatype identifier
-
-

OUTPUTS

-
  cset     - Character set type of a string datatype
-              Possible values are:
-              H5T_CSET_ASCII_F = 0
-              H5T_CSET_UTF8_F
-  hdferr   - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_cset_f(type_id, cset, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(OUT) :: cset   ! character set type of a string datatype
-                                           !  Possible values are:
-                                           !  H5T_CSET_ASCII_F = 0
-                                           !  H5T_CSET_UTF8_F
-            INTEGER, INTENT(OUT) :: hdferr ! Error code
-
- -
- -

h5tget_ebias_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_ebias_f
-
-

PURPOSE

-
  Retrieves the exponent bias of a floating-point type.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  ebias         - datatype exponent bias
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_ebias_f(type_id, ebias, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER(SIZE_T), INTENT(OUT) :: ebias ! Datatype exponent bias of a floating-point type
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_fields_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_fields_f
-
-

PURPOSE

-
  Retrieves floating point datatype bit field information.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  spos          - sign bit-position
-  epos          - exponent bit-position
-  esize         - size of exponent in bits
-  mpos          - mantissa position
-  msize         - size of mantissa in bits
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_fields_f(type_id, spos, epos, esize, mpos, msize, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER(SIZE_T), INTENT(OUT) :: spos   ! sign bit-position
-            INTEGER(SIZE_T), INTENT(OUT) :: epos   ! exponent bit-position
-            INTEGER(SIZE_T), INTENT(OUT) :: esize  ! size of exponent in bits
-            INTEGER(SIZE_T), INTENT(OUT) :: mpos   ! mantissa bit-position
-            INTEGER(SIZE_T), INTENT(OUT) :: msize  ! size of mantissa in bits
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_inpad_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_inpad_f
-
-

PURPOSE

-
  Retrieves the internal padding type for unused bits
-  in floating-point datatypes.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  padtype       - padding type for unused bits
-                  Possible values of padding type are:
-                    H5T_PAD_ZERO_F = 0
-                    H5T_PAD_ONE_F = 1
-                    H5T_PAD_BACKGROUND_F = 2
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_inpad_f(type_id, padtype, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(OUT) :: padtype ! padding type for unused bits
-                                            ! in floating-point datatypes.
-                                            ! Possible values of padding type are:
-                                            ! H5T__PAD_ZERO_F = 0
-                                            ! H5T__PAD_ONE_F = 1
-                                            ! H5T__PAD_BACKGROUND_F = 2
-
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_member_class_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_member_class_f
-
-

PURPOSE

-
  Returns datatype class of compound datatype member.
-
-

INPUTS

-
  type_id       - datartpe identifier
-  member_no     - index of compound datatype member
-
-

OUTPUTS

-
  class         - class type for compound dadtype member
-                  Valid classes:
-                    H5T_NO_CLASS_F (error)
-                    H5T_INTEGER_F
-                    H5T_FLOAT_F
-                    H5T_TIME_F
-                    H5T_STRING_F
-                    H5T_BITFIELD_F
-                    H5T_OPAQUE_F
-                    H5T_COMPOUND_F
-                    H5T_REFERENCE_F
-                    H5T_ENUM_F
-                    H5T_VLEN_F
-                    H5T_ARRAY_F
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  April 6, 2005
-
-

SOURCE

-
  SUBROUTINE h5tget_member_class_f(type_id, member_no, class, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id  ! Datatype identifier
-            INTEGER, INTENT(IN)       :: member_no  ! Member number
-            INTEGER, INTENT(OUT)     :: class      ! Member class
-            INTEGER, INTENT(OUT) :: hdferr      ! Error code
-
- -
- -

h5tget_member_index_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_member_index_f
-
-

PURPOSE

-
  Retrieves the index of a compound or enumeration datatype member.
-
-

INPUTS

-
  type_id       - datatype identifier
-  name          - name of the field or member whose index to
-  to be retrieved from the datatype.
-
-

OUTPUTS

-
  index         - 0-based index of the filed or member (0 to N-1)
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  September 26, 2002
-
-

SOURCE

-
  SUBROUTINE h5tget_member_index_f(type_id, name, index, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id  ! Datatype identifier
-            CHARACTER(LEN=*), INTENT(IN) :: name   ! Field or member name
-            INTEGER, INTENT(OUT) :: index          ! Field or member index
-            INTEGER, INTENT(OUT) :: hdferr          ! Error code
-
- -
- -

h5tget_member_name_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_member_name_f
-
-

PURPOSE

-
  Retrieves the name of a field of a compound datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-  index         - filed index (0-based)
-
-

OUTPUTS

-
  member_name   - buffer to hold member's name
-  namelen       - name length
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_member_name_f(type_id, index, member_name,  namelen, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(IN) :: index !Field index (0-based) of the field name to retrieve
-            CHARACTER(LEN=*), INTENT(OUT) :: member_name !name of a field of
-                                                         !a compound datatype
-            INTEGER, INTENT(OUT) :: namelen ! Length of the name
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_member_offset_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_member_offset_f
-
-

PURPOSE

-
  Retrieves the offset of a field of a compound datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-  member_no     - number of the field
-
-

OUTPUTS

-
  offset        - byte offset of the requested field
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_member_offset_f(type_id, member_no, offset, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(IN) :: member_no !Number of the field
-                                                       !whose offset is requested
-            INTEGER(SIZE_T), INTENT(OUT) :: offset !byte offset of the beginning of the field
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_member_type_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_member_type_f
-
-

PURPOSE

-
  Returns the datatype of the specified member.
-
-

INPUTS

-
  type_id       - compound datatype identifier
-  field_idx     - field index (0-based)
-
-

OUTPUTS

-
  datatype      - idnetifier of the member's datatype
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_member_type_f(type_id,  field_idx, datatype, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(IN) :: field_idx !Field index (0-based) of the field type to retrieve
-            INTEGER(HID_T), INTENT(OUT) :: datatype !identifier of a copy of
-                                                    !the datatype of the field
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_member_value_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_member_value_f
-
-

PURPOSE

-
  Returns the value of an enumeration datatype member.
-
-

INPUTS

-
  type_id       - datatype identifier
-  member_no     - number of the enumeration datatype member
-
-

OUTPUTS

-
  value         - value of the enumeration datatype
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_member_value_f(type_id,  member_no, value, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(IN) :: member_no !Number of the enumeration datatype member
-            INTEGER, INTENT(OUT) :: value !value of the  enumeration datatype.
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_native_type_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_native_type_f
-
-

PURPOSE

-
  Returns the native datatype of a specified datatype.
-
-

INPUTS

-
  dtype_id      - Datatype identifier for the dataset datatype.
-  
-  direction     - Direction of search:
-                  H5T_DIR_DEFAULT     = 0,    /*default direction is inscendent */
-                  H5T_DIR_ASCEND      = 1,    /*in inscendent order             */
-                  H5T_DIR_DESCEND     = 2     /*in descendent order             */
-  * NOTE: In C it is defined as a structure: H5T_direction_t
-
-

OUTPUTS

-
  native_dtype_id - The native datatype identifier for the specified dataset datatype
-  hdferr          - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  June 18, 2008
-
-

SOURCE

-
  SUBROUTINE h5tget_native_type_f(dtype_id, direction, native_dtype_id, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: dtype_id  ! Datatype identifier
-    INTEGER, INTENT(IN) :: direction  ! Direction of search:
-                                      ! H5T_DIR_ASCEND_F      = 1  in inscendent order
-                                      ! H5T_DIR_DESCEND_F     = 2  in descendent order
-    INTEGER(HID_T), INTENT(OUT) :: native_dtype_id  ! The native datatype identifier
-    INTEGER, INTENT(OUT) :: hdferr    ! Error code:
-                                      ! 0 on success and -1 on failure
-
- -
- -

h5tget_nmembers_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_nmembers_f
-
-

PURPOSE

-
  Retrieves the number of fields in a compound datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  num_members   - number of members
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_nmembers_f(type_id, num_members, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(OUT) :: num_members !number of fields in a compound datatype
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_norm_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_norm_f
-
-

PURPOSE

-
  Retrieves mantissa normalization of a floating-point
-  datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  norm          - normalization types, valid values are:
-                    H5T_NORM_IMPLIED_F(0)
-                    H5T_NORM_MSBSET_F(1)
-                    H5T_NORM_NONE_F(2)
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_norm_f(type_id, norm, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(OUT) :: norm !mantissa normalization of a floating-point datatype
-                                         !Valid normalization types are:
-                                         !H5T_NORM_IMPLIED_F(0),MSB of mantissa is not
-                                         !stored, always 1,  H5T_NORM_MSBSET_F(1), MSB of
-                                         !mantissa is always 1, H5T_NORM_NONE_F(2)
-                                         !Mantissa is not normalize
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_offset_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_offset_f
-
-

PURPOSE

-
  Retrieves the bit offset of the first significant bit.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  offset        - offset value
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_offset_f(type_id, offset, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER(SIZE_T), INTENT(OUT) :: offset ! Datatype bit offset of the
-                                           ! first significant bit
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_order_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_order_f
-
-

PURPOSE

-
  Returns the byte order of an atomic datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  order         - byte order for the datatype, possible
-                  values are:
-                    H5T_ORDER_LE_F
-                    H5T_ORDER_BE_F
-                    H5T_ORDER_VAX_F (not implemented yet)
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_order_f(type_id, order, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-    INTEGER, INTENT(OUT) :: order
-                                    ! Datatype byte order, possible values are:
-                                    ! H5T_ORDER_LE_F
-                                    ! H5T_ORDER_BE_F
-                                    ! H5T_ORDER_VAX_F
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-
- -
- -

h5tget_pad_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_pad_f
-
-

PURPOSE

-
  Retrieves the padding type of the least and
-  most          -significant bit padding.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  lsbpad        - least-significant bit padding type
-  msbpad        - most-significant bit padding type
-                  Possible values of padding type are:
-                    H5T_PAD_ERROR_F      = -1
-                    H5T_PAD_ZERO_F = 0
-                    H5T_PAD_ONE_F = 1
-                    H5T_PAD_BACKGROUND_F = 2
-                    H5T_PAD_NPAD_F      = 3
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_pad_f(type_id, lsbpad, msbpad, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(OUT) :: lsbpad ! padding type of the
-                                           ! least significant bit
-            INTEGER, INTENT(OUT) :: msbpad ! padding type of the
-                                           ! most significant bit
-                                           ! Possible values of padding type are:
-                                           ! H5T__PAD_ZERO_F = 0
-                                           ! H5T__PAD_ONE_F = 1
-                                           ! H5T__PAD_BACKGROUND_F = 2
-                                           ! H5T_PAD_ERROR_F      = -1
-                                           ! H5T_PAD_NPAD_F      = 3
-
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_precision_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_precision_f
-
-

PURPOSE

-
  Returns the precision of an atomic datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  precision     - precision of the datatype
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_precision_f(type_id, precision, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER(SIZE_T), INTENT(OUT) :: precision ! Datatype precision
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_sign_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_sign_f
-
-

PURPOSE

-
  Retrieves the sign type for an integer type.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  sign          - sign type
-                  Possible values are:
-                    - Unsigned integer type 
-                        H5T_SGN_NONE_F = 0
-                    - Two's complement signed integer type
-                        H5T_SGN_2_F = 1
-                    - error value: H5T_SGN_ERROR_F=-1
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_sign_f(type_id, sign, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(OUT) :: sign ! sign type for an integer type
-                                         !possible values are:
-                                         !Unsigned integer type H5T_SGN_NONE_F = 0
-                                         !Two's complement signed integer type
-                                         !H5T_SGN_2_F = 1
-                                         !or error value: H5T_SGN_ERROR_F=-1
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_size_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_size_f
-
-

PURPOSE

-
  Returns the size of a datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  size          - datatype size
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_size_f(type_id, size, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER(SIZE_T), INTENT(OUT) :: size ! Datatype size
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_strpad_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_strpad_f
-
-

PURPOSE

-
  Retrieves the storage mechanism for a string datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  strpad        - storage method for a string datatype
-                  Possible values are:
-                    H5T_STR_NULLTERM_F,
-                    H5T_STR_NULLPAD_F,
-                    H5T_STR_SPACEPAD_F
-                    H5T_STR_ERROR_F
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_strpad_f(type_id, strpad, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(OUT) :: strpad
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_super_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_super_f
-
-

PURPOSE

-
  Returns the base datatype from which a datatype is derived.
-
-

INPUTS

-
  type_id       - datatype identifier
-
-

OUTPUTS

-
  base_type_id          - identifier of the base type
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_super_f(type_id, base_type_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! datatype identifier
-            INTEGER(HID_T), INTENT(OUT) :: base_type_id ! identifier of the datatype
-                                           ! from which datatype (type_id) was derived
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tget_tag_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tget_tag_f
-
-

PURPOSE

-
  Gets the tag associated with an opaque datatype.
-
-

INPUTS

-
  type_id       - identifier for opaque datatype
-
-

OUTPUTS

-
  tag           - unique ASCII string associated with opaque
-                  datatype
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tget_tag_f(type_id, tag,taglen, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            CHARACTER(LEN=*), INTENT(OUT) :: tag  ! Unique ASCII string with which
-                                                  !  the opaque datatype is to be tagged
-            INTEGER, INTENT(OUT) :: taglen        ! Length of tag
-            INTEGER(SIZE_T)      :: tag_size      ! Declared character length of tab 
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tinsert_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tinsert_f
-
-

PURPOSE

-
  Adds a new member to a compound datatype.
-
-

INPUTS

-
  type_id       - compound dattype identifier
-  name          - name of the field to insert
-  offset        - start of the member in an instance of
-                  the compound datatype
-  field_id      - datatype identifier of the field to insert
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tinsert_f(type_id,  name, offset, field_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            CHARACTER(LEN=*), INTENT(IN) :: name !Name of the field to insert
-            INTEGER(SIZE_T), INTENT(IN) :: offset !start of the member in an instance of
-                                                   !the compound datatype
-            INTEGER(HID_T), INTENT(IN) :: field_id !datatype identifier of the new member
-
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tis_variable_str_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tis_variable_str_f
-
-

PURPOSE

-
  Determines whether a dattype is a variable string.
-
-

INPUTS

-
  type_id       - datartpe identifier
-
-

OUTPUTS

-
  status        - flag to indicate if datatype
-                  is a variable string
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  March 12, 2003
-
-

SOURCE

-
  SUBROUTINE h5tis_variable_str_f(type_id, status, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id  ! Datatype identifier
-            LOGICAL, INTENT(OUT) :: status      ! Flag, idicates if datatype
-                                                ! is a variable string or not ( TRUE or
-                                                ! FALSE)
-            INTEGER, INTENT(OUT) :: hdferr      ! Error code
-
- -
- -

h5topen_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5topen_f
-
-

PURPOSE

-
  Opens named datatype.
-
-

INPUTS

-
  loc_id        - location identifier
-  name          - a datatype name
-
-

OUTPUTS

-
  type_id       - datatype identifier
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

OPTIONAL PARAMETERS

-
  tapl_id       - datatype access property list identifier.
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-  Added optional parameter 'tapl_id' for compatability
-  with H5Topen2. April 9, 2009.
-
-

SOURCE

-
  SUBROUTINE h5topen_f(loc_id, name, type_id, hdferr, tapl_id)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: loc_id  ! File or group identifier
-    CHARACTER(LEN=*), INTENT(IN) :: name ! Datatype name within file or group
-    INTEGER(HID_T), INTENT(OUT) :: type_id  ! Datatype identifier
-    INTEGER, INTENT(OUT) :: hdferr ! Error code
-    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id ! datatype access property list identifier
-
- -
- -

h5tpack_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tpack_f
-
-

PURPOSE

-
  Recursively removes padding from within a compound datatype.
-
-

INPUTS

-
  type_id       - compound datatype identifier
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tpack_f(type_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_cset_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_cset_f
-
-

PURPOSE

-
  Sets character set to be used.
-
-

INPUTS

-
  type_id       - datatype identifier
-  cset          - character set type of a string datatype
-                    Possible values are:
-                     H5T_CSET_ASCII_F = 0
-                     H5T_CSET_UTF8_F
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_cset_f(type_id, cset, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(IN) :: cset !character set type of a string datatype
-                                           ! Possible values of padding type are:
-                                           ! H5T_CSET_ASCII_F = 0
-                                           ! H5T_CSET_UTF8_F
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_ebias_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_ebias_f
-
-

PURPOSE

-
  Sets the exponent bias of a floating-point type.
-
-

INPUTS

-
  type_id       - datatype identifier
-  ebias         - datatype exponent bias
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_ebias_f(type_id, ebias, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER(SIZE_T), INTENT(IN) :: ebias !Datatype exponent bias of a floating-point type
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_fields_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_fields_f
-
-

PURPOSE

-
  Sets locations and sizes of floating point bit fields.
-
-

INPUTS

-
  type_id       - datatype identifier
-  spos          - sign bit-position
-  epos          - exponent bit-position
-  esize         - size of exponent in bits
-  mpos          - mantissa position
-  msize         - size of mantissa in bits
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_fields_f(type_id, spos, epos, esize, mpos, msize, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER(SIZE_T), INTENT(IN) :: spos   ! sign bit-position
-            INTEGER(SIZE_T), INTENT(IN) :: epos   ! exponent bit-position
-            INTEGER(SIZE_T), INTENT(IN) :: esize  ! size of exponent in bits
-            INTEGER(SIZE_T), INTENT(IN) :: mpos   ! mantissa bit-position
-            INTEGER(SIZE_T), INTENT(IN) :: msize  ! size of mantissa in bits
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_inpad_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_inpad_f
-
-

PURPOSE

-
  Fills unused internal floating point bits.
-
-

INPUTS

-
  type_id       - datatype identifier
-  padtype       - padding type for unused bits
-                  Possible values of padding type are:
-                    H5T_PAD_ZERO_F = 0
-                    H5T_PAD_ONE_F = 1
-                    H5T_PAD_BACKGROUND_F = 2
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_inpad_f(type_id, padtype, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(IN) :: padtype ! padding type for unused bits
-                                           ! in floating-point datatypes.
-                                           ! Possible values of padding type are:
-                                           ! H5T__PAD_ZERO_F = 0
-                                           ! H5T__PAD_ONE_F = 1
-                                           ! H5T__PAD_BACKGROUND_F = 2
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_norm_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_norm_f
-
-

PURPOSE

-
  Sets the mantissa normalization of a floating-point datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-  norm          - normalization types, valid values are:
-                    H5T_NORM_IMPLIED_F(0)
-                    H5T_NORM_MSBSET_F(1)
-                    H5T_NORM_NONE_F(2)
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_norm_f(type_id, norm, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(IN) :: norm !mantissa normalization of a floating-point datatype
-                                         !Valid normalization types are:
-                                         !H5T_NORM_IMPLIED_F(0),MSB of mantissa is not
-                                         !stored, always 1,  H5T_NORM_MSBSET_F(1), MSB of
-                                         !mantissa is always 1, H5T_NORM_NONE_F(2)
-                                         !Mantissa is not normalize
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_offset_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_offset_f
-
-

PURPOSE

-
  Sets the bit offset of the first significant bit.
-
-

INPUTS

-
  type_id       - datatype identifier
-  offset        - offset value
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_offset_f(type_id, offset, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER(SIZE_T), INTENT(IN) :: offset ! Datatype bit offset of the
-                                           ! first significant bit
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_order_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_order_f
-
-

PURPOSE

-
  Sets the byte ordering of an atomic datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-  order         - datatype byte order Possible values are:
-                    H5T_ORDER_LE_F
-                    H5T_ORDER_BE_F
-                    H5T_ORDER_VAX_F (not implemented yet)
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_order_f(type_id, order, hdferr)
-    IMPLICIT NONE
-    INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-    INTEGER, INTENT(IN) :: order   ! Datatype byte order, possible values
-                                   ! are:
-                                   ! H5T_ORDER_LE_F
-                                   ! H5T_ORDER_BE_F
-                                   ! H5T_ORDER_VAX_F
-    INTEGER, INTENT(OUT) :: hdferr ! Error code
-
- -
- -

h5tset_pad_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_pad_f
-
-

PURPOSE

-
  Sets the least and most-significant bits padding types.
-
-

INPUTS

-
  type_id       - datatype identifier
-  lsbpad        - least-significant bit padding type
-  msbpad        - most-significant bit padding type
-                  Possible values of padding type are:
-                    H5T_PAD_ERROR_F      = -1
-                    H5T_PAD_ZERO_F = 0
-                    H5T_PAD_ONE_F = 1
-                    H5T_PAD_BACKGROUND_F = 2
-                    H5T_PAD_NPAD_F      = 3
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_pad_f(type_id, lsbpad, msbpad, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(IN) :: lsbpad ! padding type of the
-                                           ! least significant bit
-            INTEGER, INTENT(IN) :: msbpad ! padding type of the
-                                           ! most significant bit
-                                           ! Possible values of padding type are:
-                                           ! H5T_PAD_ZERO_F = 0
-                                           ! H5T_PAD_ONE_F = 1
-                                           ! H5T_PAD_BACKGROUND_F = 2
-                                           ! H5T_PAD_ERROR_F      = -1
-                                           ! H5T_PAD_NPAD_F      = 3
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_precision_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_precision_f
-
-

PURPOSE

-
  Sets the precision of an atomic datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-  precision     - datatype precision
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_precision_f(type_id, precision, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER(SIZE_T), INTENT(IN) :: precision ! Datatype precision
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_sign_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_sign_f
-
-

PURPOSE

-
  Sets the sign proprety for an integer type.
-
-

INPUTS

-
  type_id       - datatype identifier
-  sign          - sign type
-                  Possible values are:
-                    - Unsigned integer type 
-                        H5T_SGN_NONE_F = 0
-                    - Two's complement signed integer type
-                        H5T_SGN_2_F = 1
-                    - error value: H5T_SGN_ERROR_F=-1
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_sign_f(type_id, sign, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(IN) :: sign !sign type for an integer type
-                                         !possible values are:
-                                         !Unsigned integer type H5T_SGN_NONE_F = 0
-                                         !Two's complement signed integer type
-                                         !H5T_SGN_2_F = 1
-                                         !or error value: H5T_SGN_ERROR_F=-1
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_size_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_size_f
-
-

PURPOSE

-
  Sets the total size for an atomic datatype.
-
-

INPUTS

-
  type_id       - datatype identifier
-  size          - size of the datatype
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_size_f(type_id, size, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER(SIZE_T), INTENT(IN) :: size ! Datatype size
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_strpad_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_strpad_f
-
-

PURPOSE

-
  Defines the storage mechanism for character strings.
-
-

INPUTS

-
  type_id       - datatype identifier
-  strpad        - storage method for a string datatype
-                  Possible values are:
-                    H5T_STR_NULLTERM_F,
-                    H5T_STR_NULLPAD_F,
-                    H5T_STR_SPACEPAD_F
-                    H5T_STR_ERROR_F
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_strpad_f(type_id, strpad, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            INTEGER, INTENT(IN) :: strpad ! string padding method for a string datatype
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tset_tag_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tset_tag_f
-
-

PURPOSE

-
  Tags an opaque datatype.
-
-

INPUTS

-
  type_id       - identifier for opaque datatype
-  tag           - unique ASCII string with which the opaque
-                  datatype is to be tagged.
-
-

OUTPUTS

-
  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  March 7, 2001
-
-

SOURCE

-
  SUBROUTINE h5tset_tag_f(type_id, tag, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
-            CHARACTER(LEN=*), INTENT(IN) :: tag !Unique ASCII string with which
-                                                !the opaque datatype is to be tagged
-            INTEGER, INTENT(OUT) :: hdferr        ! Error code
-
- -
- -

h5tvlen_create_f

- -

[ Top ] [ H5T ] [ Subroutines ]

-

NAME

-
  h5tvlen_create_f
-
-

PURPOSE

-
  Creates a new variable-length datatype.
-
-

INPUTS

-
  type_id       - identifier iof base datatype
-
-

OUTPUTS

-
  vltype_id     - identifier for VL datatype
-  hdferr        - Returns 0 if successful and -1 if fails
-
-

AUTHOR

-
  Elena Pourmal
-  Wednesday, October 23, 2002
-
-

NOTES

-
  Only basic Fortran base datatypes are supported
-
-

SOURCE

-
  SUBROUTINE h5tvlen_create_f(type_id, vltype_id, hdferr)
-            IMPLICIT NONE
-            INTEGER(HID_T), INTENT(IN)  :: type_id    ! Datatype identifier
-            INTEGER(HID_T), INTENT(OUT) :: vltype_id  ! VL datatype identifier
-            INTEGER, INTENT(OUT) :: hdferr            ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Zf_c.html b/fortran/doc/DevelGuide/src/H5Zf_c.html deleted file mode 100644 index 2973548..0000000 --- a/fortran/doc/DevelGuide/src/H5Zf_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5Zf.c - - - - - -
-
- -

H5Zf

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   This file contains C stubs for H5Z Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5Zff_f90.html b/fortran/doc/DevelGuide/src/H5Zff_f90.html deleted file mode 100644 index 8ccd0ae..0000000 --- a/fortran/doc/DevelGuide/src/H5Zff_f90.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - -./src/H5Zff.f90 - - - - - -
-
- -

H5Z

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5Z
-
-

PURPOSE

-
  This file contains Fortran interfaces for H5Z functions. It includes
-  all the functions that are independent on whether the Fortran 2003 functions
-  are enabled or disabled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new H5Z function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5zfilter_avail_f

- -

[ Top ] [ H5Z ] [ Subroutines ]

-

NAME

-
  h5zfilter_avail_f
-
-

PURPOSE

-
  Queries if filter is available
-
-

INPUTS

-
  filter        - filter
-
-

OUTPUTS

-
  status        - status; .TRUE. if filter is available,
-                  .FALSE. otherwise
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  March 12, 2003
-
-

SOURCE

-
  SUBROUTINE h5zfilter_avail_f(filter, status, hdferr)
-    IMPLICIT NONE
-    INTEGER, INTENT(IN)  :: filter      ! Filter; may be one of the following:
-                                        !   H5Z_FILTER_DEFLATE_F
-                                        !   H5Z_FILTER_SZIP_F
-                                        !   H5Z_FILTER_NBIT_F
-                                        !   H5Z_FILTER_SCALEOFFSET_F
-                                        !   H5Z_FILTER_SHUFFLE_F
-                                        !   H5Z_FILTER_FLETCHER32_F
-    LOGICAL, INTENT(OUT) :: status      ! Flag, idicates if filter
-                                        ! is availble  not ( TRUE or
-                                        ! FALSE)
-    INTEGER, INTENT(OUT) :: hdferr      ! Error code
-
- -
- -

h5zget_filter_info_f

- -

[ Top ] [ H5Z ] [ Subroutines ]

-

NAME

-
  h5zget_filter_info_f
-
-

PURPOSE

-
  Queries if filter has its encoder and/or decoder
-  available
-
-

INPUTS

-
  filter        - filter
-
-

OUTPUTS

-
  config_flags  - Bit vector possibly containing the
-                  following values:
-                     H5Z_FILTER_ENCODE_ENABLED_F
-                     H5Z_FILTER_DECODE_ENABLED_F
-  hdferr:       - error code
-                   Success:  0
-                   Failure: -1
-
-

AUTHOR

-
  Nat Furrer and James Laird
-  June 16, 2004
-
-

SOURCE

-
  SUBROUTINE h5zget_filter_info_f(filter, config_flags, hdferr)
-    IMPLICIT NONE
-    INTEGER, INTENT(IN)  :: filter      ! Filter; may be one of the following:
-                                        !   H5Z_FILTER_DEFLATE_F
-                                        !   H5Z_FILTER_SZIP_F
-                                        !   H5Z_FILTER_NBIT_F
-                                        !   H5Z_FILTER_SCALEOFFSET_F
-                                        !   H5Z_FILTER_SHUFFLE_F
-                                        !   H5Z_FILTER_FLETCHER32_F
-    INTEGER, INTENT(OUT) :: config_flags! Flag, indicates if filter
-                                        ! has its encoder and/or decoder
-                                        ! available
-    INTEGER, INTENT(OUT) :: hdferr      ! Error code
-
- -
- -

h5zunregister_f

- -

[ Top ] [ H5Z ] [ Subroutines ]

-

NAME

-
  h5zunregister_f
-
-

PURPOSE

-
  Unregisters specified filetr
-
-

INPUTS

-
  filter - filter; may have one of the following values:
-            H5Z_FILTER_DEFLATE_F
-            H5Z_FILTER_SZIP_F
-            H5Z_FILTER_NBIT_F
-            H5Z_FILTER_SCALEOFFSET_F
-            H5Z_FILTER_SHUFFLE_F
-            H5Z_FILTER_FLETCHER32_F
-
-

OUTPUTS

-
  hdferr - error code
-            Success:  0
-            Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  March 12, 2003
-
-

SOURCE

-
  SUBROUTINE h5zunregister_f(filter, hdferr)
-    IMPLICIT NONE
-    INTEGER, INTENT(IN)  :: filter
-    INTEGER, INTENT(OUT) :: hdferr  ! Error code
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5_DBLE_InterfaceExclude_f90.html b/fortran/doc/DevelGuide/src/H5_DBLE_InterfaceExclude_f90.html deleted file mode 100644 index 4e51e7f..0000000 --- a/fortran/doc/DevelGuide/src/H5_DBLE_InterfaceExclude_f90.html +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - -./src/H5_DBLE_InterfaceExclude.f90 - - - - - -
-
- -

src/H5_DBLE_InterfaceExclude.f90

- -

[ Top ] [ Modules ]

-

NAME

-
   H5_DBLE_INTERFACE
-
-

FUNCTION

-
   This module is used for when the default REAL is of type DOUBLE PRECISION.
-   We do not include the double precision interfaces if the defaut REAL is
-   DOUBLE PRECISION since this would lead to a non-unique conflict with the
-   generic interfaces declared as REAL and those declared as DOUBLE PRECISION.
-
-

NOTES

-
   Empty module.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5_DBLE_InterfaceInclude_f90.html b/fortran/doc/DevelGuide/src/H5_DBLE_InterfaceInclude_f90.html deleted file mode 100644 index 5a71d52..0000000 --- a/fortran/doc/DevelGuide/src/H5_DBLE_InterfaceInclude_f90.html +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - -./src/H5_DBLE_InterfaceInclude.f90 - - - - - -
-
- -

src/H5_DBLE_InterfaceInclude.f90

- -

[ Top ] [ Modules ]

-

NAME

-
   H5_DBLE_INTERFACE
-
-

FUNCTION

-
   This module is used for when the default REAL is not of the type DOUBLE PRECISION.
-   We only do not include the double precision interfaces if the defaut REAL is
-   DOUBLE PRECISION since this would lead to a non-unique conflict with the
-   generic interfaces declared as REAL. Otherwise it is okay to include the interfaces.
-
-

NOTES

-
   This module contains all the DOUBLE PRECISION interfaces and corresponding subroutines
-   from the HDF function catagory H5A, H5D and H5P.
-
-

AUTHOR

-
  M. Scot Breitenfeld
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5_f_c.html b/fortran/doc/DevelGuide/src/H5_f_c.html deleted file mode 100644 index 2bdbce1..0000000 --- a/fortran/doc/DevelGuide/src/H5_f_c.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -./src/H5_f.c - - - - - -
-
- -

fortran/src/H5_f.c

- -

[ Top ] [ Modules ]

-

FUNCTION

-
   This file contains C stubs for H5 Fortran APIs
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5_ff_F03_f90.html b/fortran/doc/DevelGuide/src/H5_ff_F03_f90.html deleted file mode 100644 index 17f07c1..0000000 --- a/fortran/doc/DevelGuide/src/H5_ff_F03_f90.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - -./src/H5_ff_F03.f90 - - - - - -
-
- -

H5LIB_PROVISIONAL

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5LIB_PROVISIONAL
-
-

PURPOSE

-
  This file contains helper functions for Fortran 2003 features and is
-  only compiled when Fortran 2003 features are enabled, otherwise
-  the file H5_ff_F90.f90 is compiled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5offsetof

- -

[ Top ] [ H5LIB_PROVISIONAL ] [ Functions ]

-

NAME

-
  h5offsetof
-
-

PURPOSE

-
  Computes the offset in memory
-
-

INPUTS

-
  start - starting pointer address
-  end   - ending pointer address
-
-

OUTPUTS

-
  offset - offset
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  Augest 25, 2008
-
-

SOURCE

-
  FUNCTION h5offsetof(start,end) RESULT(offset)
-    USE, INTRINSIC :: ISO_C_BINDING
-    USE H5GLOBAL
-    IMPLICIT NONE
-    INTEGER(SIZE_T) :: offset
-    TYPE(C_PTR), VALUE, INTENT(IN) :: start, end
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5_ff_F90_f90.html b/fortran/doc/DevelGuide/src/H5_ff_F90_f90.html deleted file mode 100644 index c310ef2..0000000 --- a/fortran/doc/DevelGuide/src/H5_ff_F90_f90.html +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - -./src/H5_ff_F90.f90 - - - - - -
-
- -

H5LIB_PROVISIONAL (F90)

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5LIB_PROVISIONAL
-
-

FILE

-
  fortran/src/H5_ff_F90.f90
-
-

PURPOSE

-
  This file is a dummy module for when Fortran 2003 features are not enabled.
-  It is compiled in place of H5_ff_F03.f90 and is empty.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5_ff_f90.html b/fortran/doc/DevelGuide/src/H5_ff_f90.html deleted file mode 100644 index 021c7c5..0000000 --- a/fortran/doc/DevelGuide/src/H5_ff_f90.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - - - -./src/H5_ff.f90 - - - - - -
-
- -

H5LIB

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5LIB
-
-

PURPOSE

-
  This module provides fortran specific helper functions for the HDF library
-
-

USES

-
  H5LIB_PROVISIONAL - This module provides helper functions for Fortran 2003
-                      only features. If Fortran 2003 functions are enabled then
-                      H5_ff_F03.f90 is compiled, else H5_ff_F90.f90,
-                      which is just a place holder blank module, is compiled.
-
-

NOTES

-
                         *** IMPORTANT ***
-  If you add a new function you must add the function name to the
-  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
-  This is needed for Windows based operating systems.
-
- -
- -

h5check_version_f

- -

[ Top ] [ H5LIB ] [ Subroutines ]

-

NAME

-
  h5check_version_f
-
-

PURPOSE

-
  Verifies that library versions are consistent.
-
-

INPUTS

-
  majnum               - major version of the library
-  minum                - minor version of the library
-  relnum               - release version of the library
-
-

OUTPUTS

-
  error                - error code
-                          Success:  0
-                          Failure:  application aborts
-
-

AUTHOR

-
  Elena Pourmal
-  September 24, 2002
-
-

SOURCE

-
  SUBROUTINE h5check_version_f(majnum, minnum, relnum, error)
-    USE H5GLOBAL
-    IMPLICIT NONE
-    INTEGER, INTENT(IN) :: majnum, minnum, relnum
-    INTEGER, INTENT(OUT) :: error
-
- -
- -

h5close_f

- -

[ Top ] [ H5LIB ] [ Subroutines ]

-

NAME

-
  h5close_f
-
-

PURPOSE

-
  Closes the HDF5 library and Fortran90 interface.
-
-

OUTPUTS

-
  error - error code
-            Success:  0
-            Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5close_f(error)
-    USE H5GLOBAL
-    IMPLICIT NONE
-    INTEGER, INTENT(OUT) :: error
-
- -
- -

h5dont_atexit_f

- -

[ Top ] [ H5LIB ] [ Subroutines ]

-

NAME

-
  h5dont_atexit_f
-
-

PURPOSE

-
  Instructs library not to install atexit cleanup routine.
-
-

OUTPUTS

-
  error  - error code
-             Success:  0
-             Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  September 24, 2002
-
-

SOURCE

-
  SUBROUTINE h5dont_atexit_f(error)
-    USE H5GLOBAL
-    IMPLICIT NONE
-    INTEGER, INTENT(OUT) :: error
-
- -
- -

h5garbage_collect_f

- -

[ Top ] [ H5LIB ] [ Subroutines ]

-

NAME

-
  h5garbage_collect_f
-
-

PURPOSE

-
  Garbage collects on all free-lists of all types.
-
-

OUTPUTS

-
  error  - error code
-             Success:  0
-             Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  September 24, 2002
-
-

SOURCE

-
  SUBROUTINE h5garbage_collect_f(error)
-    USE H5GLOBAL
-    IMPLICIT NONE
-    INTEGER, INTENT(OUT) :: error
-
- -
- -

h5get_libversion_f

- -

[ Top ] [ H5LIB ] [ Subroutines ]

-

NAME

-
  h5get_libversion_f
-
-

PURPOSE

-
  Returns the HDF5 LIbrary release number
-
-

OUTPUTS

-
  majnum               - major version of the library
-  minum                - minor version of the library
-  relnum               - release version of the library
-  error                - error code
-                           Success:  0
-                           Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  September 24, 2002
-
-

SOURCE

-
  SUBROUTINE h5get_libversion_f(majnum, minnum, relnum, error)
-    USE H5GLOBAL
-    IMPLICIT NONE
-    INTEGER, INTENT(OUT) :: majnum, minnum, relnum, error
-
- -
- -

h5kind_to_type

- -

[ Top ] [ H5LIB ] [ Functions ]

-

NAME

-
  h5kind_to_type
-
-

PURPOSE

-
  Converts the KIND to the correct HDF type
-
-

INPUTS

-
  kind    - Fortran KIND parameter
-  flag    - whether KIND is of type INTEGER or REAL:
-              H5_INTEGER_KIND - integer
-              H5_REAL_KIND    - real
-
-

OUTPUTS

-
  h5_type - returns the type
-
-

AUTHOR

-
  M. Scot Breitenfeld
-  Augest 25, 2008
-
-

SOURCE

-
  INTEGER(HID_T) FUNCTION h5kind_to_type(kind, flag) RESULT(h5_type)
-    USE H5GLOBAL
-    IMPLICIT NONE
-    INTEGER, INTENT(IN) :: kind
-    INTEGER, INTENT(IN) :: flag
-
- -
- -

h5open_f

- -

[ Top ] [ H5LIB ] [ Subroutines ]

-

NAME

-
  h5open_f
-
-

PURPOSE

-
  Initializes the HDF5 library and Fortran90 interface.
-
-

OUTPUTS

-
  error - error code
-            Success:  0
-            Failure: -1
-
-

AUTHOR

-
  Elena Pourmal
-  August 12, 1999
-
-

HISTORY

-
  Explicit Fortran interfaces were added for
-  called C functions (it is needed for Windows
-  port).  February 28, 2001
-
-

SOURCE

-
  SUBROUTINE h5open_f(error)
-    USE H5GLOBAL
-    IMPLICIT NONE
-    INTEGER, INTENT(OUT) :: error
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5f90global_f90.html b/fortran/doc/DevelGuide/src/H5f90global_f90.html deleted file mode 100644 index 587b6d0..0000000 --- a/fortran/doc/DevelGuide/src/H5f90global_f90.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - -./src/H5f90global.f90 - - - - - -
-
- -

H5GLOBAL

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE H5GLOBAL
-
-

FILE

-
  src/fortran/H5f90global.f90
-
-

PURPOSE

-
  This module is used to pass C stubs for H5 Fortran APIs. The C stubs are
-  packed into arrays in H5_f.c and these arrays are then passed to Fortran.
-  This module then uses EQUIVALENCE to assign elements of the arrays to
-  Fortran equivalent C stubs.
-
-

NOTES

-
  The size of the C arrays in H5_f.c has to match the values of the variables
-  declared as PARAMETER, hence if the size of an array in H5_f.c is changed
-  then the PARAMETER of that corresponding array in Fortran must also be changed.
-
-

USES

-
  H5FORTRAN_TYPES       - This module is generated at run time. See
-
-

AUTHOR

-
  Elena Pourmal
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5f90kit_c.html b/fortran/doc/DevelGuide/src/H5f90kit_c.html deleted file mode 100644 index 1329a87..0000000 --- a/fortran/doc/DevelGuide/src/H5f90kit_c.html +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - -./src/H5f90kit.c - - - - - -
-
- -

H5f90kit

- -

[ Top ] [ Modules ]

-

PURPOSE

-
   Routines from HDF4 to deal with C-FORTRAN issues:
-
-   HD5f2cstring   -- convert a Fortran string to a C string
-   HD5packFstring -- convert a C string into a Fortran string
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5match_types_c.html b/fortran/doc/DevelGuide/src/H5match_types_c.html deleted file mode 100644 index 083319a..0000000 --- a/fortran/doc/DevelGuide/src/H5match_types_c.html +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - -./src/H5match_types.c - - - - - -
-
- -

H5match_types

- -

[ Top ] [ Procedures ]

-

NAME

-
  Executable: H5match_types
-
-

FILE

-
  fortran/src/H5match_types.c
-
-

PURPOSE

-
  C Program to match C types to Fortran types.
-  Creates the files H5f90i_gen.h for the C code and
-  H5fortran_types.f90 for the Fortran code.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5test_kind_SIZEOF_f90.html b/fortran/doc/DevelGuide/src/H5test_kind_SIZEOF_f90.html deleted file mode 100644 index 3494db0..0000000 --- a/fortran/doc/DevelGuide/src/H5test_kind_SIZEOF_f90.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - -./src/H5test_kind_SIZEOF.f90 - - - - - -
-
- -

H5test_kind_SIZEOF

- -

[ Top ] [ Procedures ]

-

NAME

-
  Executable: H5test_kind
-
-

FILE

-
  fortran/src/H5test_kind_SIZEOF.f90
-
-

PURPOSE

-
  This stand alone program is used at build time to generate the program
-  H5fortran_detect.f90. It cycles through all the available KIND parameters for
-  integers and reals. The appropriate program and subroutines are then generated
-  depending on which of the KIND values are found.
-
-

NOTES

-
  This program is used in place of H5test_kind.f90 when the Fortran intrinsic
-  function SIZEOF is available. It generates code that makes use of SIZEOF in
-  H5fortran_detect.f90 which is a portable solution.
-
-  The availability of SIZEOF is checked at configure time and the TRUE/FALSE
-  condition is set in the configure variable "FORTRAN_HAVE_SIZEOF".
-
-

AUTHOR

-
  M. Scot Breitenfeld
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/H5test_kind_f90.html b/fortran/doc/DevelGuide/src/H5test_kind_f90.html deleted file mode 100644 index c08e488..0000000 --- a/fortran/doc/DevelGuide/src/H5test_kind_f90.html +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - -./src/H5test_kind.f90 - - - - - -
-
- -

H5test_kind

- -

[ Top ] [ Procedures ]

-

NAME

-
  Executable: H5test_kind
-
-

FILE

-
  fortran/src/H5test_kind.f90
-
-

PURPOSE

-
  This stand alone program is used at build time to generate the program
-  H5fortran_detect.f90. It cycles through all the available KIND parameters for
-  integers and reals. The appropriate program and subroutines are then generated
-  depending on which of the KIND values are found.
-
-

NOTES

-
  This program is depreciated in favor of H5test_kind_SIZEOF.f90 and is only
-  used when the Fortran intrinsic function SIZEOF is not available. It generates
-  code that does not make use of SIZEOF in H5fortran_detect.f90 which is less
-  portable in comparison to using SIZEOF.
-
-  The availability of SIZEOF is checked at configure time and the TRUE/FALSE
-  condition is set in the configure variable "FORTRAN_HAVE_SIZEOF".
-
-

AUTHOR

-
  Elena Pourma
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/HDF5_f90.html b/fortran/doc/DevelGuide/src/HDF5_f90.html deleted file mode 100644 index 1490c7c..0000000 --- a/fortran/doc/DevelGuide/src/HDF5_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./src/HDF5.f90 - - - - - -
-
- -

HDF5

- -

[ Top ] [ Modules ]

-

NAME

-
  MODULE HDF5
-
-

FILE

-
  src/fortran/src/HDF5.f90
-
-

PURPOSE

-
  This is the main module used for linking to the Fortran HDF library.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/src/HDF5mpio_f90.html b/fortran/doc/DevelGuide/src/HDF5mpio_f90.html deleted file mode 100644 index 9ef5f32..0000000 --- a/fortran/doc/DevelGuide/src/HDF5mpio_f90.html +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - -./src/HDF5mpio.f90 - - - - - -
-
- -

HDF5 (mpio)

- -

[ Top ] [ Modules ]

-

NAME

-
  HDF5
-
-

PURPOSE

-
  This is the main module used for linking to the Fortran parallel HDF library.
-  This file replaces HDF5.f90 when compiling the parallel library.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/fflush1_f90.html b/fortran/doc/DevelGuide/test/fflush1_f90.html deleted file mode 100644 index eaab841..0000000 --- a/fortran/doc/DevelGuide/test/fflush1_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./test/fflush1.f90 - - - - - -
-
- -

fortran/test/fflush1.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  FFLUSH1EXAMPLE
-
-

FUNCTION

-
  This is the first half of a two-part test that makes sure
-  that a file can be read after an application crashes as long
-  as the file was flushed first.  We simulate by exit the 
-  the program using stop statement
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/fflush2_f90.html b/fortran/doc/DevelGuide/test/fflush2_f90.html deleted file mode 100644 index 23b7797..0000000 --- a/fortran/doc/DevelGuide/test/fflush2_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./test/fflush2.f90 - - - - - -
-
- -

fortran/test/fflush2.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  fflush2.f90
-
-

FUNCTION

-
  This is the second half of a two-part test that makes sure
-  that a file can be read after an application crashes as long
-  as the file was flushed first.  This half tries to read the
-  file created by the first half.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/fortranlib_test_1_8_f90.html b/fortran/doc/DevelGuide/test/fortranlib_test_1_8_f90.html deleted file mode 100644 index 3ce387d..0000000 --- a/fortran/doc/DevelGuide/test/fortranlib_test_1_8_f90.html +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - -./test/fortranlib_test_1_8.f90 - - - - - -
-
- -

fortran/test/fortranlib_test_1_8.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  fortranlib_test_1_8.f90
-
-

FUNCTION

-
  Basic testing of Fortran API's introduced in 1.8 release.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/fortranlib_test_F03_f90.html b/fortran/doc/DevelGuide/test/fortranlib_test_F03_f90.html deleted file mode 100644 index 1a0c7be..0000000 --- a/fortran/doc/DevelGuide/test/fortranlib_test_F03_f90.html +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - -./test/fortranlib_test_F03.f90 - - - - - -
-
- -

fortran/test/fortranlib_test_F03.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  fortranlib_test_F03.f90
-
-

FUNCTION

-
  Basic testing of Fortran API's requiring Fortran 2003
-  compliance.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/fortranlib_test_f90.html b/fortran/doc/DevelGuide/test/fortranlib_test_f90.html deleted file mode 100644 index 29fb2f1..0000000 --- a/fortran/doc/DevelGuide/test/fortranlib_test_f90.html +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - -./test/fortranlib_test.f90 - - - - - -
-
- -

fortran/test/fortranlib_test.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  fortranlib_test.f90
-
-

FUNCTION

-
  Basic testing of Fortran API's functionality.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tF2003_f90.html b/fortran/doc/DevelGuide/test/tF2003_f90.html deleted file mode 100644 index 8101411..0000000 --- a/fortran/doc/DevelGuide/test/tF2003_f90.html +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - -./test/tF2003.f90 - - - - - -
-
- -

fortran/test/tF2003.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tF2003.f90
-
-

FUNCTION

-
  Test FORTRAN HDF5 APIs which are dependent on the FORTRAN 2003
-  features. Tests H5L, H5P, H5T APIs. 
-
-

USES

-
  liter_cb_mod, test_genprop_cls_cb1_mod
-
-

CONTAINS SUBROUTINES

-
  test_iter_group, test_create, test_genprop_class_callback,
-  test_array_compound_atomic, test_array_compound_array,
-  test_array_bkg 
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5A_1_8_f90.html b/fortran/doc/DevelGuide/test/tH5A_1_8_f90.html deleted file mode 100644 index c217d99..0000000 --- a/fortran/doc/DevelGuide/test/tH5A_1_8_f90.html +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - -./test/tH5A_1_8.f90 - - - - - -
-
- -

fortran/test/tH5A_1_8.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5A_1_8.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5A APIs introduced in 1.8.
-
-

CONTAINS SUBROUTINES

-
  attribute_test_1_8, test_attr_corder_create_compact, test_attr_null_space,
-  test_attr_create_by_name, test_attr_info_by_idx, attr_info_by_idx_check,
-  test_attr_shared_rename, test_attr_delete_by_idx, test_attr_shared_delete,
-  test_attr_dense_open, test_attr_dense_verify, test_attr_corder_create_basic,
-  test_attr_basic_write, test_attr_many, attr_open_check, 
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5A_f90.html b/fortran/doc/DevelGuide/test/tH5A_f90.html deleted file mode 100644 index 87c5a45..0000000 --- a/fortran/doc/DevelGuide/test/tH5A_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./test/tH5A.f90 - - - - - -
-
- -

fortran/test/tH5A.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5A.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5A APIs.
-
-

CONTAINS SUBROUTINES

-
  attribute_test 
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5D_f90.html b/fortran/doc/DevelGuide/test/tH5D_f90.html deleted file mode 100644 index c840425..0000000 --- a/fortran/doc/DevelGuide/test/tH5D_f90.html +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - -./test/tH5D.f90 - - - - - -
-
- -

fortran/test/tH5D.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5D.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5D APIs.
-
-

NOTES

-
  Tests the H5D APIs functionalities of:
-   h5dcreate_f, h5dopen_f, h5dclose_f, h5dget_space_f, h5dget_type_f,
-   h5dread_f, and h5dwrite_f
-
-

CONTAINS SUBROUTINES

-
  datasettest, extenddsettest
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5E_f90.html b/fortran/doc/DevelGuide/test/tH5E_f90.html deleted file mode 100644 index 6a1ef56..0000000 --- a/fortran/doc/DevelGuide/test/tH5E_f90.html +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - -./test/tH5E.f90 - - - - - -
-
- -

fortran/test/tH5E.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5E.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5E APIs.
-
-

NOTES

-
  Tests the H5D APIs functionalities of:
-   h5eprint_f
-
-

CONTAINS SUBROUTINES

-
  error_report_test
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5F_f90.html b/fortran/doc/DevelGuide/test/tH5F_f90.html deleted file mode 100644 index d1aff59..0000000 --- a/fortran/doc/DevelGuide/test/tH5F_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./test/tH5F.f90 - - - - - -
-
- -

fortran/test/tH5F.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5F.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5F APIs.
-
-

CONTAINS SUBROUTINES

-
  mountingtest, reopentest, plisttest, file_close, file_space
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5G_1_8_f90.html b/fortran/doc/DevelGuide/test/tH5G_1_8_f90.html deleted file mode 100644 index 81fdd3c..0000000 --- a/fortran/doc/DevelGuide/test/tH5G_1_8_f90.html +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - -./test/tH5G_1_8.f90 - - - - - -
-
- -

fortran/test/tH5G_1_8.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5G_1_8.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5G APIs introduced in 1.8.
-
-

CONTAINS SUBROUTINES

-
  group_test, group_info, timestamps, mklinks, test_move_preserves, lifecycle
-  cklinks, delete_by_idx, link_info_by_idx_check, test_lcpl, objcopy, 
-  lapl_nlinks
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5G_f90.html b/fortran/doc/DevelGuide/test/tH5G_f90.html deleted file mode 100644 index 6c60a3c..0000000 --- a/fortran/doc/DevelGuide/test/tH5G_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./test/tH5G.f90 - - - - - -
-
- -

fortran/test/tH5G.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5G.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5G APIs.
-
-

CONTAINS SUBROUTINES

-
  group_test
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5I_f90.html b/fortran/doc/DevelGuide/test/tH5I_f90.html deleted file mode 100644 index 52e21fc..0000000 --- a/fortran/doc/DevelGuide/test/tH5I_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./test/tH5I.f90 - - - - - -
-
- -

fortran/test/tH5I.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5I.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5I APIs.
-
-

CONTAINS SUBROUTINES

-
  identifier_test
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5O_f90.html b/fortran/doc/DevelGuide/test/tH5O_f90.html deleted file mode 100644 index a128da5..0000000 --- a/fortran/doc/DevelGuide/test/tH5O_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./test/tH5O.f90 - - - - - -
-
- -

fortran/test/tH5O.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5O.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5O APIs.
-
-

CONTAINS SUBROUTINES

-
  test_h5o, test_h5o_link, test_h5o_plist
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5P_f90.html b/fortran/doc/DevelGuide/test/tH5P_f90.html deleted file mode 100644 index edc0787..0000000 --- a/fortran/doc/DevelGuide/test/tH5P_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./test/tH5P.f90 - - - - - -
-
- -

fortran/test/tH5P.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5P.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5P APIs.
-
-

CONTAINS SUBROUTINES

-
  external_test, multi_file_test
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5R_f90.html b/fortran/doc/DevelGuide/test/tH5R_f90.html deleted file mode 100644 index fd44062..0000000 --- a/fortran/doc/DevelGuide/test/tH5R_f90.html +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - -./test/tH5R.f90 - - - - - -
-
- -

fortran/test/tH5R.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5R.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5R, Reference Interface, APIs.
-
-

NOTES

-
  Tests h5rcreate_f, h5rdereference_f, h5rget_name_f 
-  and H5Rget_object_type functions
-
-

CONTAINS SUBROUTINES

-
  refobjtest, refregtest
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5S_f90.html b/fortran/doc/DevelGuide/test/tH5S_f90.html deleted file mode 100644 index 5879d28..0000000 --- a/fortran/doc/DevelGuide/test/tH5S_f90.html +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - -./test/tH5S.f90 - - - - - -
-
- -

fortran/test/tH5S.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5S.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5S, Dataspace Interface, APIs.
-
-

NOTES

-
  Tests the following functionalities:
-   h5screate_f, h5scopy_f, h5screate_simple_f, h5sis_simple_f,
-   h5sget_simple_extent_dims_f,h5sget_simple_extent_ndims_f
-   h5sget_simple_extent_npoints_f, h5sget_simple_extent_type_f,
-   h5sextent_copy_f, h5sset_extent_simple_f, h5sset_extent_none_f
-
-

CONTAINS SUBROUTINES

-
  dataspace_basic_test
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5Sselect_f90.html b/fortran/doc/DevelGuide/test/tH5Sselect_f90.html deleted file mode 100644 index e8eaa73..0000000 --- a/fortran/doc/DevelGuide/test/tH5Sselect_f90.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - -./test/tH5Sselect.f90 - - - - - -
-
- -

fortran/test/tH5Sselect.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5Sselect.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5S, Selection-related Dataspace Interface, APIs.
-
-

NOTES

-
  Tests the following functionalities:
-    h5sget_select_npoints_f, h5sselect_elements_f, h5sselect_all_f,
-    h5sselect_none_f, h5sselect_valid_f, h5sselect_hyperslab_f,
-    h5sget_select_bounds_f, h5sget_select_elem_pointlist_f,
-    h5sget_select_elem_npoints_f, h5sget_select_hyper_blocklist_f,
-    h5sget_select_hyper_nblocks_f, h5sget_select_npoints_f   
-
-

CONTAINS SUBROUTINES

-
  test_select_hyperslab, test_select_element, test_basic_select,
-  test_select_point, test_select_combine, test_select_bounds
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5T_f90.html b/fortran/doc/DevelGuide/test/tH5T_f90.html deleted file mode 100644 index 35006b3..0000000 --- a/fortran/doc/DevelGuide/test/tH5T_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./test/tH5T.f90 - - - - - -
-
- -

fortran/test/tH5T.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5T.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5T APIs.
-
-

CONTAINS SUBROUTINES

-
  compoundtest, basic_data_type_test, enumtest, test_derived_flt
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5VL_f90.html b/fortran/doc/DevelGuide/test/tH5VL_f90.html deleted file mode 100644 index a34a01d..0000000 --- a/fortran/doc/DevelGuide/test/tH5VL_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./test/tH5VL.f90 - - - - - -
-
- -

fortran/test/tH5VL.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5VL.f90
-
-

FUNCTION

-
  Basic testing of Fortran Variable_length datatypes APIs.
-
-

CONTAINS SUBROUTINES

-
  vl_test_integer, vl_test_real, vl_test_string 
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tH5Z_f90.html b/fortran/doc/DevelGuide/test/tH5Z_f90.html deleted file mode 100644 index 94325b9..0000000 --- a/fortran/doc/DevelGuide/test/tH5Z_f90.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - -./test/tH5Z.f90 - - - - - -
-
- -

fortran/test/tH5Z.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tH5Z.f90
-
-

FUNCTION

-
  Basic testing of Fortran H5Z szip APIs.
-
-

CONTAINS SUBROUTINES

-
  filters_test, szip_test
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/t_c.html b/fortran/doc/DevelGuide/test/t_c.html deleted file mode 100644 index c9512a7..0000000 --- a/fortran/doc/DevelGuide/test/t_c.html +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - -./test/t.c - - - - - -
-
- -

fortran/test/tc.c

- -

[ Top ] [ Modules ]

-

NAME

-
   tc.c
-
-

FUNCTION

-
   This file contains C routines needed for the test programs.
-
- -
- - - diff --git a/fortran/doc/DevelGuide/test/tf_f90.html b/fortran/doc/DevelGuide/test/tf_f90.html deleted file mode 100644 index e3c51f4..0000000 --- a/fortran/doc/DevelGuide/test/tf_f90.html +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - -./test/tf.f90 - - - - - -
-
- -

fortran/test/tf.f90

- -

[ Top ] [ Modules ]

-

NAME

-
  tf.f90
-
-

FUNCTION

-
  Contains subroutines which are needed in all the hdf5 fortran tests
-
-

CONTAINS SUBROUTINES

-
  write_test_status, check, verify, verifyLogical, verifyString, h5_fixname_f,
-  h5_cleanup_f, h5_exit_f, h5_env_nocleanup_f
-
- -
- - - diff --git a/fortran/doc/DevelGuide/toc_index.html b/fortran/doc/DevelGuide/toc_index.html deleted file mode 100644 index 94a2792..0000000 --- a/fortran/doc/DevelGuide/toc_index.html +++ /dev/null @@ -1,552 +0,0 @@ - - - - - - - -Table of Contents - - - - -
-
- -
-

TABLE OF CONTENTS

- -
- - - -- cgit v0.12