diff options
| author | mattjala <124107509+mattjala@users.noreply.github.com> | 2024-01-31 22:16:49 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-31 22:16:49 (GMT) |
| commit | d1ed02d49f5151954247f3b8a2ae7440c58b8a16 (patch) | |
| tree | bc74116eb72730ec9d0dccf19c6c05770ca0170c | |
| parent | bca1dc10a39c5176c540b51fe51f921eb5a82ae4 (diff) | |
| download | hdf5-d1ed02d49f5151954247f3b8a2ae7440c58b8a16.zip hdf5-d1ed02d49f5151954247f3b8a2ae7440c58b8a16.tar.gz hdf5-d1ed02d49f5151954247f3b8a2ae7440c58b8a16.tar.bz2 | |
Clarify vlen string datatype message (#3950)
| -rw-r--r-- | doxygen/examples/H5.format.html | 24 |
1 files changed, 19 insertions, 5 deletions
diff --git a/doxygen/examples/H5.format.html b/doxygen/examples/H5.format.html index 832e3fc..7aba5fe 100644 --- a/doxygen/examples/H5.format.html +++ b/doxygen/examples/H5.format.html @@ -10780,6 +10780,12 @@ within the embedded dataspace]<br /> <a name="ClassReference"></a> <p>Class specific information for the Reference class (Class 7):</p> + <p>Note that for region references, the stored data is + a <a href="#GlobalHeapID">Global Heap ID</a> pointing to information + about the region stored in the global heap. + </p> + + <div align="center"> <table class="desc"> <caption> @@ -11118,6 +11124,11 @@ within the embedded dataspace]<br /> <a name="ClassVarLen"></a> <p>Class specific information for the Variable-length class (Class 9):</p> + <p>Note that data with a variable length type is stored on the global heap. + Locations that would normally store the data directly (e.g. attribute message) + will instead contain a <a href="#GlobalHeapID">Global Heap ID</a>. + </p> + <div align="center"> <table class="desc"> <caption> @@ -11276,7 +11287,7 @@ within the embedded dataspace]<br /> </tr> <tr> - <td colspan="4"><br />Base Type<br /><br /></td> + <td colspan="4"><br />Parent Type Message<br /><br /></td> </tr> </table> @@ -11294,11 +11305,14 @@ within the embedded dataspace]<br /> </tr> <tr> - <td><p>Base Type</p></td> + <td><p>Parent Type</p></td> <td> - <p>Each variable-length type is based on some parent type. The - information for that parent type is described recursively by - this field. + <p>Each variable-length type is based on some parent type. + This field contains the datatype message describing that parent type. + In the case of nested variable-length types, this parent datatype message will + recursively contain all parent datatype messages. + + Variable-length strings are considered to have the parent type `H5T_NATIVE_UCHAR`. </p> </td> </tr> |