PIO_inq_varid

Inquire variable id. More...

Functions/Subroutines
integer function	pio_inq_varid_file_vid (file, vname, varid)
	Inquire/get the unique id associated with a variable in a file.
integer function	pio_inq_varid_fh_vid (fh, vname, varid)
	Inquire/get the unique id associated with a variable in a file.
integer function	pio_inq_varid_file_vdesc (file, vname, vdesc)
	Inquire/get the unique id associated with a variable in a file.

Detailed Description

Inquire variable id.

This API can be used to inquire the unique id associated with a variable in a file.

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

integer function __spio_inq_var_f90__::pio_inq_varid_fh_vid	(	integer, intent(in)	fh,
		character(len=*), intent(in)	vname,
		integer, intent(out)	varid
	)

Inquire/get the unique id associated with a variable in a file.

Parameters

[in]	fh	The file id/handle
[in]	vname	The name of the variable
[out]	varid	The id 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_inq_varid_file_vdesc()

integer function __spio_inq_var_f90__::pio_inq_varid_file_vdesc	(	type(file_desc_t), intent(in)	file,
		character(len=*), intent(in)	vname,
		type(var_desc_t), intent(out)	vdesc
	)

Inquire/get the unique id associated with a variable in a file.

Parameters

[in]

file

The file handle. File descriptor structure.

This structure holds information associated with each open file

Parameters

[in]	vname	The name of the variable
[out]	vdesc	The descriptor of the variable. Variable description structure.

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

integer function __spio_inq_var_f90__::pio_inq_varid_file_vid	(	type(file_desc_t), intent(in)	file,
		character(len=*), intent(in)	vname,
		integer, intent(out)	varid
	)

Inquire/get the unique id associated with a variable in a file.

Parameters

[in]

file

The file handle. File descriptor structure.

This structure holds information associated with each open file

Parameters

[in]	vname	The name of the variable
[out]	varid	The id 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)