From dc4212e15c46716ad05739e7d40d61b95b94c9a2 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 8 Oct 2003 16:48:44 -0500 Subject: [svn-r7577] Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Minor copy edits Platforms tested: IE 5, Safari --- doc/html/RM_H5T.html | 2817 ++++++++++++++++++++++++++------------------------ 1 file changed, 1440 insertions(+), 1377 deletions(-) diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 62e858b..4031bc3 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -25,6 +25,7 @@ HDF5/H5T API Specification +

@@ -60,8 +61,7 @@ And in this document, the -

- +

H5T: Datatype Interface

@@ -244,20 +244,20 @@ of a dataset. -

+
The FORTRAN90 Interfaces:
In general, each FORTRAN90 subroutine performs exactly the same task -as the corresponding C function. The links below go to the C function +as the corresponding C function. The links below (electronic versions only) go to the C function descriptions, which serve as general descriptions for both. A button, under Non-C API(s) at the end of the C function description, opens an external browser window displaying the FORTRAN90-specific information. You will probably want to adjust the size and location of this external window so that both browser windows are visible and to facilitate moving easily between them. - +

@@ -315,16 +315,16 @@ facilitate moving easily between them.
Array Datatypes -
H5Tarray_create_f -
H5Tget_array_ndims_f -
H5Tget_array_dims_f +
h5tarray_create_f +
h5tget_array_ndims_f +
h5tget_array_dims_f
       Compound Datatype Properties
h5tget_nmembers_f - +
h5tget_member_name_f
h5tget_member_offset_f @@ -383,34 +383,58 @@ A data point is an instance of a datatype, See The Datatype Interface (H5T) in the HDF5 User's Guide for further information, including a complete list of all supported datatypes. - + + +

