Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5DS_GET_LABEL

Read the label for dimension idx of did into buffer label.

Procedure:
H5DS_GET_LABEL(did, idx, lable, size)

Signature:

ssize_t H5DSget_label(hid_t did, unsigned int idx, char *label, size_t size)

SUBROUTINE H5DSget_label_f(did, idx, label, size, errcode)
    IMPLICIT NONE
    INTEGER(hid_t),   INTENT(in) :: did     ! The dataget
    INTEGER       ,   INTENT(in) :: idx     ! The dimension
    CHARACTER(LEN=*), INTENT(in) :: label   ! The label
    INTEGER(size_t) , INTENT(inout) :: size ! The length of the label buffer
    INTEGER :: errcode                      ! Error code
END SUBROUTINE H5DSget_label_f

Parameters:
hid_t did;IN: the dataset
unsigned int idx;    IN: the dimension
char *label;OUT: the label
size_t size;IN: the length of the label buffer.

Description:

Returns the value of the DIMENSION_LABEL_LIST for dimension idx of dataset did, if set. Up to size characters of the name are copied into the buffer label. If the label is longer than size, it will be truncated to fit. The parameter size is set to the size of the returned label.

If did has no label, the return value of label is NULL.

Fails if:

  • Bad arguments

Returns:

Upon success, size of label or zero if no label found.

Negative if fail.

Example:

Coming Soon!

--- Last Modified: December 04, 2017 | 07:26 AM