SCORPIO  1.8.0
Functions/Subroutines
PIO_inq_dimid

Inquire the id of a dimension. More...

Functions/Subroutines

integer function spio_inq_dim::pio_inq_dimid_file_dimid (file, dname, dimid)
 Inquire/get the unique id associated with a dimension in a file. More...
 
integer function spio_inq_dim::pio_inq_dimid_fh_dimid (fh, dname, dimid)
 Inquire/get the unique id associated with a dimension in a file. More...
 

Detailed Description

Inquire the id of a dimension.

This API can be used to inquire the unique id associated with a dimension using the dimension name.

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_dimid_fh_dimid()

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

Inquire/get the unique id associated with a dimension in a file.

Parameters
[in]fhThe file id/handle
[in]dnameThe name of the dimension
[out]dimidThe id 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_dimid_file_dimid()

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

Inquire/get the unique id associated with a dimension in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]dnameThe name of the dimension
[out]dimidThe id 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)