PIO_inq_att

Inquire meta-data associated with an attribute. More...

Functions/Subroutines
integer function	spio_inq_att::pio_inq_att_file_vid_offlen (file, varid, attname, xtype, len)
	Get the meta-data associated with a attribute. More...
integer function	spio_inq_att::pio_inq_att_fh_vid_offlen (fh, varid, attname, xtype, len)
	Get the meta-data associated with an attribute. More...
integer function	spio_inq_att::pio_inq_att_file_vdesc_offlen (file, vdesc, attname, xtype, len)
	Get the meta-data associated with a attribute. More...

Detailed Description

Inquire meta-data associated with an attribute.

This API can be used to inquire the meta-data associated with an attribute in a file. The user can query the name, type, number of dimensions & attributes and the dimension ids of an attribute.

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

integer function spio_inq_att::pio_inq_att_fh_vid_offlen	(	integer, intent(in)	fh,
		integer, intent(in)	varid,
		character(len=*), intent(in)	attname,
		integer, intent(out), optional	xtype,
		integer(pio_offset_kind), intent(out), optional	len
	)

Get the meta-data associated with an attribute.

Parameters

[in]	fh	The file id/handle
[in]	varid	The id of the variable associated with the attribute. Use PIO_GLOBAL as the variable id for global attributes
[in]	attname	The name of the attribute
[out]	xtype	(Optional) The type of the attribute
[out]	len	(Optional) The length (KIND=PIO_OFFSET_KIND) 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_att_file_vdesc_offlen()

integer function spio_inq_att::pio_inq_att_file_vdesc_offlen	(	type(file_desc_t), intent(in)	file,
		type(var_desc_t), intent(in)	vdesc,
		character(len=*), intent(in)	attname,
		integer, intent(out), optional	xtype,
		integer(pio_offset_kind), intent(out), optional	len
	)

Get the meta-data associated with a attribute.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	vdesc	The descriptor of the attribute. Variable description structure.
[in]	attname	The name of the attribute
[out]	xtype	(Optional) The type of the attribute
[out]	len	(Optional) The length (KIND=PIO_OFFSET_KIND) 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_att_file_vid_offlen()

integer function spio_inq_att::pio_inq_att_file_vid_offlen	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	varid,
		character(len=*), intent(in)	attname,
		integer, intent(out), optional	xtype,
		integer(pio_offset_kind), intent(out), optional	len
	)

Get the meta-data associated with a attribute.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	varid	The id of the variable with the attribute. Use PIO_GLOBAL as the variable id for global attributes
[in]	attname	The name of the attribute
[out]	xtype	(Optional) The type of the attribute
[out]	len	(Optional) The length (KIND=PIO_OFFSET_KIND) 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)