PIO_inquire_variable

Inquire meta-data associated with a variable. More...

Functions/Subroutines
integer function	pio_inquire_variable_file_vid (file, varid, name, xtype, ndims, dimids, natts)
	Get the meta-data associated with a variable.
integer function	pio_inquire_variable_fh_vid (fh, varid, name, xtype, ndims, dimids, natts)
	Get the meta-data associated with a variable.
integer function	pio_inquire_variable_file_vdesc (file, vdesc, name, xtype, ndims, dimids, natts)
	Get the meta-data associated with a variable.

Detailed Description

Inquire meta-data associated with a variable.

This API can be used to inquire the meta-data associated with a variable in a file. The user can query the name, type, number of dimensions & attributes and the dimension ids of a 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_inquire_variable_fh_vid()

integer function __spio_inq_var_f90__::pio_inquire_variable_fh_vid	(	integer, intent(in)	fh,
		integer, intent(in)	varid,
		character(len=*), intent(out), optional	name,
		integer, intent(out), optional	xtype,
		integer, intent(out), optional	ndims,
		integer, dimension(:), intent(out), optional	dimids,
		integer, intent(out), optional	natts
	)

Get the meta-data associated with a variable.

Parameters

[in]	fh	The file id/handle
[in]	varid	The id of the variable
[out]	name	(Optional) The name of the variable
[out]	xtype	(Optional) The type of the variable
[out]	ndims	(Optional) The number of dimensions in the variable
[out]	dimids	(Optional) The dimension ids of the dimensions of the variable
[out]	natts	(Optional) The number of attributes 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_inquire_variable_file_vdesc()

integer function __spio_inq_var_f90__::pio_inquire_variable_file_vdesc	(	type(file_desc_t), intent(in)	file,
		type(var_desc_t), intent(in)	vdesc,
		character(len=*), intent(out), optional	name,
		integer, intent(out), optional	xtype,
		integer, intent(out), optional	ndims,
		integer, dimension(:), intent(out), optional	dimids,
		integer, intent(out), optional	natts
	)

Get the meta-data associated with a variable.

Parameters

[in]

file

The file handle. File descriptor structure.

This structure holds information associated with each open file

Parameters

[in]	vdesc	The descriptor of the variable. Variable description structure.
[out]	name	(Optional) The name of the variable
[out]	xtype	(Optional) The type of the variable
[out]	ndims	(Optional) The number of dimensions in the variable
[out]	dimids	(Optional) The dimension ids of the dimensions of the variable
[out]	natts	(Optional) The number of attributes 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_inquire_variable_file_vid()

integer function __spio_inq_var_f90__::pio_inquire_variable_file_vid	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	varid,
		character(len=*), intent(out), optional	name,
		integer, intent(out), optional	xtype,
		integer, intent(out), optional	ndims,
		integer, dimension(:), intent(out), optional	dimids,
		integer, intent(out), optional	natts
	)

Get the meta-data associated with a variable.

Parameters

[in]

file

The file handle. File descriptor structure.

This structure holds information associated with each open file

Parameters

[in]	varid	The id of the variable
[out]	name	(Optional) The name of the variable
[out]	xtype	(Optional) The type of the variable
[out]	ndims	(Optional) The number of dimensions in the variable
[out]	dimids	(Optional) The dimension ids of the dimensions of the variable
[out]	natts	(Optional) The number of attributes 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)