PIO_inq_unlimdim

Inquire the id of a unlimited dimension. More...

Functions/Subroutines
integer function	pio_inq_unlimdim_file (file, unlimdim)
	Get the id of the unlimited dimension in a file.
integer function	pio_inq_unlimdim_fh (fh, unlimdim)
	Get the id of the unlimited dimension in a file.

Detailed Description

Inquire the id of a unlimited dimension.

This API can be used to inquire the unique id associated with the unlimited 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_unlimdim_fh()

integer function __spio_inq_file_f90__::pio_inq_unlimdim_fh	(	integer, intent(in)	fh,
		integer, intent(out)	unlimdim
	)

Get the id of the unlimited dimension in a file.

Parameters

[in]	fh	The file id/handle
[out]	unlimdim	The id of the unlimited dimension is returned in this argument If there is no unlimited dimension in the file a -1 is returned in this argument.

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

integer function __spio_inq_file_f90__::pio_inq_unlimdim_file	(	type(file_desc_t), intent(in)	file,
		integer, intent(out)	unlimdim
	)

Get the id of the unlimited dimension in a file.

Parameters

[in]

file

The file handle. File descriptor structure.

This structure holds information associated with each open file

Parameters

[out]

unlimdim

The id of the unlimited dimension is returned in this argument If there is no unlimited dimension in the file a -1 is returned in this argument.

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)