Retrieves name of scale did into buffer name.
Procedure:
H5DS_GET_SCALE_NAME(did, name, size)
Signature:
ssize_t H5DSget_scale_name(hid_t did, char *name, size_t size)
SUBROUTINE H5DSget_scale_name_f(did, name, size, errcode)
IMPLICIT NONE
INTEGER(hid_t), INTENT(in) :: did ! The dataget
CHARACTER(LEN=*), INTENT(out) :: name ! The name
INTEGER(size_t) , INTENT(inout) :: size ! The length of the name buffer
INTEGER :: errcode ! Error code
END SUBROUTINE H5DSget_scale_name_f
Parameters:
| int did; | IN: dimension scale identifier |
| char *name; | OUT: buffer to contain the returned name |
| size_t size; | IN: size in bytes, of the name buffer |
Description:
H5DSget_scale_name retrieves the name attribute for scale did.
Up to size characters of the scale name are returned in name; additional characters, if any, are not returned to the user application.
If the length of the name, which determines the required value of size, is unknown, a preliminary H5DSget_scale_name call can be made by setting name to NULL. The return value of this call will be the size of the scale name; that value plus one (1) can then be assigned to size for a second H5DSget_scale_name call, which will retrieve the actual name. (The value passed in with the parameter size must be one greater than size in bytes of the actual name in order to accommodate the null terminator; if size is set to the exact size of the name, the last byte passed back will contain the null terminator and the last character will be missing from the name passed back to the calling application.)
Returns:
Upon success, the length of the scale name or zero if no name found.
Negative if fail.
Example:
--- Last Modified: December 04, 2017 | 07:25 AM
