diff options
Diffstat (limited to 'doc/html')
| -rw-r--r-- | doc/html/H5T/H5Tget_order.htm | 29 | ||||
| -rw-r--r-- | doc/html/H5T/H5Tset_order.htm | 54 |
2 files changed, 44 insertions, 39 deletions
diff --git a/doc/html/H5T/H5Tget_order.htm b/doc/html/H5T/H5Tget_order.htm index 294aaae..048433b 100644 --- a/doc/html/H5T/H5Tget_order.htm +++ b/doc/html/H5T/H5Tget_order.htm @@ -4,10 +4,12 @@ <dl> <dt><strong>Name:</strong> <a name="Datatype-GetOrder">H5Tget_order</a> <dt><strong>Signature:</strong> - <dd><em>H5T_order_t </em><code>H5Tget_order</code>(<em>hid_t </em><code>type_id</code> + <dd><em>H5T_order_t </em><code>H5Tget_order</code>(<em>hid_t </em><code>dtype_id</code> ) + <p> <dt><strong>Purpose:</strong> <dd>Returns the byte order of an atomic datatype. + <p> <dt><strong>Description:</strong> <dd><code>H5Tget_order</code> returns the byte order of an atomic datatype. @@ -15,24 +17,30 @@ Possible return values are: <ul><dl> <dt><code>H5T_ORDER_LE</code> (<code>0</code>) - <dd>Little endian byte ordering (default). + <dd>Little-endian byte order <dt><code>H5T_ORDER_BE</code> (<code>1</code>) - <dd>Big endian byte ordering. + <dd>Big-endian byte order <dt><code>H5T_ORDER_VAX</code> (<code>2</code>) - <dd>VAX mixed byte ordering (not currently supported). + <dd>VAX mixed byte order (not currently supported) + <dt><code>H5T_ORDER_NONE</code> (<code>3</code>) + <dd>No particular order + (fixed-length strings, object and region references) </dl></ul> + <p> <dt><strong>Parameters:</strong> <ul><table> <tr> - <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top"><em>hid_t</em> <code>dtype_id </code></td> <td valign="top">Identifier of datatype to query.</td></tr> </table></ul> + <p> <dt><strong>Returns:</strong> <dd>Returns a byte order constant if successful; otherwise <code>H5T_ORDER_ERROR</code> (-1). + <p> <dt><strong>Fortran90 Interface:</strong> h5tget_order_f <dd> - <pre> + <pre> SUBROUTINE h5tget_order_f(type_id, order, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier @@ -44,13 +52,6 @@ SUBROUTINE h5tget_order_f(type_id, order, hdferr) INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5tget_order_f - </pre> - - <!--<dt><strong>Non-C API(s):</strong> - <dd> - - <img src="Graphics/Java.gif"> - <img src="Graphics/C++.gif"> - --> + </pre> </dl> diff --git a/doc/html/H5T/H5Tset_order.htm b/doc/html/H5T/H5Tset_order.htm index b070517..d61f19b 100644 --- a/doc/html/H5T/H5Tset_order.htm +++ b/doc/html/H5T/H5Tset_order.htm @@ -4,37 +4,48 @@ <dl> <dt><strong>Name:</strong> <a name="Datatype-SetOrder">H5Tset_order</a> <dt><strong>Signature:</strong> - <dd><em>herr_t </em><code>H5Tset_order</code>(<em>hid_t </em><code>type_id</code>, - <em>H5T_order_t</em><code>order</code> + <dd><em>herr_t </em><code>H5Tset_order</code>(<em>hid_t </em><code>dtype_id</code>, + <em>H5T_order_t</em> <code>order</code> ) + <p> <dt><strong>Purpose:</strong> - <dd>Sets the byte ordering of an atomic datatype. + <dd>Sets the byte order of an atomic datatype. + <p> <dt><strong>Description:</strong> - <dd><code>H5Tset_order</code> sets the byte ordering of an atomic datatype. - Byte orderings currently supported are: - <ul> <dl> - <dt>H5T_ORDER_LE (<code>0</code>) - <dd> Little-endian byte ordering (default). - <dt>H5T_ORDER_BE (<code>1</code>) - <dd> Big-endian byte ordering. - <dt>H5T_ORDER_VAX (<code>2</code>) - <dd>VAX mixed byte ordering (not currently supported). - </dl> </ul> + <dd><code>H5Tset_order</code> sets the byte order of an atomic datatype. + <p> + Byte orders currently supported are: + <ul><dl> + <dt><code>H5T_ORDER_LE</code> (<code>0</code>) + <dd>Little-endian byte order + <dt><code>H5T_ORDER_BE</code> (<code>1</code>) + <dd>Big-endian byte order + <dt><code>H5T_ORDER_VAX</code> (<code>2</code>) + <dd>VAX mixed byte order (not currently supported) + </dl></ul> + <p> + <code>H5T_ORDER_NONE</code> (<code>3</code>) is also a valid value + for <code>order</code>, but it has no effect. + It is valid only for fixed-length strings and object and region references + and specifies “no particular order.” + <p> <dt><strong>Parameters:</strong> <ul><table> <tr> - <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top"><em>hid_t</em> <code>dtype_id</code></td> <td valign="top">Identifier of datatype to set.</td></tr> <tr> - <td valign="top"><em>H5T_order_t</em> <code>order </code></td> - <td valign="top">Byte ordering constant.</td></tr> + <td valign="top"><em>H5T_order_t</em> <code>order </code></td> + <td valign="top">Byte order constant.</td></tr> </table></ul> + <p> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <p> <dt><strong>Fortran90 Interface:</strong> h5tset_order_f <dd> - <pre> + <pre> SUBROUTINE h5tset_order_f(type_id, order, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier @@ -46,13 +57,6 @@ SUBROUTINE h5tset_order_f(type_id, order, hdferr) INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5tset_order_f - </pre> - - <!--<dt><strong>Non-C API(s):</strong> - <dd> - - <img src="Graphics/Java.gif"> - <img src="Graphics/C++.gif"> - --> + </pre> </dl> |