-
Name: H5Topen +
Name: H5Tarray_create
Signature: -
hid_tH5Topen(hid_t loc_id, - const char * name +
hid_t H5Tarray_create( + hid_t base, + int rank, + const hsize_t dims[/*rank*/], + const int perm[/*rank*/] )
Purpose: -
Opens a named datatype. +
Creates an array datatype object.
Description: -
H5Topen opens a named datatype at the location - specified by loc_id and returns an identifier - for the datatype. loc_id is either a file or - group identifier. The identifier should eventually be closed - by calling H5Tclose to release resources. +
H5Tarray_create creates a new array datatype object. +
+ base is the datatype of every element of the array, + i.e., of the number at each position in the array. +
+ rank is the number of dimensions and the + size of each dimension is specified in the array dims. + The value of rank is currently limited to + H5S_MAX_RANK and must be greater than 0 + (zero). + All dimension sizes specified in dims must be greater + than 0 (zero). +
+ The array perm is designed to contain the dimension + permutation, i.e. C versus FORTRAN array order. + + (The parameter perm is currently unused and is not yet implemented.) +

Parameters:
-
hid_t loc_id -
IN: A file or group identifier. -
const char * name -
IN: A datatype name, defined within the file or group identified by loc_id. +
hid_t base +
IN: Datatype identifier for the array base datatype. +
int rank +
IN: Rank of the array. +
const hsize_t dims[/*rank*/] +
IN: Size of each array dimension. +
const int perm[/*rank*/] +
IN: Dimension permutation. + + (Currently not implemented.)

Returns: -
Returns a named datatype identifier if successful; +
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -

+ + +
+
+
Name: H5Tclose +
Signature: +
herr_t H5Tclose(hid_t type_id + ) +
Purpose: +
Releases a datatype. +
Description: +
H5Tclose releases a datatype. Further access + through the datatype identifier is illegal. Failure to release + a datatype with this call will result in resource leaks. +
Parameters: +
+
hid_t type_id +
Identifier of datatype to release. +
+
Returns: +
Returns a non-negative value if successful; + otherwise returns a negative value. +
Non-C API(s): +
+ +
+ +

Name: H5Tcommit @@ -456,7 +512,8 @@ in the HDF5 User's Guide for further information, including a compl -->
- + +

Name: H5Tcommitted @@ -491,48 +548,8 @@ in the HDF5 User's Guide for further information, including a compl -->
- -
-
-
Name: H5Tfind -
Signature: -
H5T_conv_t H5Tfind(hid_t src_id, - hid_t dst_id, - H5T_cdata_t **pcdata - ) -
Purpose: -
Finds a conversion function. -
Description: -
H5Tfind finds a conversion function that can - handle a conversion from type src_id to type - dst_id. - The pcdata argument is a pointer to a pointer - to type conversion data which was created and initialized - by the soft type conversion function of this path when the - conversion function was installed on the path. -
Parameters: -
-
hid_t src_id -
IN: Identifier for the source datatype. -
hid_t dst_id -
IN: Identifier for the destination datatype. -
H5T_cdata_t **pcdata -
OUT: Pointer to type conversion data. -
-
Returns: -
Returns a pointer to a suitable conversion function if successful. - Otherwise returns NULL. - -
- - + +

Name: H5Tconvert @@ -593,106 +610,127 @@ in the HDF5 User's Guide for further information, including a compl -->
- + +

-
Name: H5Tset_overflow +
Name: H5Tcopy
Signature: -
herr_t H5Tset_overflow(H5T_overflow_t func) +
hid_t H5Tcopy(hid_t type_id)
Purpose: -
Sets the overflow handler to a specified function. +
Copies an existing datatype.
Description: -
H5Tset_overflow sets the overflow handler - to be the function specified by func. - func will be called for all datatype conversions that - result in an overflow. +
H5Tcopy copies an existing datatype. + The returned type is always transient and unlocked.
- See the definition of H5T_overflow_t in - H5Tpublic.h for documentation - of arguments and return values. - The prototype for H5T_overflow_t is as follows:
- herr_t (*H5T_overflow_t)(hid_t src_id, hid_t dst_id, - void *src_buf, void *dst_buf); - + The type_id argument can be either a datatype + identifier, a predefined datatype (defined in + H5Tpublic.h), or a dataset identifier. + If type_id is a dataset identifier instead of a + datatype identifier, then this function returns a transient, + modifiable datatype which is a copy of the dataset's datatype.
- The NULL pointer may be passed to remove the overflow handler. + The datatype identifier returned should be released with + H5Tclose or resource leaks will occur. +
Parameters:
-
H5T_overflow_t func -
Overflow function. +
hid_t type_id +
Identifier of datatype to copy. Can be a datatype + identifier, a predefined datatype (defined in + H5Tpublic.h), or a dataset identifier.

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

-
Name: H5Tget_overflow +
Name: H5Tcreate
Signature: - - -H5Tget_overflow () -
H5T_overflow_t H5Tget_overflow(void) +
hid_t H5Tcreate(H5T_class_t class, + size_tsize + )
Purpose: -
Returns a pointer to the current global overflow function. +
Creates a new datatype.
Description: -
H5Tset_overflow returns a pointer - to the current global overflow function. - This is an application-defined function that is called whenever a - datatype conversion causes an overflow. -
Parameters: -
-
None. -
-
Returns: -
Returns a pointer to an application-defined function if successful. - Otherwise returns NULL; this can happen if no overflow handling - function is registered. - -
- - -
-
-
Name: H5Tcreate -
Signature: -
hid_t H5Tcreate(H5T_class_t class, - size_tsize - ) -
Purpose: -
Creates a new datatype. -
Description: -
H5Tcreate creates a new datatype of the specified - class with the specified number of bytes. -
- The following datatype classes are supported with this function: -
-
H5T_COMPOUND -
H5T_OPAQUE -
H5T_ENUM -
-
- Use H5Tcopy to create integer or floating-point datatypes. -
- The datatype identifier returned from this function should be - released with H5Tclose or resource leaks will result. +
H5Tcreate creates a new datatype of the specified + class with the specified number of bytes. +
+ The following datatype classes are supported with this function: +
+
H5T_COMPOUND +
H5T_OPAQUE +
H5T_ENUM +
+
+ Use H5Tcopy to create integer or floating-point datatypes. +
+ The datatype identifier returned from this function should be + released with H5Tclose or resource leaks will result.
Parameters:

H5T_class_t class @@ -712,201 +750,72 @@ H5Tget_overflow () -->
- + +

-
Name: H5Tvlen_create +
Name: H5Tdetect_class
Signature: -
hid_t H5Tvlen_create(hid_t base_type_id +
htri_t H5Tdetect_class(hid_t dtype_id, + H5T_class_tdtype_class )
Purpose: -
Creates a new variable-length datatype. +
Determines whether a datatype contains any datatypes of the + given datatype class.
Description: -
H5Tvlen_create creates a new variable-length (VL) datatype. -
- The base datatype will be the datatype that the sequence is composed of, - characters for character strings, vertex coordinates for polygon lists, etc. - The base type specified for the VL datatype can be of any HDF5 datatype, - including another VL datatype, a compound datatype or an atomic datatype. -
- When necessary, use H5Tget_super to determine the base type - of the VL datatype. +
H5Tdetect_class determines whether the datatype + specified in dtype_id contains any datatypes of the + datatype class specified in dtype_class.
- The datatype identifier returned from this function should be - released with H5Tclose or resource leaks will result. -
Parameters: -
-
hid_t base_type_id -
Base type of datatype to create. -
-
See Also: -
H5Dget_vlen_buf_size -
H5Dvlen_reclaim -
Returns: -
Returns datatype identifier if successful; - otherwise returns a negative value. -
Non-C API(s): -
- -
- - -
-
-
Name: H5Tis_variable_str -
Signature: -
htri_t H5Tis_variable_str(hid_t dtype_id - ) -
Purpose: -
Determines whether datatype is a variable-length string. -
Description: -
H5Tvlen_create determines whether the datatype - identified in dtype_id is a variable-length string. + This function is useful primarily in recursively examining + all the fields and/or base types + of compound, array, and variable-length datatypes.
- This function can be used to distinguish between - fixed and variable-length string datatypes. + Valid class identifiers are as defined in + H5Tget_class.
Parameters:

hid_t dtype_id
Datatype identifier. +
H5T_class_tdtype_class +
Datatype class.

Returns:
Returns TRUE or FALSE if successful; otherwise returns a negative value. -
Non-C API(s): -
- -
- - -
-
-
Name: H5Tcopy -
Signature: -
hid_t H5Tcopy(hid_t type_id) -
Purpose: -
Copies an existing datatype. -
Description: -
H5Tcopy copies an existing datatype. - The returned type is always transient and unlocked. -
- The type_id argument can be either a datatype - identifier, a predefined datatype (defined in - H5Tpublic.h), or a dataset identifier. - If type_id is a dataset identifier instead of a - datatype identifier, then this function returns a transient, - modifiable datatype which is a copy of the dataset's datatype. -
- The datatype identifier returned should be released with - H5Tclose or resource leaks will occur. - -
Parameters: -
-
hid_t type_id -
Identifier of datatype to copy. Can be a datatype - identifier, a predefined datatype (defined in - H5Tpublic.h), or a dataset identifier. -
-
Returns: -
Returns a datatype identifier if successful; - otherwise returns a negative value -
Non-C API(s): -
Non-C API(s): +
-
- + +

-
Name: H5Tequal +
Name: H5Tenum_create
Signature: -
htri_t H5Tequal(hid_t type_id1, - hid_ttype_id2 +
hid_t H5Tenum_create(hid_t parent_id )
Purpose: -
Determines whether two datatype identifiers refer to the same datatype. +
Creates a new enumeration datatype.
Description: -
H5Tequal determines whether two datatype identifiers - refer to the same datatype. +
H5Tenum_create creates a new enumeration datatype + based on the specified base datatype, parent_id, + which must be an integer type.
Parameters:
-
hid_t type_id1 -
Identifier of datatype to compare. -
hid_t type_id2 -
Identifier of datatype to compare. +
hid_t parent_id +
IN: Datatype identifier for the base datatype.

Returns: -
When successful, returns a positive value, for TRUE, - if the datatype identifiers refer to the same datatype, - or 0 (zero), for FALSE. - Otherwise returns a negative value. +
Returns the datatype identifier for the new enumeration datatype if successful; + otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tlock +
Name: H5Tenum_insert
Signature: -
herr_t H5Tlock(hid_t type_id +
herr_t H5Tenum_insert(hid_t type, + const char *name, + void *value )
Purpose: -
Locks a datatype. +
Inserts a new enumeration datatype member.
Description: -
H5Tlock locks the datatype specified by the - type_id identifier, making it read-only and - non-destructible. This is normally done by the library for - predefined datatypes so the application does not - inadvertently change or delete a predefined type. - Once a datatype is locked it can never be unlocked. +
H5Tenum_insert inserts a + new enumeration datatype member into an enumeration datatype. +
+ type is the enumeration datatype, + name is the name of the new member, and + value points to the value of the new member. +
+ name and value must both + be unique within type. +
+ value points to data which is of the + datatype defined when the enumeration datatype was created.
Parameters:
-
hid_t type_id -
Identifier of datatype to lock. +
hid_t type +
IN: Datatype identifier for the enumeration datatype. +
const char *name +
IN: Name of the new member. +
void *value +
IN: Pointer to the value of the new member.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value. - -
- - -
-
-
Name: H5Tget_class -
Signature: -
H5T_class_t H5Tget_class(hid_t type_id - ) -
Purpose: -
Returns the datatype class identifier. -
Description: -
H5Tget_class returns the datatype class identifier. -
- Valid class identifiers, as defined in H5Tpublic.h, are: -
H5T_INTEGER -
H5T_FLOAT -
H5T_TIME -
H5T_STRING -
H5T_BITFIELD -
H5T_OPAQUE -
H5T_COMPOUND -
H5T_REFERENCE -
H5T_ENUM -
H5T_VLEN -
H5T_ARRAY -
-
Parameters: -
-
hid_t type_id -
Identifier of datatype to query. -
-
Returns: -
Returns datatype class identifier if successful; - otherwise H5T_NO_CLASS (-1).
Non-C API(s): -

- + +

-
Name: H5Tdetect_class +
Name: H5Tenum_nameof
Signature: -
htri_t H5Tdetect_class(hid_t dtype_id, - H5T_class_tdtype_class +
herr_t H5Tenum_nameof(hid_t type + void *value, + char *name, + size_t size )
Purpose: -
Determines whether a datatype contains any datatypes of the - given datatype class. +
Returns the symbol name corresponding to a specified member of an enumeration datatype.
Description: -
H5Tdetect_class determines whether the datatype - specified in dtype_id contains any datatypes of the - datatype class specified in dtype_class. -
- This function is useful primarily in recursively examining - all the fields and/or base types - of compound, array, and variable-length datatypes. +
H5Tenum_nameof finds the symbol name that + corresponds to the specified value + of the enumeration datatype type.
- Valid class identifiers are as defined in - H5Tget_class. + At most size characters of the symbol + name are copied into the name buffer. + If the entire symbol name and null terminator + do not fit in the name buffer, then as + many characters as possible are copied + (not null terminated) and the function fails.
Parameters:
-
hid_t dtype_id -
Datatype identifier. -
H5T_class_tdtype_class -
Datatype class. +
hid_t type +
IN: Enumeration datatype identifier. +
void *value, +
IN: Value of the enumeration datatype. +
char *name, +
OUT: Buffer for output of the symbol name. +
size_t size +
IN: Anticipated size of the symbol name, in bytes (characters).

Returns: -
Returns TRUE or FALSE if successful; - otherwise returns a negative value. -
- + +

-
Name: H5Tget_size +
Name: H5Tenum_valueof
Signature: -
size_t H5Tget_size(hid_t type_id +
herr_t H5Tenum_valueof(hid_t type + char *name, + void *value )
Purpose: -
Returns the size of a datatype. +
Returns the value corresponding to a specified member of an enumeration datatype.
Description: -
H5Tget_size returns the size of a datatype in bytes. +
H5Tenum_valueof finds the value that + corresponds to the specified name + of the enumeration datatype type. +
+ The value argument should be at least + as large as the value of H5Tget_size(type) + in order to hold the result.
Parameters:
-
hid_t type_id -
Identifier of datatype to query. +
hid_t type +
IN: Enumeration datatype identifier. +
const char *name, +
IN: Symbol name of the enumeration datatype. +
void *value, +
OUT: Buffer for output of the value of the enumeration datatype.

Returns: -
Returns the size of the datatype in bytes if successful; - otherwise 0. +
Returns a non-negative value if successful; + otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tset_size +
Name: H5Tequal
Signature: -
herr_t H5Tset_size(hid_t type_id, - size_tsize +
htri_t H5Tequal(hid_t type_id1, + hid_ttype_id2 )
Purpose: -
Sets the total size for an atomic datatype. +
Determines whether two datatype identifiers refer to the same datatype.
Description: -
H5Tset_size sets the total size in bytes, - size, for a datatype. If the datatype is atomic and size - is decreased so that the significant bits of the datatype extend beyond - the edge of the new size, then the `offset' property is decreased - toward zero. If the `offset' becomes zero and the significant - bits of the datatype still hang over the edge of the new size, then - the number of significant bits is decreased. - The size set for a string should include space for the null-terminator - character, otherwise it will not be stored on (or retrieved from) disk. - Adjusting the size of an string automatically sets the precision - to 8*size. A compound datatype may increase in size, but may not - shrink. All datatypes must have a positive size. +
H5Tequal determines whether two datatype identifiers + refer to the same datatype.
Parameters:
-
hid_t type_id -
Identifier of datatype to change size. -
size_t size -
Size in bytes to modify datatype. +
hid_t type_id1 +
Identifier of datatype to compare. +
hid_t type_id2 +
Identifier of datatype to compare.

Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. +
When successful, returns a positive value, for TRUE, + if the datatype identifiers refer to the same datatype, + or 0 (zero), for FALSE. + Otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tget_super +
Name: H5Tfind
Signature: -
hid_t H5Tget_super(hid_t type +
H5T_conv_t H5Tfind(hid_t src_id, + hid_t dst_id, + H5T_cdata_t **pcdata )
Purpose: -
Returns the base datatype from which a datatype is derived. +
Finds a conversion function.
Description: -
H5Tget_super returns the base datatype from which the - datatype type is derived. -
- In the case of an enumeration type, the return value is an integer type. +
H5Tfind finds a conversion function that can + handle a conversion from type src_id to type + dst_id. + The pcdata argument is a pointer to a pointer + to type conversion data which was created and initialized + by the soft type conversion function of this path when the + conversion function was installed on the path.
Parameters:
-
hid_t type -
Datatype identifier for the derived datatype. +
hid_t src_id +
IN: Identifier for the source datatype. +
hid_t dst_id +
IN: Identifier for the destination datatype. +
H5T_cdata_t **pcdata +
OUT: Pointer to type conversion data.

Returns: -
Returns the datatype identifier for the base datatype if successful; - otherwise returns a negative value. +
Returns a pointer to a suitable conversion function if successful. + Otherwise returns NULL. +
- + +

-
Name: H5Tget_native_type +
Name: H5Tget_array_dims
Signature: -
hid_t H5Tget_native_type(hid_t type_id, - H5T_direction_t direction +
int H5Tget_array_dims( + hid_t adtype_id, + hsize_t *dims[], + int *perm[] )
Purpose: -
Returns the native datatype of a specified datatype. +
Retrieves sizes of array dimensions and dimension permutations.
Description: -
H5Tget_native_type returns the equivalent native datatype - for the datatype specified in type_id. -
- H5Tget_native_type is a high-level function designed - primarily to facilitate use of the H5Dread function, - for which users otherwise must undertake a multi-step process to - determine the native datatype of a dataset prior to reading it - into memory. - It can be used not only to determine - the native datatype for atomic datatypes, - but also to determine the native datatypes of the individual components of - a compound datatype, an enumerated datatype, an array datatype, or - a variable-length datatype. -
- H5Tget_native_type selects the matching native datatype - from the following list: -
H5T_NATIVE_CHAR - H5T_NATIVE_SHORT - H5T_NATIVE_INT - H5T_NATIVE_LONG - H5T_NATIVE_LLONG - - H5T_NATIVE_UCHAR - H5T_NATIVE_USHORT - H5T_NATIVE_UINT - H5T_NATIVE_ULONG - H5T_NATIVE_ULLONG - - H5T_NATIVE_FLOAT - H5T_NATIVE_DOUBLE - H5T_NATIVE_LDOUBLE
-
- The direction parameter indicates the order - in which the library searches for a native datatype match. - Valid values for direction are as follows: - - - -
     - H5T_DIR_ASCEND - Searches the above list in ascending size of the datatype,
- i.e., from top to bottom. (Default) -
- H5T_DIR_DESCEND   - Searches the above list in descending size of the datatype,
- i.e., from bottom to top. -
-
- H5Tget_native_type is designed primarily for - use with intenger and floating point datatypes. - Time, bifield, opaque, and reference datatypes are returned - as a copy of type_id. +
H5Tget_array_dims returns the sizes of the dimensions + and the dimension permutations of the specified array datatype object.
- The identifier returned by H5Tget_native_type - should eventually be closed by calling H5Tclose - to release resources. + The sizes of the dimensions are returned in the array dims. + The dimension permutations, i.e., C versus FORTRAN array order, + are returned in the array perm.
Parameters:
-
hid_t type_id -
Datatype identifier for the dataset datatype. -
H5T_direction_t direction -
Direction of search. +
hid_t adtype_id +
IN: Datatype identifier of array object. +
hsize_t *dims[] +
OUT: Sizes of array dimensions. +
int *perm[] +
OUT: Dimension permutations.

Returns: -
Returns the native datatype identifier for the - specified dataset datatype if successful; +
Returns the non-negative number of dimensions of the array type if successful; otherwise returns a negative value. -
- + +

-
Name: H5Tget_order +
Name: H5Tget_array_ndims
Signature: -
H5T_order_t H5Tget_order(hid_t type_id +
int H5Tget_array_ndims( + hid_t adtype_id )
Purpose: -
Returns the byte order of an atomic datatype. +
Returns the rank of an array datatype.
Description: -
H5Tget_order returns the byte order of an - atomic datatype. -
- Possible return values are: -
-
H5T_ORDER_LE (0) -
Little endian byte ordering (default). -
H5T_ORDER_BE (1) -
Big endian byte ordering. -
H5T_ORDER_VAX (2) -
VAX mixed byte ordering (not currently supported). -
+
H5Tget_array_ndims returns the rank, + the number of dimensions, of an array datatype object.
Parameters:
-
hid_t type_id -
Identifier of datatype to query. +
hid_t adtype_id +
IN: Datatype identifier of array object.

Returns: -
Returns a byte order constant if successful; - otherwise H5T_ORDER_ERROR (-1). +
Returns the rank of the array if successful; + otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tset_order +
Name: H5Tget_class
Signature: -
herr_t H5Tset_order(hid_t type_id, - H5T_order_torder +
H5T_class_t H5Tget_class(hid_t type_id )
Purpose: -
Sets the byte ordering of an atomic datatype. +
Returns the datatype class identifier.
Description: -
H5Tset_order sets the byte ordering of an atomic datatype. - Byte orderings currently supported are: -

-
H5T_ORDER_LE (0) -
Little-endian byte ordering (default). -
H5T_ORDER_BE (1) -
Big-endian byte ordering. -
H5T_ORDER_VAX (2) -
VAX mixed byte ordering (not currently supported). -

+
H5Tget_class returns the datatype class identifier. +
+ Valid class identifiers, as defined in H5Tpublic.h, are: +
H5T_INTEGER +
H5T_FLOAT +
H5T_TIME +
H5T_STRING +
H5T_BITFIELD +
H5T_OPAQUE +
H5T_COMPOUND +
H5T_REFERENCE +
H5T_ENUM +
H5T_VLEN +
H5T_ARRAY +

Parameters:

hid_t type_id -
Identifier of datatype to set. -
H5T_order_t order -
Byte ordering constant. +
Identifier of datatype to query.

Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. +
Returns datatype class identifier if successful; + otherwise H5T_NO_CLASS (-1).
Non-C API(s): -

- + +

-
Name: H5Tget_precision +
Name: H5Tget_cset
Signature: -
size_t H5Tget_precision(hid_t type_id +
H5T_cset_t H5Tget_cset(hid_t type_id )
Purpose: -
Returns the precision of an atomic datatype. +
Retrieves the character set type of a string datatype.
Description: -
H5Tget_precision returns the precision of an atomic datatype. The - precision is the number of significant bits which, unless padding is - present, is 8 times larger than the value returned by H5Tget_size(). +
H5Tget_cset retrieves the character set type + of a string datatype. Valid character set types are: +

+
H5T_CSET_ASCII (0) +
Character set is US ASCII +

Parameters:

hid_t type_id
Identifier of datatype to query.

Returns: -
Returns the number of significant bits if successful; - otherwise 0. +
Returns a valid character set type if successful; + otherwise H5T_CSET_ERROR (-1).
Non-C API(s): -

- + +

-
Name: H5Tset_precision +
Name: H5Tget_ebias
Signature: -
herr_t H5Tset_precision(hid_t type_id, - size_tprecision +
size_t H5Tget_ebias(hid_t type_id )
Purpose: -
Sets the precision of an atomic datatype. +
Retrieves the exponent bias of a floating-point type.
Description: -
H5Tset_precision sets the precision of an atomic datatype. - The precision is the number of significant bits which, unless padding - is present, is 8 times larger than the value returned by H5Tget_size(). -
If the precision is increased then the offset is decreased and then - the size is increased to insure that significant bits do not "hang - over" the edge of the datatype. -
Changing the precision of an H5T_STRING automatically changes the - size as well. The precision must be a multiple of 8. -
When decreasing the precision of a floating point type, set the - locations and sizes of the sign, mantissa, and exponent fields - first. +
H5Tget_ebias retrieves the exponent bias of a floating-point type.
Parameters:

hid_t type_id -
Identifier of datatype to set. -
size_t precision -
Number of bits of precision for datatype. +
Identifier of datatype to query.

Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. +
Returns the bias if successful; + otherwise 0.
Non-C API(s): -

- + +

-
Name: H5Tget_offset +
Name: H5Tget_fields
Signature: -
int H5Tget_offset(hid_t type_id +
herr_t H5Tget_fields(hid_t type_id, + size_t *spos, + size_t *epos, + size_t *esize, + size_t *mpos, + size_t *msize )
Purpose: -
Retrieves the bit offset of the first significant bit. +
Retrieves floating point datatype bit field information.
Description: -
H5Tget_offset retrieves the bit offset of the first significant bit. - The significant bits of an atomic datum can be offset from the beginning - of the memory for that datum by an amount of padding. The `offset' - property specifies the number of bits of padding that appear to the - "right of" the value. That is, if we have a 32-bit datum with 16-bits - of precision having the value 0x1122 then it will be laid out in - memory as (from small byte address toward larger byte addresses): -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Byte Position Big-Endian Offset=0 Big-Endian Offset=16 Little-Endian Offset=0 Little-Endian Offset=16
0: [ pad] [0x11] [0x22] [ pad]
1: [ pad] [0x22] [0x11] [ pad]
2: [0x11] [ pad] [ pad] [0x22]
3: [0x22] [ pad] [ pad] [0x11]
+
H5Tget_fields retrieves information about the locations of the various + bit fields of a floating point datatype. The field positions are bit + positions in the significant region of the datatype. Bits are + numbered with the least significant bit number zero. + Any (or even all) of the arguments can be null pointers.
Parameters:

hid_t type_id -
Identifier of datatype to query. +
IN: Identifier of datatype to query. +
size_t *spos +
OUT: Pointer to location to return floating-point sign bit. +
size_t *epos +
OUT: Pointer to location to return exponent bit-position. +
size_t *esize +
OUT: Pointer to location to return size of exponent in bits. +
size_t *mpos +
OUT: Pointer to location to return mantissa bit-position. +
size_t *msize +
OUT: Pointer to location to return size of mantissa in bits.

Returns: -
Returns an offset value if successful; +
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tset_offset +
Name: H5Tget_inpad
Signature: -
herr_t H5Tset_offset(hid_t type_id, - size_t offset +
H5T_pad_t H5Tget_inpad(hid_t type_id )
Purpose: -
Sets the bit offset of the first significant bit. +
Retrieves the internal padding type for unused bits in floating-point datatypes.
Description: -
H5Tset_offset sets the bit offset of the first significant bit. The - significant bits of an atomic datum can be offset from the beginning of - the memory for that datum by an amount of padding. The `offset' - property specifies the number of bits of padding that appear to the - "right of" the value. That is, if we have a 32-bit datum with 16-bits - of precision having the value 0x1122 then it will be laid out in - memory as (from small byte address toward larger byte addresses): -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Byte Position Big-Endian Offset=0 Big-Endian Offset=16 Little-Endian Offset=0 Little-Endian Offset=16
0: [ pad] [0x11] [0x22] [ pad]
1: [ pad] [0x22] [0x11] [ pad]
2: [0x11] [ pad] [ pad] [0x22]
3: [0x22] [ pad] [ pad] [0x11]
- -
If the offset is incremented then the total size is -incremented also if necessary to prevent significant bits of -the value from hanging over the edge of the datatype. - -
The offset of an H5T_STRING cannot be set to anything but -zero. +
H5Tget_inpad retrieves the internal padding type for + unused bits in floating-point datatypes. + Valid padding types are: +

+
H5T_PAD_ZERO (0) +
Set background to zeros. +
H5T_PAD_ONE (1) +
Set background to ones. +
H5T_PAD_BACKGROUND (2) +
Leave background alone. +

Parameters:

hid_t type_id -
Identifier of datatype to set. -
size_t offset -
Offset of first significant bit. +
Identifier of datatype to query.

Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. +
Returns a valid padding type if successful; + otherwise H5T_PAD_ERROR (-1).
Non-C API(s): -

- + +

-
Name: H5Tget_pad +
Name: H5Tget_member_class
Signature: -
herr_t H5Tget_pad(hid_t type_id, - H5T_pad_t * lsb, - H5T_pad_t * msb +
H5T_class_t H5Tget_member_class( + hid_t cdtype_id, + int member_no )
Purpose: -
Retrieves the padding type of the least and most-significant bit padding. +
Returns datatype class of compound datatype member.
Description: -
H5Tget_pad retrieves the padding type of the least and most-significant - bit padding. Valid types are: -

-
H5T_PAD_ZERO (0) -
Set background to zeros. -
H5T_PAD_ONE (1) -
Set background to ones. -
H5T_PAD_BACKGROUND (2) -
Leave background alone. -

+
Given a compound datatype, cdtype_id, the function + H5Tget_member_class returns the datatype class of + the compound datatype member specified by member_no.
Parameters:
-
hid_t type_id -
IN: Identifier of datatype to query. -
H5T_pad_t * lsb -
OUT: Pointer to location to return least-significant - bit padding type. -
H5T_pad_t * msb -
OUT: Pointer to location to return most-significant - bit padding type. +
hid_t cdtype_id +
IN: Datatype identifier of compound object. +
int member_no +
IN: Compound object member number.

Returns: -
Returns a non-negative value if successful; +
Returns the datatype class, a non-negative value, if successful; otherwise returns a negative value. +
- + +

-
Name: H5Tset_pad +
Name: H5Tget_member_index
Signature: -
herr_t H5Tset_pad(hid_t type_id, - H5T_pad_t lsb, - H5T_pad_t msb +
int H5Tget_member_index(hid_t type_id, + const char * field_name )
Purpose: -
Sets the least and most-significant bits padding types. +
Retrieves the index of a compound or enumeration datatype member.
Description: -
H5Tset_pad sets the least and most-significant bits padding types. -

-
H5T_PAD_ZERO (0) -
Set background to zeros. -
H5T_PAD_ONE (1) -
Set background to ones. -
H5T_PAD_BACKGROUND (2) -
Leave background alone. -

+
H5Tget_member_index retrieves the index of a field + of a compound datatype or an element of an enumeration datatype. +
+ The name of the target field or element is specified in + field_name. +
+ Fields are stored in no particular order + with index values of 0 through N-1, where N is + the value returned by H5Tget_nmembers.
Parameters:

hid_t type_id -
Identifier of datatype to set. -
H5T_pad_t lsb -
Padding type for least-significant bits. -
H5T_pad_t msb -
Padding type for most-significant bits. +
Identifier of datatype to query. +
const char * field_name +
Name of the field or member whose index is to be retrieved.

Returns: -
Returns a non-negative value if successful; +
Returns a valid field or member index if successful; otherwise returns a negative value. +
- + +

-
Name: H5Tget_sign +
Name: H5Tget_member_name
Signature: -
H5T_sign_t H5Tget_sign(hid_t type_id +
char * H5Tget_member_name(hid_t type_id, + int field_idx )
Purpose: -
Retrieves the sign type for an integer type. +
Retrieves the name of a compound or enumeration datatype member.
Description: -
H5Tget_sign retrieves the sign type for an integer type. - Valid types are: -

-
H5T_SGN_NONE (0) -
Unsigned integer type. -
H5T_SGN_2 (1) -
Two's complement signed integer type. -

+
H5Tget_member_name retrieves the name of a field + of a compound datatype or an element of an enumeration datatype. +
+ The index of the target field or element is specified in + field_idx. + Compound datatype fields and enumeration datatype elements + are stored in no particular order + with index values of 0 through N-1, where N + is the value returned by H5Tget_nmembers. +
+ A buffer to receive the name of the field is + allocated with malloc() and the caller is responsible + for freeing the memory used.
Parameters:

hid_t type_id
Identifier of datatype to query. +
int field_idx +
Zero-based index of the field or element whose name + is to be retrieved.

Returns: -
Returns a valid sign type if successful; - otherwise H5T_SGN_ERROR (-1). +
Returns a valid pointer to a string allocated with + malloc() if successful; + otherwise returns NULL.
Non-C API(s): -

- + +

-
Name: H5Tset_sign +
Name: H5Tget_member_offset
Signature: -
herr_t H5Tset_sign(hid_t type_id, - H5T_sign_t sign +
size_t H5Tget_member_offset(hid_t type_id, + int memb_no )
Purpose: -
Sets the sign property for an integer type. +
Retrieves the offset of a field of a compound datatype.
Description: -
H5Tset_sign sets the sign property for an integer type. -

-
H5T_SGN_NONE (0) -
Unsigned integer type. -
H5T_SGN_2 (1) -
Two's complement signed integer type. -

+
H5Tget_member_offset retrieves the + byte offset of the beginning of a field within a + compound datatype with respect to the beginning + of the compound data type datum.
Parameters:

hid_t type_id -
Identifier of datatype to set. -
H5T_sign_t sign -
Sign type. +
Identifier of datatype to query. +
int memb_no +
Number of the field whose offset is requested.

Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. +
Returns the byte offset of the field if successful; + otherwise returns 0 (zero). + Note that zero is a valid offset and that this function + will fail only if a call to H5Tget_member_class() + fails with the same arguments.
Non-C API(s): -

- + +

-
Name: H5Tget_fields +
Name: H5Tget_member_type
Signature: -
herr_t H5Tget_fields(hid_t type_id, - size_t *spos, - size_t *epos, - size_t *esize, - size_t *mpos, - size_t *msize +
hid_t H5Tget_member_type(hid_t type_id, + int field_idx )
Purpose: -
Retrieves floating point datatype bit field information. +
Returns the datatype of the specified member.
Description: -
H5Tget_fields retrieves information about the locations of the various - bit fields of a floating point datatype. The field positions are bit - positions in the significant region of the datatype. Bits are - numbered with the least significant bit number zero. - Any (or even all) of the arguments can be null pointers. +
H5Tget_member_type returns the datatype of the specified member. The caller + should invoke H5Tclose() to release resources associated with the type.
Parameters:

hid_t type_id -
IN: Identifier of datatype to query. -
size_t *spos -
OUT: Pointer to location to return floating-point sign bit. -
size_t *epos -
OUT: Pointer to location to return exponent bit-position. -
size_t *esize -
OUT: Pointer to location to return size of exponent in bits. -
size_t *mpos -
OUT: Pointer to location to return mantissa bit-position. -
size_t *msize -
OUT: Pointer to location to return size of mantissa in bits. +
Identifier of datatype to query. +
int field_idx +
Field index (0-based) of the field type to retrieve.

Returns: -
Returns a non-negative value if successful; +
Returns the identifier of a copy of the datatype of the field + if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tset_fields +
Name: H5Tget_member_value
Signature: -
herr_t H5Tset_fields(hid_t type_id, - size_t spos, - size_t epos, - size_t esize, - size_t mpos, - size_t msize +
hid_t H5Tget_member_value(hid_t type + int memb_no, + void *value )
Purpose: -
Sets locations and sizes of floating point bit fields. +
Returns the value of an enumeration datatype member.
Description: -
H5Tset_fields sets the locations and sizes of the various - floating-point bit fields. The field positions are bit positions in the - significant region of the datatype. Bits are numbered with the least - significant bit number zero. - -
Fields are not allowed to extend beyond the number of bits of - precision, nor are they allowed to overlap with one another. +
H5Tget_member_value returns the value of + the enumeration datatype member memb_no. +
+ The member value is returned in a user-supplied buffer + pointed to by value.
Parameters:
-
hid_t type_id -
Identifier of datatype to set. -
size_t spos -
Sign position, i.e., the bit offset of the floating-point - sign bit. -
size_t epos -
Exponent bit position. -
size_t esize -
Size of exponent in bits. -
size_t mpos -
Mantissa bit position. -
size_t msize -
Size of mantissa in bits. +
hid_t type +
IN: Datatype identifier for the enumeration datatype. +
int memb_no, +
IN: Number of the enumeration datatype member. +
void *value +
OUT: Pointer to a buffer for output of the + value of the enumeration datatype member.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -

+ + +
+
+
Name: H5Tget_native_type +
Signature: +
hid_t H5Tget_native_type(hid_t type_id, + H5T_direction_t direction + ) +
Purpose: +
Returns the native datatype of a specified datatype. +
Description: +
H5Tget_native_type returns the equivalent native datatype + for the datatype specified in type_id. +
+ H5Tget_native_type is a high-level function designed + primarily to facilitate use of the H5Dread function, + for which users otherwise must undertake a multi-step process to + determine the native datatype of a dataset prior to reading it + into memory. + It can be used not only to determine + the native datatype for atomic datatypes, + but also to determine the native datatypes of the individual components of + a compound datatype, an enumerated datatype, an array datatype, or + a variable-length datatype. +
+ H5Tget_native_type selects the matching native datatype + from the following list: +
H5T_NATIVE_CHAR + H5T_NATIVE_SHORT + H5T_NATIVE_INT + H5T_NATIVE_LONG + H5T_NATIVE_LLONG + + H5T_NATIVE_UCHAR + H5T_NATIVE_USHORT + H5T_NATIVE_UINT + H5T_NATIVE_ULONG + H5T_NATIVE_ULLONG -
-
-
Name: H5Tget_ebias -
Signature: -
size_t H5Tget_ebias(hid_t type_id - ) -
Purpose: -
Retrieves the exponent bias of a floating-point type. -
Description: -
H5Tget_ebias retrieves the exponent bias of a floating-point type. + H5T_NATIVE_FLOAT + H5T_NATIVE_DOUBLE + H5T_NATIVE_LDOUBLE
+
+ The direction parameter indicates the order + in which the library searches for a native datatype match. + Valid values for direction are as follows: + + + +
     + H5T_DIR_ASCEND + Searches the above list in ascending size of the datatype,
+ i.e., from top to bottom. (Default) +
+ H5T_DIR_DESCEND   + Searches the above list in descending size of the datatype,
+ i.e., from bottom to top. +
+
+ H5Tget_native_type is designed primarily for + use with intenger and floating point datatypes. + Time, bifield, opaque, and reference datatypes are returned + as a copy of type_id. +
+ The identifier returned by H5Tget_native_type + should eventually be closed by calling H5Tclose + to release resources.
Parameters:

hid_t type_id -
Identifier of datatype to query. +
Datatype identifier for the dataset datatype. +
H5T_direction_t direction +
Direction of search.

Returns: -
Returns the bias if successful; - otherwise 0. +
Returns the native datatype identifier for the + specified dataset datatype if successful; + otherwise returns a negative value. +
- + +

-
Name: H5Tset_ebias +
Name: H5Tget_nmembers
Signature: -
herr_t H5Tset_ebias(hid_t type_id, - size_t ebias +
int H5Tget_nmembers(hid_t type_id )
Purpose: -
Sets the exponent bias of a floating-point type. +
Retrieves the number of elements in a compound or enumeration datatype.
Description: -
H5Tset_ebias sets the exponent bias of a floating-point type. +
H5Tget_nmembers retrieves + the number of fields in a compound datatype or + the number of members of an enumeration datatype.
Parameters:

hid_t type_id -
Identifier of datatype to set. -
size_t ebias -
Exponent bias value. +
Identifier of datatype to query.

Returns: -
Returns a non-negative value if successful; +
Returns the number of elements if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

Name: H5Tget_norm @@ -1880,39 +1697,74 @@ zero. -->
- + +

-
Name: H5Tset_norm +
Name: H5Tget_offset
Signature: -
herr_t H5Tset_norm(hid_t type_id, - H5T_norm_t norm +
int H5Tget_offset(hid_t type_id )
Purpose: -
Sets the mantissa normalization of a floating-point datatype. +
Retrieves the bit offset of the first significant bit.
Description: -
H5Tset_norm sets the mantissa normalization of - a floating-point datatype. Valid normalization types are: -

-
H5T_NORM_IMPLIED (0) -
MSB of mantissa is not stored, always 1 -
H5T_NORM_MSBSET (1) -
MSB of mantissa is always 1 -
H5T_NORM_NONE (2) -
Mantissa is not normalized -

+
H5Tget_offset retrieves the bit offset of the first significant bit. + The significant bits of an atomic datum can be offset from the beginning + of the memory for that datum by an amount of padding. The `offset' + property specifies the number of bits of padding that appear to the + "right of" the value. That is, if we have a 32-bit datum with 16-bits + of precision having the value 0x1122 then it will be laid out in + memory as (from small byte address toward larger byte addresses): +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Byte Position Big-Endian Offset=0 Big-Endian Offset=16 Little-Endian Offset=0 Little-Endian Offset=16
0: [ pad] [0x11] [0x22] [ pad]
1: [ pad] [0x22] [0x11] [ pad]
2: [0x11] [ pad] [ pad] [0x22]
3: [0x22] [ pad] [ pad] [0x11]

Parameters:

hid_t type_id -
Identifier of datatype to set. -
H5T_norm_t norm -
Mantissa normalization type. +
Identifier of datatype to query.

Returns: -
Returns a non-negative value if successful; +
Returns an offset value if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tget_inpad +
Name: H5Tget_order
Signature: -
H5T_pad_t H5Tget_inpad(hid_t type_id +
H5T_order_t H5Tget_order(hid_t type_id )
Purpose: -
Retrieves the internal padding type for unused bits in floating-point datatypes. +
Returns the byte order of an atomic datatype.
Description: -
H5Tget_inpad retrieves the internal padding type for - unused bits in floating-point datatypes. - Valid padding types are: -

-
H5T_PAD_ZERO (0) -
Set background to zeros. -
H5T_PAD_ONE (1) -
Set background to ones. -
H5T_PAD_BACKGROUND (2) -
Leave background alone. -

+
H5Tget_order returns the byte order of an + atomic datatype. +
+ Possible return values are: +
+
H5T_ORDER_LE (0) +
Little endian byte ordering (default). +
H5T_ORDER_BE (1) +
Big endian byte ordering. +
H5T_ORDER_VAX (2) +
VAX mixed byte ordering (not currently supported). +

Parameters:

hid_t type_id
Identifier of datatype to query.

Returns: -
Returns a valid padding type if successful; - otherwise H5T_PAD_ERROR (-1). +
Returns a byte order constant if successful; + otherwise H5T_ORDER_ERROR (-1).
Non-C API(s): -

- + +

-
Name: H5Tset_inpad +
Name: H5Tget_overflow
Signature: -
herr_t H5Tset_inpad(hid_t type_id, - H5T_pad_t inpad - ) + + +H5Tget_overflow () +
H5T_overflow_t H5Tget_overflow(void)
Purpose: -
Fills unused internal floating point bits. +
Returns a pointer to the current global overflow function.
Description: -
If any internal bits of a floating point type are unused - (that is, those significant bits which are not part of the - sign, exponent, or mantissa), then H5Tset_inpad will be filled - according to the value of the padding value property inpad. - Valid padding types are: -

-
H5T_PAD_ZERO (0) -
Set background to zeros. -
H5T_PAD_ONE (1) -
Set background to ones. -
H5T_PAD_BACKGROUND (2) -
Leave background alone. -

+
H5Tset_overflow returns a pointer + to the current global overflow function. + This is an application-defined function that is called whenever a + datatype conversion causes an overflow.
Parameters:
-
hid_t type_id -
Identifier of datatype to modify. -
H5T_pad_t pad -
Padding type. +
None.

Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. +
Returns a pointer to an application-defined function if successful. + Otherwise returns NULL; this can happen if no overflow handling + function is registered. +
- + +

-
Name: H5Tget_cset +
Name: H5Tget_pad
Signature: -
H5T_cset_t H5Tget_cset(hid_t type_id +
herr_t H5Tget_pad(hid_t type_id, + H5T_pad_t * lsb, + H5T_pad_t * msb )
Purpose: -
Retrieves the character set type of a string datatype. +
Retrieves the padding type of the least and most-significant bit padding.
Description: -
H5Tget_cset retrieves the character set type - of a string datatype. Valid character set types are: +
H5Tget_pad retrieves the padding type of the least and most-significant + bit padding. Valid types are:

-
H5T_CSET_ASCII (0) -
Character set is US ASCII +
H5T_PAD_ZERO (0) +
Set background to zeros. +
H5T_PAD_ONE (1) +
Set background to ones. +
H5T_PAD_BACKGROUND (2) +
Leave background alone.

Parameters:

hid_t type_id -
Identifier of datatype to query. +
IN: Identifier of datatype to query. +
H5T_pad_t * lsb +
OUT: Pointer to location to return least-significant + bit padding type. +
H5T_pad_t * msb +
OUT: Pointer to location to return most-significant + bit padding type.

Returns: -
Returns a valid character set type if successful; - otherwise H5T_CSET_ERROR (-1). +
Returns a non-negative value if successful; + otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tset_cset +
Name: H5Tget_precision
Signature: -
herr_t H5Tset_cset(hid_t type_id, - H5T_cset_t cset +
size_t H5Tget_precision(hid_t type_id )
Purpose: -
Sets character set to be used. +
Returns the precision of an atomic datatype.
Description: -
H5Tset_cset the character set to be used. -
- HDF5 is able to distinguish between character sets of different - nationalities and to convert between them to the extent possible. - Valid character set types are: -

-
H5T_CSET_ASCII (0) -
Character set is US ASCII. -

+
H5Tget_precision returns the precision of an atomic datatype. The + precision is the number of significant bits which, unless padding is + present, is 8 times larger than the value returned by H5Tget_size().
Parameters:

hid_t type_id -
Identifier of datatype to modify. -
H5T_cset_t cset -
Character set type. +
Identifier of datatype to query.

Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. +
Returns the number of significant bits if successful; + otherwise 0.
Non-C API(s): -

- + +

-
Name: H5Tget_strpad +
Name: H5Tget_sign
Signature: -
H5T_str_t H5Tget_strpad(hid_t type_id +
H5T_sign_t H5Tget_sign(hid_t type_id )
Purpose: -
Retrieves the storage mechanism for a string datatype. +
Retrieves the sign type for an integer type.
Description: -
H5Tget_strpad retrieves the storage mechanism - for a string datatype, as defined in - H5Tset_strpad. +
H5Tget_sign retrieves the sign type for an integer type. + Valid types are: +

+
H5T_SGN_NONE (0) +
Unsigned integer type. +
H5T_SGN_2 (1) +
Two's complement signed integer type. +

Parameters:

hid_t type_id
Identifier of datatype to query.

Returns: -
Returns a valid string storage mechanism if successful; - otherwise H5T_STR_ERROR (-1). +
Returns a valid sign type if successful; + otherwise H5T_SGN_ERROR (-1).
Non-C API(s): -

- + +

-
Name: H5Tset_strpad +
Name: H5Tget_size
Signature: -
herr_t H5Tset_strpad(hid_t type_id, - H5T_str_t strpad +
size_t H5Tget_size(hid_t type_id )
Purpose: -
Defines the storage mechanism for character strings. +
Returns the size of a datatype.
Description: -
H5Tset_strpad defines the storage mechanism for the string. -
- The method used to store character strings differs with the - programming language: -
-
C usually null terminates strings while -
Fortran left-justifies and space-pads strings. -
- Valid string padding values, as passed in the parameter - strpad, are as follows: -

-
H5T_STR_NULLTERM (0) -
Null terminate (as C does) -
H5T_STR_NULLPAD (1) -
Pad with zeros -
H5T_STR_SPACEPAD (2) -
Pad with spaces (as FORTRAN does) -

-
- When converting from a longer string to a shorter string, - the behavior is as follows. - If the short string is H5T_STR_NULLPAD or - H5T_STR_SPACEPAD, then the string is simply truncated. - If the short string is H5T_STR_NULLTERM, it is - truncated and a null terminator is appended. -
- When converting from a shorter string to a longer string, - the long string is padded on the end by appending nulls or spaces. - - +
H5Tget_size returns the size of a datatype in bytes.
Parameters:

hid_t type_id -
Identifier of datatype to modify. -
H5T_str_t strpad -
String padding type. +
Identifier of datatype to query.

Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. +
Returns the size of the datatype in bytes if successful; + otherwise 0.
Non-C API(s): -

- + +

-
Name: H5Tget_nmembers +
Name: H5Tget_strpad
Signature: -
int H5Tget_nmembers(hid_t type_id +
H5T_str_t H5Tget_strpad(hid_t type_id )
Purpose: -
Retrieves the number of elements in a compound or enumeration datatype. +
Retrieves the storage mechanism for a string datatype.
Description: -
H5Tget_nmembers retrieves - the number of fields in a compound datatype or - the number of members of an enumeration datatype. +
H5Tget_strpad retrieves the storage mechanism + for a string datatype, as defined in + H5Tset_strpad.
Parameters:

hid_t type_id
Identifier of datatype to query.

Returns: -
Returns the number of elements if successful; - otherwise returns a negative value. +
Returns a valid string storage mechanism if successful; + otherwise H5T_STR_ERROR (-1).
Non-C API(s): -

- + +

-
Name: H5Tget_member_class +
Name: H5Tget_super
Signature: -
H5T_class_t H5Tget_member_class( - hid_t cdtype_id, - int member_no +
hid_t H5Tget_super(hid_t type )
Purpose: -
Returns datatype class of compound datatype member. +
Returns the base datatype from which a datatype is derived.
Description: -
Given a compound datatype, cdtype_id, the function - H5Tget_member_class returns the datatype class of - the compound datatype member specified by member_no. +
H5Tget_super returns the base datatype from which the + datatype type is derived. +
+ In the case of an enumeration type, the return value is an integer type.
Parameters:
-
hid_t cdtype_id -
IN: Datatype identifier of compound object. -
int member_no -
IN: Compound object member number. +
hid_t type +
Datatype identifier for the derived datatype.

Returns: -
Returns the datatype class, a non-negative value, if successful; +
Returns the datatype identifier for the base datatype if successful; otherwise returns a negative value. -
- + +

-
Name: H5Tget_member_name +
Name: H5Tget_tag
Signature: -
char * H5Tget_member_name(hid_t type_id, - int field_idx +
char *H5Tget_tag(hid_t type_id )
Purpose: -
Retrieves the name of a compound or enumeration datatype member. +
Gets the tag associated with an opaque datatype.
Description: -
H5Tget_member_name retrieves the name of a field - of a compound datatype or an element of an enumeration datatype. -
- The index of the target field or element is specified in - field_idx. - Compound datatype fields and enumeration datatype elements - are stored in no particular order - with index values of 0 through N-1, where N - is the value returned by H5Tget_nmembers. -
- A buffer to receive the name of the field is - allocated with malloc() and the caller is responsible - for freeing the memory used. +
H5Tget_tag returns the tag associated with + the opaque datatype type_id. +
+ The tag is returned via a pointer to an + allocated string, which the caller must free.
Parameters:

hid_t type_id -
Identifier of datatype to query. -
int field_idx -
Zero-based index of the field or element whose name - is to be retrieved. +
Datatype identifier for the opaque datatype.

Returns: -
Returns a valid pointer to a string allocated with - malloc() if successful; - otherwise returns NULL. +
Returns a pointer to an allocated string if successful; + otherwise returns NULL.
Non-C API(s): -

- + +

-
Name: H5Tget_member_index +
Name: H5Tinsert
Signature: -
int H5Tget_member_index(hid_t type_id, - const char * field_name +
herr_t H5Tinsert(hid_t type_id, + const char * name, + size_t offset, + hid_t field_id )
Purpose: -
Retrieves the index of a compound or enumeration datatype member. +
Adds a new member to a compound datatype.
Description: -
H5Tget_member_index retrieves the index of a field - of a compound datatype or an element of an enumeration datatype. -
- The name of the target field or element is specified in - field_name. -
- Fields are stored in no particular order - with index values of 0 through N-1, where N is - the value returned by H5Tget_nmembers. +
H5Tinsert adds another member to the compound datatype + type_id. The new member has a name which + must be unique within the compound datatype. + The offset argument defines the start of the member + in an instance of the compound datatype, and field_id + is the datatype identifier of the new member. +
+ Note: Members of a compound datatype do not have to be atomic datatypes; + a compound datatype can have a member which is a compound datatype.
Parameters:

hid_t type_id -
Identifier of datatype to query. -
const char * field_name -
Name of the field or member whose index is to be retrieved. +
Identifier of compound datatype to modify. +
const char * name +
Name of the field to insert. +
size_t offset +
Offset in memory structure of the field to insert. +
hid_t field_id +
Datatype identifier of the field to insert.

Returns: -
Returns a valid field or member index if successful; +
Returns a non-negative value if successful; otherwise returns a negative value. -
- + +

-
Name: H5Tget_member_offset +
Name: H5Tis_variable_str
Signature: -
size_t H5Tget_member_offset(hid_t type_id, - int memb_no +
htri_t H5Tis_variable_str(hid_t dtype_id ) -
Purpose: -
Retrieves the offset of a field of a compound datatype. -
Description: -
H5Tget_member_offset retrieves the - byte offset of the beginning of a field within a - compound datatype with respect to the beginning - of the compound data type datum. +
Purpose: +
Determines whether datatype is a variable-length string. +
Description: +
H5Tvlen_create determines whether the datatype + identified in dtype_id is a variable-length string. +
+ This function can be used to distinguish between + fixed and variable-length string datatypes.
Parameters:
-
hid_t type_id -
Identifier of datatype to query. -
int memb_no -
Number of the field whose offset is requested. +
hid_t dtype_id +
Datatype identifier.

Returns: -
Returns the byte offset of the field if successful; - otherwise returns 0 (zero). - Note that zero is a valid offset and that this function - will fail only if a call to H5Tget_member_class() - fails with the same arguments. +
Returns TRUE or FALSE if successful; + otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tget_member_type +
Name: H5Tlock
Signature: -
hid_t H5Tget_member_type(hid_t type_id, - int field_idx +
herr_t H5Tlock(hid_t type_id )
Purpose: -
Returns the datatype of the specified member. +
Locks a datatype.
Description: -
H5Tget_member_type returns the datatype of the specified member. The caller - should invoke H5Tclose() to release resources associated with the type. +
H5Tlock locks the datatype specified by the + type_id identifier, making it read-only and + non-destructible. This is normally done by the library for + predefined datatypes so the application does not + inadvertently change or delete a predefined type. + Once a datatype is locked it can never be unlocked.
Parameters:

hid_t type_id -
Identifier of datatype to query. -
int field_idx -
Field index (0-based) of the field type to retrieve. +
Identifier of datatype to lock.

Returns: -
Returns the identifier of a copy of the datatype of the field - if successful; +
Returns a non-negative value if successful; otherwise returns a negative value. +
- + +

-
Name: H5Tinsert +
Name: H5Topen
Signature: -
herr_t H5Tinsert(hid_t type_id, - const char * name, - size_t offset, - hid_t field_id +
hid_tH5Topen(hid_t loc_id, + const char * name )
Purpose: -
Adds a new member to a compound datatype. +
Opens a named datatype.
Description: -
H5Tinsert adds another member to the compound datatype - type_id. The new member has a name which - must be unique within the compound datatype. - The offset argument defines the start of the member - in an instance of the compound datatype, and field_id - is the datatype identifier of the new member. -
- Note: Members of a compound datatype do not have to be atomic datatypes; - a compound datatype can have a member which is a compound datatype. +
H5Topen opens a named datatype at the location + specified by loc_id and returns an identifier + for the datatype. loc_id is either a file or + group identifier. The identifier should eventually be closed + by calling H5Tclose to release resources.
Parameters:
-
hid_t type_id -
Identifier of compound datatype to modify. +
hid_t loc_id +
IN: A file or group identifier.
const char * name -
Name of the field to insert. -
size_t offset -
Offset in memory structure of the field to insert. -
hid_t field_id -
Datatype identifier of the field to insert. +
IN: A datatype name, defined within the file or group identified by loc_id.

Returns: -
Returns a non-negative value if successful; +
Returns a named datatype identifier if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

Name: H5Tpack @@ -2459,7 +2265,8 @@ zero. -->
- + +

Name: H5Tregister @@ -2556,61 +2363,292 @@ zero. -->
+ + +
+
+
Name: H5Tset_cset +
Signature: +
herr_t H5Tset_cset(hid_t type_id, + H5T_cset_t cset + ) +
Purpose: +
Sets character set to be used. +
Description: +
H5Tset_cset the character set to be used. +
+ HDF5 is able to distinguish between character sets of different + nationalities and to convert between them to the extent possible. + Valid character set types are: +

+
H5T_CSET_ASCII (0) +
Character set is US ASCII. +

+
Parameters: +
+
hid_t type_id +
Identifier of datatype to modify. +
H5T_cset_t cset +
Character set type. +
+
Returns: +
Returns a non-negative value if successful; + otherwise returns a negative value. +
Non-C API(s): +
+ +
+ + + +
+
+
Name: H5Tset_ebias +
Signature: +
herr_t H5Tset_ebias(hid_t type_id, + size_t ebias + ) +
Purpose: +
Sets the exponent bias of a floating-point type. +
Description: +
H5Tset_ebias sets the exponent bias of a floating-point type. +
Parameters: +
+
hid_t type_id +
Identifier of datatype to set. +
size_t ebias +
Exponent bias value. +
+
Returns: +
Returns a non-negative value if successful; + otherwise returns a negative value. +
Non-C API(s): +
+ +
+ +

-
Name: H5Tunregister +
Name: H5Tset_fields
Signature: -
herr_t H5Tunregister(H5T_conv_t func +
herr_t H5Tset_fields(hid_t type_id, + size_t spos, + size_t epos, + size_t esize, + size_t mpos, + size_t msize )
Purpose: -
Removes a conversion function from all conversion paths. +
Sets locations and sizes of floating point bit fields. +
Description: +
H5Tset_fields sets the locations and sizes of the various + floating-point bit fields. The field positions are bit positions in the + significant region of the datatype. Bits are numbered with the least + significant bit number zero. + +
Fields are not allowed to extend beyond the number of bits of + precision, nor are they allowed to overlap with one another. +
Parameters: +
+
hid_t type_id +
Identifier of datatype to set. +
size_t spos +
Sign position, i.e., the bit offset of the floating-point + sign bit. +
size_t epos +
Exponent bit position. +
size_t esize +
Size of exponent in bits. +
size_t mpos +
Mantissa bit position. +
size_t msize +
Size of mantissa in bits. +
+
Returns: +
Returns a non-negative value if successful; + otherwise returns a negative value. +
Non-C API(s): +
+ +
+ + + +
+
+
Name: H5Tset_inpad +
Signature: +
herr_t H5Tset_inpad(hid_t type_id, + H5T_pad_t inpad + ) +
Purpose: +
Fills unused internal floating point bits. +
Description: +
If any internal bits of a floating point type are unused + (that is, those significant bits which are not part of the + sign, exponent, or mantissa), then H5Tset_inpad will be filled + according to the value of the padding value property inpad. + Valid padding types are: +

+
H5T_PAD_ZERO (0) +
Set background to zeros. +
H5T_PAD_ONE (1) +
Set background to ones. +
H5T_PAD_BACKGROUND (2) +
Leave background alone. +

+
Parameters: +
+
hid_t type_id +
Identifier of datatype to modify. +
H5T_pad_t pad +
Padding type. +
+
Returns: +
Returns a non-negative value if successful; + otherwise returns a negative value. +
Non-C API(s): +
+ +
+ + + +
+
+
Name: H5Tset_norm +
Signature: +
herr_t H5Tset_norm(hid_t type_id, + H5T_norm_t norm + ) +
Purpose: +
Sets the mantissa normalization of a floating-point datatype.
Description: -
H5Tunregister removes a conversion function from all conversion paths. -
- The conversion function pointer type declaration is described in - H5Tregister. +
H5Tset_norm sets the mantissa normalization of + a floating-point datatype. Valid normalization types are: +

+
H5T_NORM_IMPLIED (0) +
MSB of mantissa is not stored, always 1 +
H5T_NORM_MSBSET (1) +
MSB of mantissa is always 1 +
H5T_NORM_NONE (2) +
Mantissa is not normalized +

Parameters:
-
H5T_conv_t func -
Function to remove from conversion paths. +
hid_t type_id +
Identifier of datatype to set. +
H5T_norm_t norm +
Mantissa normalization type.

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

-
Name: H5Tenum_create +
Name: H5Tset_offset
Signature: -
hid_t H5Tenum_create(hid_t parent_id +
herr_t H5Tset_offset(hid_t type_id, + size_t offset )
Purpose: -
Creates a new enumeration datatype. +
Sets the bit offset of the first significant bit.
Description: -
H5Tenum_create creates a new enumeration datatype - based on the specified base datatype, parent_id, - which must be an integer type. +
H5Tset_offset sets the bit offset of the first significant bit. The + significant bits of an atomic datum can be offset from the beginning of + the memory for that datum by an amount of padding. The `offset' + property specifies the number of bits of padding that appear to the + "right of" the value. That is, if we have a 32-bit datum with 16-bits + of precision having the value 0x1122 then it will be laid out in + memory as (from small byte address toward larger byte addresses): +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Byte Position Big-Endian Offset=0 Big-Endian Offset=16 Little-Endian Offset=0 Little-Endian Offset=16
0: [ pad] [0x11] [0x22] [ pad]
1: [ pad] [0x22] [0x11] [ pad]
2: [0x11] [ pad] [ pad] [0x22]
3: [0x22] [ pad] [ pad] [0x11]
+ +
If the offset is incremented then the total size is +incremented also if necessary to prevent significant bits of +the value from hanging over the edge of the datatype. + +
The offset of an H5T_STRING cannot be set to anything but +zero.
Parameters:
-
hid_t parent_id -
IN: Datatype identifier for the base datatype. +
hid_t type_id +
Identifier of datatype to set. +
size_t offset +
Offset of first significant bit.

Returns: -
Returns the datatype identifier for the new enumeration datatype if successful; +
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tenum_insert +
Name: H5Tset_order
Signature: -
herr_t H5Tenum_insert(hid_t type, - const char *name, - void *value +
herr_t H5Tset_order(hid_t type_id, + H5T_order_torder )
Purpose: -
Inserts a new enumeration datatype member. +
Sets the byte ordering of an atomic datatype.
Description: -
H5Tenum_insert inserts a - new enumeration datatype member into an enumeration datatype. -
- type is the enumeration datatype, - name is the name of the new member, and - value points to the value of the new member. -
- name and value must both - be unique within type. -
- value points to data which is of the - datatype defined when the enumeration datatype was created. +
H5Tset_order sets the byte ordering of an atomic datatype. + Byte orderings currently supported are: +

+
H5T_ORDER_LE (0) +
Little-endian byte ordering (default). +
H5T_ORDER_BE (1) +
Big-endian byte ordering. +
H5T_ORDER_VAX (2) +
VAX mixed byte ordering (not currently supported). +

Parameters:
-
hid_t type -
IN: Datatype identifier for the enumeration datatype. -
const char *name -
IN: Name of the new member. -
void *value -
IN: Pointer to the value of the new member. +
hid_t type_id +
Identifier of datatype to set. +
H5T_order_t order +
Byte ordering constant.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tenum_nameof +
Name: H5Tset_overflow
Signature: -
herr_t H5Tenum_nameof(hid_t type - void *value, - char *name, - size_t size - ) +
herr_t H5Tset_overflow(H5T_overflow_t func)
Purpose: -
Returns the symbol name corresponding to a specified member of an enumeration datatype. +
Sets the overflow handler to a specified function.
Description: -
H5Tenum_nameof finds the symbol name that - corresponds to the specified value - of the enumeration datatype type. +
H5Tset_overflow sets the overflow handler + to be the function specified by func. + func will be called for all datatype conversions that + result in an overflow.
- At most size characters of the symbol - name are copied into the name buffer. - If the entire symbol name and null terminator - do not fit in the name buffer, then as - many characters as possible are copied - (not null terminated) and the function fails. + See the definition of H5T_overflow_t in + H5Tpublic.h for documentation + of arguments and return values. + The prototype for H5T_overflow_t is as follows:
+ herr_t (*H5T_overflow_t)(hid_t src_id, hid_t dst_id, + void *src_buf, void *dst_buf); + +
+ The NULL pointer may be passed to remove the overflow handler.
Parameters:
-
hid_t type -
IN: Enumeration datatype identifier. -
void *value, -
IN: Value of the enumeration datatype. -
char *name, -
OUT: Buffer for output of the symbol name. -
size_t size -
IN: Anticipated size of the symbol name, in bytes (characters). +
H5T_overflow_t func +
Overflow function.

Returns: -
Returns a non-negative value if successful. - Otherwise returns a negative value - and, if size allows it, - the first character of name is - set to NULL. +
Returns a non-negative value if successful; + otherwise returns a negative value. +
- + +

-
Name: H5Tenum_valueof +
Name: H5Tset_pad
Signature: -
herr_t H5Tenum_valueof(hid_t type - char *name, - void *value +
herr_t H5Tset_pad(hid_t type_id, + H5T_pad_t lsb, + H5T_pad_t msb )
Purpose: -
Returns the value corresponding to a specified member of an enumeration datatype. +
Sets the least and most-significant bits padding types.
Description: -
H5Tenum_valueof finds the value that - corresponds to the specified name - of the enumeration datatype type. -
- The value argument should be at least - as large as the value of H5Tget_size(type) - in order to hold the result. +
H5Tset_pad sets the least and most-significant bits padding types. +

+
H5T_PAD_ZERO (0) +
Set background to zeros. +
H5T_PAD_ONE (1) +
Set background to ones. +
H5T_PAD_BACKGROUND (2) +
Leave background alone. +

Parameters:
-
hid_t type -
IN: Enumeration datatype identifier. -
const char *name, -
IN: Symbol name of the enumeration datatype. -
void *value, -
OUT: Buffer for output of the value of the enumeration datatype. +
hid_t type_id +
Identifier of datatype to set. +
H5T_pad_t lsb +
Padding type for least-significant bits. +
H5T_pad_t msb +
Padding type for most-significant bits.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tget_member_value +
Name: H5Tset_precision
Signature: -
hid_t H5Tget_member_value(hid_t type - int memb_no, - void *value +
herr_t H5Tset_precision(hid_t type_id, + size_tprecision )
Purpose: -
Returns the value of an enumeration datatype member. +
Sets the precision of an atomic datatype.
Description: -
H5Tget_member_value returns the value of - the enumeration datatype member memb_no. -
- The member value is returned in a user-supplied buffer - pointed to by value. +
H5Tset_precision sets the precision of an atomic datatype. + The precision is the number of significant bits which, unless padding + is present, is 8 times larger than the value returned by H5Tget_size(). +
If the precision is increased then the offset is decreased and then + the size is increased to insure that significant bits do not "hang + over" the edge of the datatype. +
Changing the precision of an H5T_STRING automatically changes the + size as well. The precision must be a multiple of 8. +
When decreasing the precision of a floating point type, set the + locations and sizes of the sign, mantissa, and exponent fields + first.
Parameters:
-
hid_t type -
IN: Datatype identifier for the enumeration datatype. -
int memb_no, -
IN: Number of the enumeration datatype member. -
void *value -
OUT: Pointer to a buffer for output of the - value of the enumeration datatype member. +
hid_t type_id +
Identifier of datatype to set. +
size_t precision +
Number of bits of precision for datatype.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tset_tag +
Name: H5Tset_sign
Signature: -
herr_t H5Tset_tag(hid_t type_id - const char *tag +
herr_t H5Tset_sign(hid_t type_id, + H5T_sign_t sign )
Purpose: -
Tags an opaque datatype. +
Sets the sign property for an integer type.
Description: -
H5Tset_tag tags an opaque datatype type_id - with a descriptive ASCII identifier, tag. +
H5Tset_sign sets the sign property for an integer type. +

+
H5T_SGN_NONE (0) +
Unsigned integer type. +
H5T_SGN_2 (1) +
Two's complement signed integer type. +

Parameters:

hid_t type_id -
IN: Datatype identifier for the opaque datatype to be tagged. -
const char *tag -
IN: Descriptive ASCII string with which the - opaque datatype is to be tagged. +
Identifier of datatype to set. +
H5T_sign_t sign +
Sign type.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tget_tag +
Name: H5Tset_size
Signature: -
char *H5Tget_tag(hid_t type_id +
herr_t H5Tset_size(hid_t type_id, + size_tsize )
Purpose: -
Gets the tag associated with an opaque datatype. +
Sets the total size for an atomic datatype.
Description: -
H5Tget_tag returns the tag associated with - the opaque datatype type_id. -
- The tag is returned via a pointer to an - allocated string, which the caller must free. +
H5Tset_size sets the total size in bytes, + size, for a datatype. If the datatype is atomic and size + is decreased so that the significant bits of the datatype extend beyond + the edge of the new size, then the `offset' property is decreased + toward zero. If the `offset' becomes zero and the significant + bits of the datatype still hang over the edge of the new size, then + the number of significant bits is decreased. + The size set for a string should include space for the null-terminator + character, otherwise it will not be stored on (or retrieved from) disk. + Adjusting the size of a string automatically sets the precision + to 8*size. A compound datatype may increase in size, + but may not shrink. All datatypes must have a positive size.
Parameters:

hid_t type_id -
Datatype identifier for the opaque datatype. +
Identifier of datatype to change size. +
size_t size +
Size in bytes to modify datatype.

Returns: -
Returns a pointer to an allocated string if successful; - otherwise returns NULL. +
Returns a non-negative value if successful; + otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tarray_create +
Name: H5Tset_strpad
Signature: -
hid_t H5Tarray_create( - hid_t base, - int rank, - const hsize_t dims[/*rank*/], - const int perm[/*rank*/] +
herr_t H5Tset_strpad(hid_t type_id, + H5T_str_t strpad )
Purpose: -
Creates an array datatype object. +
Defines the storage mechanism for character strings.
Description: -
H5Tarray_create creates a new array datatype object. -
- base is the datatype of every element of the array, - i.e., of the number at each position in the array. -
- rank is the number of dimensions and the - size of each dimension is specified in the array dims. - The value of rank is currently limited to - H5S_MAX_RANK and must be greater than 0 - (zero). - All dimension sizes specified in dims must be greater - than 0 (zero). -
- The array perm is designed to contain the dimension - permutation, i.e. C versus FORTRAN array order. - - (The parameter perm is currently unused and is not yet implemented.) -
+
H5Tset_strpad defines the storage mechanism for the string. +
+ The method used to store character strings differs with the + programming language: +
+
C usually null terminates strings while +
Fortran left-justifies and space-pads strings. +
+ Valid string padding values, as passed in the parameter + strpad, are as follows: +

+
H5T_STR_NULLTERM (0) +
Null terminate (as C does) +
H5T_STR_NULLPAD (1) +
Pad with zeros +
H5T_STR_SPACEPAD (2) +
Pad with spaces (as FORTRAN does) +

+
+ When converting from a longer string to a shorter string, + the behavior is as follows. + If the short string is H5T_STR_NULLPAD or + H5T_STR_SPACEPAD, then the string is simply truncated. + If the short string is H5T_STR_NULLTERM, it is + truncated and a null terminator is appended. +
+ When converting from a shorter string to a longer string, + the long string is padded on the end by appending nulls or spaces. + +
Parameters:
-
hid_t base -
IN: Datatype identifier for the array base datatype. -
int rank -
IN: Rank of the array. -
const hsize_t dims[/*rank*/] -
IN: Size of each array dimension. -
const int perm[/*rank*/] -
IN: Dimension permutation. - - (Currently not implemented.) +
hid_t type_id +
Identifier of datatype to modify. +
H5T_str_t strpad +
String padding type.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tget_array_ndims +
Name: H5Tset_tag
Signature: -
int H5Tget_array_ndims( - hid_t adtype_id +
herr_t H5Tset_tag(hid_t type_id + const char *tag )
Purpose: -
Returns the rank of an array datatype. +
Tags an opaque datatype.
Description: -
H5Tget_array_ndims returns the rank, - the number of dimensions, of an array datatype object. +
H5Tset_tag tags an opaque datatype type_id + with a descriptive ASCII identifier, tag.
Parameters:
-
hid_t adtype_id -
IN: Datatype identifier of array object. +
hid_t type_id +
IN: Datatype identifier for the opaque datatype to be tagged. +
const char *tag +
IN: Descriptive ASCII string with which the + opaque datatype is to be tagged.

Returns: -
Returns the rank of the array if successful; +
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -

- + +

-
Name: H5Tget_array_dims +
Name: H5Tunregister
Signature: -
int H5Tget_array_dims( - hid_t adtype_id, - hsize_t *dims[], - int *perm[] +
herr_t H5Tunregister(H5T_conv_t func )
Purpose: -
Retrieves sizes of array dimensions and dimension permutations. +
Removes a conversion function from all conversion paths.
Description: -
H5Tget_array_dims returns the sizes of the dimensions - and the dimension permutations of the specified array datatype object. -
- The sizes of the dimensions are returned in the array dims. - The dimension permutations, i.e., C versus FORTRAN array order, - are returned in the array perm. +
H5Tunregister removes a conversion function from all conversion paths. +
+ The conversion function pointer type declaration is described in + H5Tregister.
Parameters:
-
hid_t adtype_id -
IN: Datatype identifier of array object. -
hsize_t *dims[] -
OUT: Sizes of array dimensions. -
int *perm[] -
OUT: Dimension permutations. +
H5T_conv_t func +
Function to remove from conversion paths.

Returns: -
Returns the non-negative number of dimensions of the array type if successful; +
Returns a non-negative value if successful; otherwise returns a negative value. +
- + +

-
Name: H5Tclose +
Name: H5Tvlen_create
Signature: -
herr_t H5Tclose(hid_t type_id +
hid_t H5Tvlen_create(hid_t base_type_id )
Purpose: -
Releases a datatype. +
Creates a new variable-length datatype.
Description: -
H5Tclose releases a datatype. Further access - through the datatype identifier is illegal. Failure to release - a datatype with this call will result in resource leaks. +
H5Tvlen_create creates a new variable-length (VL) datatype. +
+ The base datatype will be the datatype that the sequence is composed of, + characters for character strings, vertex coordinates for polygon lists, etc. + The base type specified for the VL datatype can be of any HDF5 datatype, + including another VL datatype, a compound datatype or an atomic datatype. +
+ When necessary, use H5Tget_super to determine the base type + of the VL datatype. +
+ The datatype identifier returned from this function should be + released with H5Tclose or resource leaks will result.
Parameters:
-
hid_t type_id -
Identifier of datatype to release. +
hid_t base_type_id +
Base type of datatype to create.
+
See Also: +
H5Dget_vlen_buf_size +
H5Dvlen_reclaim
Returns: -
Returns a non-negative value if successful; +
Returns datatype identifier if successful; otherwise returns a negative value.
Non-C API(s): -

-
@@ -3047,14 +3109,15 @@ And in this document, the

-
-
+
HDF Help Desk
Describes HDF5 Release 1.6.0, July 2003 -
- -Last modified: 3 July 2003 +
-- cgit v0.12