spio_inq_file Module Reference

Functions/Subroutines
integer function	pio_inq_nvars_file (file, nvars)
	Inquire/get the number of variables in a file. More...
integer function	pio_inq_nvars_fh (fh, nvars)
	Inquire/get the number of variables in a file. More...
integer function	pio_inq_ndims_file (file, ndims)
	Inquire/get the number of dimensions in a file. More...
integer function	pio_inq_ndims_fh (fh, ndims)
	Inquire/get the number of dimensions in a file. More...
integer function	pio_inq_natts_file (file, natts)
	Inquire/get the number of attributes in a file. More...
integer function	pio_inq_natts_fh (fh, natts)
	Inquire/get the number of attributes in a file. More...
integer function	pio_inq_unlimdim_file (file, unlimdim)
	Get the id of the unlimited dimension in a file. More...
integer function	pio_inq_unlimdim_fh (fh, unlimdim)
	Get the id of the unlimited dimension in a file. More...
integer function	pio_inquire_file (file, nDimensions, nVariables, nAttributes, unlimitedDimID)
	Get the number of variables/dimensions/attributes in a file. More...
integer function	pio_inquire_fh (fh, nDimensions, nVariables, nAttributes, unlimitedDimID)
	Get the number of variables/dimensions/attributes in a file. More...

Function/Subroutine Documentation

pio_inq_natts_fh()

integer function spio_inq_file::pio_inq_natts_fh	(	integer, intent(in)	fh,
		integer, intent(out)	natts
	)

Inquire/get the number of attributes in a file.

Parameters

[in]	fh	The file id/handle
[out]	natts	The number of attributes in the file

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

integer function spio_inq_file::pio_inq_natts_file	(	type(file_desc_t), intent(in)	file,
		integer, intent(out)	natts
	)

Inquire/get the number of attributes in a file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[out]	natts	The number of attributes in the file

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

integer function spio_inq_file::pio_inq_ndims_fh	(	integer, intent(in)	fh,
		integer, intent(out)	ndims
	)

Inquire/get the number of dimensions in a file.

Parameters

[in]	fh	The file id/handle
[out]	ndims	The number of dimensions in the file

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

integer function spio_inq_file::pio_inq_ndims_file	(	type(file_desc_t), intent(in)	file,
		integer, intent(out)	ndims
	)

Inquire/get the number of dimensions in a file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[out]	ndims	The number of dimensions in the file

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

integer function spio_inq_file::pio_inq_nvars_fh	(	integer, intent(in)	fh,
		integer, intent(out)	nvars
	)

Inquire/get the number of variables in a file.

Parameters

[in]	fh	The file id/handle
[out]	nvars	The number of variables in the file

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

integer function spio_inq_file::pio_inq_nvars_file	(	type(file_desc_t), intent(in)	file,
		integer, intent(out)	nvars
	)

Inquire/get the number of variables in a file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[out]	nvars	The number of variables in the file

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

integer function spio_inq_file::pio_inquire_fh	(	integer, intent(in)	fh,
		integer, intent(out), optional	nDimensions,
		integer, intent(out), optional	nVariables,
		integer, intent(out), optional	nAttributes,
		integer, intent(out), optional	unlimitedDimID
	)

Get the number of variables/dimensions/attributes in a file.

Parameters

[in]	fh	The file id/handle
[out]	nDimensions	(Optional) The number of dimensions in the file
[out]	nVariables	(Optional) The number of variables in the file
[out]	nAttributes	(Optional) The number of attributes in the file
[out]	unlimitedDimID	(Optional) The id of the unlimited dimension

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

integer function spio_inq_file::pio_inquire_file	(	type(file_desc_t), intent(in)	file,
		integer, intent(out), optional	nDimensions,
		integer, intent(out), optional	nVariables,
		integer, intent(out), optional	nAttributes,
		integer, intent(out), optional	unlimitedDimID
	)

Get the number of variables/dimensions/attributes in a file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[out]	nDimensions	(Optional) The number of dimensions in the file
[out]	nVariables	(Optional) The number of variables in the file
[out]	nAttributes	(Optional) The number of attributes in the file
[out]	unlimitedDimID	(Optional) The id of the unlimited dimension

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)