SCORPIO  1.8.2
Functions/Subroutines
PIO_inq_varname

Inquire variable name. More...

Functions/Subroutines

integer function spio_inq_var::pio_inq_varname_file_vid (file, varid, vname)
 Inquire/get the name of a variable in a file. More...
 
integer function spio_inq_var::pio_inq_varname_fh_vid (fh, varid, vname)
 Inquire/get the name of a variable in a file. More...
 
integer function spio_inq_var::pio_inq_varname_file_vdesc (file, vdesc, vname)
 Inquire/get the name of a variable in a file. More...
 

Detailed Description

Inquire variable name.

This API can be used to inquire the name of a variable in a file.

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

integer function spio_inq_var::pio_inq_varname_fh_vid ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(out)  vname 
)

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

Parameters
[in]fhThe file id/handle
[in]varidThe id of the variable
[out]vnameThe name of the variable
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_varname_file_vdesc()

integer function spio_inq_var::pio_inq_varname_file_vdesc ( type(file_desc_t), intent(in)  file,
type(var_desc_t), intent(in)  vdesc,
character(len=*), intent(out)  vname 
)

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

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe descriptor of the variable. Variable description structure.
[out]vnameThe name of the variable
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_varname_file_vid()

integer function spio_inq_var::pio_inq_varname_file_vid ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), intent(out)  vname 
)

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

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