SCORPIO  1.7.0
Functions/Subroutines
PIO_inq_attname

Inquire attribute name. More...

Functions/Subroutines

integer function spio_inq_att::pio_inq_attname_file_vid (file, varid, attid, attname)
 Inquire/get the name of an attribute in a file. More...
 
integer function spio_inq_att::pio_inq_attname_fh_vid (fh, varid, attid, attname)
 Inquire/get the name of a attribute in a file. More...
 
integer function spio_inq_att::pio_inq_attname_file_vdesc (file, vdesc, attid, attname)
 Inquire/get the name of an attribute in a file. More...
 

Detailed Description

Inquire attribute name.

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

The attributes can be associated with a variable or not (a global attribute). Attributes associated with a variable needs to be queried using the variable id and global attributes can be queried using PIO_GLOBAL as the variable id (indicating that the attribute is a global attribute that is not associated with a single variable)

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

integer function spio_inq_att::pio_inq_attname_fh_vid ( integer, intent(in)  fh,
integer, intent(in)  varid,
integer, intent(in)  attid,
character(len=*), intent(out)  attname 
)

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

Parameters
[in]fhThe file id/handle
[in]varidThe id of the variable associated with the attribute. Use PIO_GLOBAL for global attributes
[in]attidThe id of the attribute
[out]attnameThe name of the attribute
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_attname_file_vdesc()

integer function spio_inq_att::pio_inq_attname_file_vdesc ( type(file_desc_t), intent(in)  file,
type(var_desc_t), intent(in)  vdesc,
integer, intent(in)  attid,
character(len=*), intent(out)  attname 
)

Inquire/get the name of an attribute 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.
[in]attidThe id of the attribute
[out]attnameThe name of the attribute
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_attname_file_vid()

integer function spio_inq_att::pio_inq_attname_file_vid ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
integer, intent(in)  attid,
character(len=*), intent(out)  attname 
)

Inquire/get the name of an attribute 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 associated with the attribute. Use PIO_GLOBAL for global attributes
[in]attidThe id of the attribute
[out]attnameThe name of the attribute
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)