Gets information about a palette dataset (dimensions).

Procedure:

H5IM_GET_PALETTE_INFO(loc_id, image_name, pal_number, pal_dims)

Signature:

<pre><code class="language-c">herr_t H5IMget_palette_info( hid_t loc_id, const char *image_name, int pal_number, hsize_t *pal_dims )</code></pre>

<pre><code class="language-fortran">subroutine h5imget_palette_info_f(loc_id, dset_name, pal_number, dims, errcode)
  implicit none
  integer(HID_T), intent(IN) :: loc_id            ! file or group identifier 
  character(LEN=*), intent(IN) :: dset_name       ! name of the dataset 
  integer, intent(IN) :: pal_number               ! palette number
  integer(HSIZE_T), dimension(*), intent(INOUT) :: dims 
                                                  ! dimensions 
  integer :: errcode                              ! error code
end subroutine h5imget_palette_info_f</code></pre>

Parameters:
hid_t loc_idIN: Identifier of the file or group in which the image dataset is located.
const char *image_name    IN: The name of the image dataset.
int pal_numberIN: The zero based index that identifies the palette.
hsize_t *pal_dimsOUT: The dimensions of the palette dataset.

Description:

H5IMget_palette_info gets the dimensions of the palette dataset identified by pal_number (a zero based index) associated to an image specified by image_name.

Returns:

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

Example:

Coming Soon!