PIO_inq_attlen

Inquire the length/size of an attribute. More...

Functions/Subroutines
integer function	spio_inq_att::pio_inq_attlen_file_varid_attid_offlen (file, varid, attid, attlen)
	Inquire/get the length of an attribute in a file. More...
integer function	spio_inq_att::pio_inq_attlen_file_varid_attname_offlen (file, varid, attname, attlen)
	Inquire/get the length of an attribute in a file. More...
integer function	spio_inq_att::pio_inq_attlen_fh_varid_attid_offlen (fh, varid, attid, attlen)
	Inquire/get the length of an attribute in a file. More...
integer function	spio_inq_att::pio_inq_attlen_fh_varid_attname_offlen (fh, varid, attname, attlen)
	Inquire/get the length of an attribute in a file. More...
integer function	spio_inq_att::pio_inq_attlen_file_vdesc_attid_offlen (file, vdesc, attid, attlen)
	Inquire/get the length of an attribute in a file. More...
integer function	spio_inq_att::pio_inq_attlen_file_vdesc_attname_offlen (file, vdesc, attname, attlen)
	Inquire/get the length of an attribute in a file. More...

Detailed Description

Inquire the length/size of an attribute.

This API can be used to inquire the length 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_attlen_fh_varid_attid_offlen()

integer function spio_inq_att::pio_inq_attlen_fh_varid_attid_offlen	(	integer, intent(in)	fh,
		integer, intent(in)	varid,
		integer, intent(in)	attid,
		integer(pio_offset_kind), intent(out)	attlen
	)

Inquire/get the length of an attribute in a file.

Parameters

[in]	fh	The file id/handle
[in]	varid	The id of the variable associated with the attribute. Use PIO_GLOBAL for global attributes (attributes not associated with any variable)
[in]	attid	The id of the attribute
[out]	attlen	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_attlen_fh_varid_attname_offlen()

integer function spio_inq_att::pio_inq_attlen_fh_varid_attname_offlen	(	integer, intent(in)	fh,
		integer, intent(in)	varid,
		character(len=*), intent(in)	attname,
		integer(pio_offset_kind), intent(out)	attlen
	)

Inquire/get the length of an attribute in a file.

Parameters

[in]	fh	The file handle/id
[in]	varid	The id of the variable associated with the attribute. Use PIO_GLOBAL for global attributes (attributes not associated with any variable)
[in]	attname	The name of the attribute
[out]	attlen	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_attlen_file_varid_attid_offlen()

integer function spio_inq_att::pio_inq_attlen_file_varid_attid_offlen	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	varid,
		integer, intent(in)	attid,
		integer(pio_offset_kind), intent(out)	attlen
	)

Inquire/get the length of an attribute in a file.

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 associated with the attribute. Use PIO_GLOBAL for global attributes (attributes not associated with any variable)
[in]	attid	The id of the attribute
[out]	attlen	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_attlen_file_varid_attname_offlen()

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

Inquire/get the length of an attribute in a file.

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 associated with the attribute. Use PIO_GLOBAL for global attributes (attributes not associated with any variable)
[in]	attname	The name of the attribute
[out]	attlen	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_attlen_file_vdesc_attid_offlen()

integer function spio_inq_att::pio_inq_attlen_file_vdesc_attid_offlen	(	type(file_desc_t), intent(in)	file,
		type(var_desc_t), intent(in)	vdesc,
		integer, intent(in)	attid,
		integer(pio_offset_kind), intent(out)	attlen
	)

Inquire/get the length of an attribute in a file.

Parameters

[in]	file	The file id/handle. File descriptor structure. This structure holds information associated with each open file
[in]	vdesc	The handle to the variable. Variable description structure.
[in]	attid	The id of the attribute
[out]	attlen	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_attlen_file_vdesc_attname_offlen()

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

Inquire/get the length of an attribute in a file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	vdesc	The handle to the variable. Variable description structure.
[in]	attname	The name of the attribute
[out]	attlen	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)