SCORPIO  1.7.0
Functions/Subroutines
PIO_inq_dimname

Inquire the name of a dimension. More...

Functions/Subroutines

integer function spio_inq_dim::pio_inq_dimname_file_dimid (file, dimid, dname)
 Inquire/get the name of a dimension in a file. More...
 
integer function spio_inq_dim::pio_inq_dimname_fh_dimid (fh, dimid, dname)
 Inquire/get the name of a dimension in a file. More...
 

Detailed Description

Inquire the name of a dimension.

This API can be used to inquire the name of a dimension using the dimension id

This API is a collective call (Although the library might internally choose to make progress on a single or small subset of MPI processes) on the I/O system associated with the file

Function/Subroutine Documentation

◆ pio_inq_dimname_fh_dimid()

integer function spio_inq_dim::pio_inq_dimname_fh_dimid ( integer, intent(in)  fh,
integer, intent(in)  dimid,
character(len=*), intent(out)  dname 
)

Inquire/get the name of a dimension in a file.

Parameters
[in]fhThe file id/handle
[in]dimidThe id of the dimension
[out]dnameThe name of the dimension
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_inq_dimname_file_dimid()

integer function spio_inq_dim::pio_inq_dimname_file_dimid ( type(file_desc_t), intent(in)  file,
integer, intent(in)  dimid,
character(len=*), intent(out)  dname 
)

Inquire/get the name of a dimension in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]dimidThe id of the dimension
[out]dnameThe name of the dimension
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)