PIO_inq_dimlen

Inquire the length/size of a dimension. More...

Functions/Subroutines
integer function	spio_inq_dim::pio_inq_dimlen_file_dimid_offlen (file, dimid, dimlen)
	Inquire/get the length of a dimension in a file. More...
integer function	spio_inq_dim::pio_inq_dimlen_file_dimid (file, dimid, dimlen)
	Inquire/get the length of a dimension in a file. More...
integer function	spio_inq_dim::pio_inq_dimlen_fh_dimid (fh, dimid, dimlen)
	Inquire/get the length of a dimension in a file. More...
integer function	spio_inq_dim::pio_inq_dimlen_fh_dimid_offlen (fh, dimid, dimlen)
	Inquire/get the length of a dimension in a file. More...

Detailed Description

Inquire the length/size of a dimension.

This API can be used to inquire the length of a dimension

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

integer function spio_inq_dim::pio_inq_dimlen_fh_dimid	(	integer, intent(in)	fh,
		integer, intent(in)	dimid,
		integer, intent(out)	dimlen
	)

Inquire/get the length of a dimension in a file.

Parameters

[in]	fh	The file id/handle
[in]	dimid	The id of the dimension
[out]	dimlen	The length of the 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_inq_dimlen_fh_dimid_offlen()

integer function spio_inq_dim::pio_inq_dimlen_fh_dimid_offlen	(	integer, intent(in)	fh,
		integer, intent(in)	dimid,
		integer(pio_offset_kind), intent(out)	dimlen
	)

Inquire/get the length of a dimension in a file.

Parameters

[in]	fh	The file id/handle
[in]	dimid	The id of the dimension
[out]	dimlen	The length (of KIND=PIO_OFFSET_KIND) of the 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_inq_dimlen_file_dimid()

integer function spio_inq_dim::pio_inq_dimlen_file_dimid	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	dimid,
		integer, intent(out)	dimlen
	)

Inquire/get the length of a dimension in a file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	dimid	The id of the dimension
[out]	dimlen	The length of the 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_inq_dimlen_file_dimid_offlen()

integer function spio_inq_dim::pio_inq_dimlen_file_dimid_offlen	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	dimid,
		integer(pio_offset_kind), intent(out)	dimlen
	)

Inquire/get the length of a dimension in a file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	dimid	The id of the dimension
[out]	dimlen	The length (of KIND=PIO_OFFSET_KIND) of the 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)